nushell/docs/commands/str_substring.md
Justin Ma c0a1d18e3d
update #4455, regenerate commands' docs and update make_docs script (#4586)
* feat: update #4455, regenerate commands' docs

* chore: update make_docs script
2022-02-21 11:26:00 -06:00

44 lines
756 B
Markdown

---
title: str substring
layout: command
version: 0.59.0
---
substrings text
## Signature
```> str substring (range) ...rest```
## Parameters
- `range`: the indexes to substring [start end]
- `...rest`: optionally substring text by column paths
## Examples
Get a substring from the text
```shell
> 'good nushell' | str substring [5 12]
```
Alternatively, you can use the form
```shell
> 'good nushell' | str substring '5,12'
```
Drop the last `n` characters from the string
```shell
> 'good nushell' | str substring ',-5'
```
Get the remaining characters from a starting index
```shell
> 'good nushell' | str substring '5,'
```
Get the characters from the beginning until ending index
```shell
> 'good nushell' | str substring ',7'
```