nushell/docs/commands/str-index-of.md
JT bff81f24aa
Autogenerate missing docs (#3514)
* Autogenerate missing docs

* Update ansi.md

* Rename question mark command docs

* Delete empty?.md
2021-05-30 12:57:04 +12:00

1.1 KiB

str index-of

Returns starting index of given pattern in string counting from 0. Returns -1 when there are no results.

Usage

> str index-of <pattern> ...args {flags} 

Parameters

  • <pattern> the pattern to find index of
  • ...args: optionally returns index of pattern in string by column paths

Flags

  • -h, --help: Display this help message
  • -r, --range : optional start and/or end index
  • -e, --end: search from the end of the string

Examples

Returns index of pattern in string

> echo 'my_library.rb' | str index-of '.rb'

Returns index of pattern in string with start index

> echo '.rb.rb' | str index-of '.rb' -r '1,'

Returns index of pattern in string with end index

> echo '123456' | str index-of '6' -r ',4'

Returns index of pattern in string with start and end index

> echo '123456' | str index-of '3' -r '1,4'

Alternatively you can use this form

> echo '123456' | str index-of '3' -r [1 4]

Returns index of pattern in string

> echo '/this/is/some/path/file.txt' | str index-of '/' -e