205 lines
4.3 KiB
Markdown
205 lines
4.3 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# removeFirst
|
|
|
|
> Remove the first character(s) of a string.
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var removeFirst = require( '@stdlib/string/remove-first' );
|
|
```
|
|
|
|
#### removeFirst( str\[, n] )
|
|
|
|
Removes the first character of a `string`.
|
|
|
|
```javascript
|
|
var out = removeFirst( 'last man standing' );
|
|
// returns 'ast man standing'
|
|
|
|
out = removeFirst( 'Hidden Treasures' );
|
|
// returns 'idden Treasures'
|
|
```
|
|
|
|
If provided a second argument, the function removes the first `n` characters.
|
|
|
|
```javascript
|
|
var out = removeFirst( 'foo bar', 4 );
|
|
// returns 'bar'
|
|
|
|
out = removeFirst( 'foo bar', 10 );
|
|
// returns ''
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var removeFirst = require( '@stdlib/string/remove-first' );
|
|
|
|
var str = removeFirst( 'last man standing' );
|
|
// returns 'ast man standing'
|
|
|
|
str = removeFirst( 'presidential election' );
|
|
// returns 'residential election'
|
|
|
|
str = removeFirst( 'javaScript' );
|
|
// returns 'avaScript'
|
|
|
|
str = removeFirst( 'Hidden Treasures' );
|
|
// returns 'idden Treasures'
|
|
|
|
str = removeFirst( 'The Last of the Mohicans', 4 );
|
|
// returns 'Last of the Mohicans'
|
|
|
|
str = removeFirst( '🐶🐮🐷🐰🐸', 2 );
|
|
// returns '🐷🐰🐸'
|
|
|
|
str = removeFirst( '🐶🐮🐷🐰🐸', 10 );
|
|
// returns ''
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
* * *
|
|
|
|
<section class="cli">
|
|
|
|
## CLI
|
|
|
|
<section class="usage">
|
|
|
|
### Usage
|
|
|
|
```text
|
|
Usage: remove-first [options] [<string>]
|
|
|
|
Options:
|
|
|
|
-h, --help Print this message.
|
|
-V, --version Print the package version.
|
|
--n Number of characters to remove. Default: 1.
|
|
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
### Notes
|
|
|
|
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
|
|
|
|
```bash
|
|
# Not escaped...
|
|
$ echo -n $'beep\nboop' | remove-first --split /\r?\n/
|
|
|
|
# Escaped...
|
|
$ echo -n $'beep\nboop' | remove-first --split /\\r?\\n/
|
|
```
|
|
|
|
- The implementation ignores trailing delimiters.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
### Examples
|
|
|
|
```bash
|
|
$ remove-first beep
|
|
eep
|
|
```
|
|
|
|
To use as a [standard stream][standard-streams],
|
|
|
|
```bash
|
|
$ echo -n 'beep\nboop' | remove-first --n=2
|
|
be
|
|
bo
|
|
```
|
|
|
|
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
|
|
|
|
```bash
|
|
$ echo -n 'beep\tboop' | remove-first --split '\t'
|
|
eep
|
|
oop
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
</section>
|
|
|
|
<!-- /.cli -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
* * *
|
|
|
|
## See Also
|
|
|
|
- <span class="package-name">[`@stdlib/string/remove-last`][@stdlib/string/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last character of a string.</span>
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
|
|
|
|
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
|
|
|
<!-- <related-links> -->
|
|
|
|
[@stdlib/string/remove-last]: https://github.com/stdlib-js/string/tree/main/remove-last
|
|
|
|
<!-- </related-links> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|