1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!--
@license Apache-2.0
Copyright (c) 2021 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.
-->
# rtrimN
> Trim `n` characters from the end of a string.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
</section>
<!-- /.intro -->
<!-- Package usage documentation. -->
<section class="usage">
## Usage
```javascript
var rtrimN = require( '@stdlib/string/right-trim-n' );
```
#### rtrimN( str, n\[, chars] )
Trims `n` characters from the end of a string.
```javascript
var str = ' foo ';
var out = rtrimN( str, str.length );
// returns ' foo'
out = rtrimN( str, 1 );
// returns ' foo '
```
By default, the function trims whitespace characters. To trim a different set of characters instead, provide a string or an array of characters to trim:
```javascript
var str = '🐶🐶🐶 Animals 🐶🐶🐶';
var out = rtrimN( str, str.length, [ '🐶', ' ' ] );
// returns '🐶🐶🐶 Animals'
out = rtrimN( str, str.length, '🐶 ' );
// returns '🐶🐶🐶 Animals'
```
</section>
<!-- /.usage -->
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- Package usage examples. -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var rtrimN = require( '@stdlib/string/right-trim-n' );
var out = rtrimN( ' Whitespace ', 3 );
// returns ' Whitespace'
out = rtrimN( '\t\t\tTabs\t\t\t', 2 );
// returns '\t\t\tTabs\t'
out = rtrimN( '~~~CUSTOM~~~', 3, '~' );
// returns '~~~CUSTOM'
```
</section>
<!-- /.examples -->
<!-- Section for describing a command-line interface. -->
* * *
<section class="cli">
## CLI
<!-- CLI usage documentation. -->
<section class="usage">
### Usage
```text
Usage: rtrimn [options] --n=<number>
Options:
-h, --help Print this message.
-V, --version Print the package version.
--n number Number of characters to trim.
--chars str Characters to trim. Default: whitespace.
--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 $' foo \n bar ' | rtrimn --n=3 --split /\r?\n/
# Escaped...
$ echo -n $' foo \n bar ' | rtrimn --n=3 --split /\\r?\\n/
```
- The implementation ignores trailing delimiters.
</section>
<!-- /.notes -->
<!-- CLI usage examples. -->
<section class="examples">
### Examples
```bash
$ rtrimn ' Whitespace ' --n=3
Whitespace
```
To use as a [standard stream][standard-streams],
```bash
$ echo -n '~beep~boop~~~' | rtrimn --n=2 --chars '~'
~beep~boop~
```
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 '~~~foo~~~\t~~~bar~~~\t~~~baz~~~' | rtrimn --split '\t' --chars '~' --n=3
~~~foo
~~~bar
~~~baz
```
</section>
<!-- /.examples -->
</section>
<!-- /.cli -->
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="references">
</section>
<!-- /.references -->
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
<section class="related">
</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">
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
</section>
<!-- /.links -->
|
