Skip to content

Commit 9a1f27c

Browse files
committed
Update copy
1 parent 39a24f8 commit 9a1f27c

File tree

1 file changed

+12
-12
lines changed
  • lib/node_modules/@stdlib/string/next-grapheme-cluster-break

1 file changed

+12
-12
lines changed

lib/node_modules/@stdlib/string/next-grapheme-cluster-break/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ var out = nextGraphemeClusterBreak( 'last man standing' );
4949
// returns 1
5050
```
5151

52-
By default, the first extended grapheme cluster break in the string is returned. For the next extended grapheme cluster break after a specified position in the string, provide a `fromIndex`.
52+
By default, the function searches for a grapheme cluster break starting from the first index. To specify an alternative starting search index, provide a `fromIndex` argument.
5353

5454
```javascript
5555
var out = nextGraphemeClusterBreak( 'last man standing', 4 );
@@ -85,17 +85,17 @@ var out = nextGraphemeClusterBreak( 'last man standing', 4 );
8585
```javascript
8686
var nextGraphemeClusterBreak = require( '@stdlib/string/next-grapheme-cluster-break' );
8787

88-
console.log( nextGraphemeClusterBreak( 'last man standing', 4 ) );
89-
// => 5
88+
var out = nextGraphemeClusterBreak( 'last man standing', 4 );
89+
// returns 5
9090

91-
console.log( nextGraphemeClusterBreak( 'presidential election', 8 ) );
92-
// => 9
91+
out = nextGraphemeClusterBreak( 'presidential election', 8 );
92+
// returns 9
9393

94-
console.log( nextGraphemeClusterBreak( 'अनुच्छेद', 1 ) );
95-
// => 3
94+
out = nextGraphemeClusterBreak( 'अनुच्छेद', 1 );
95+
// returns 3
9696

97-
console.log( nextGraphemeClusterBreak( '🌷', 0 ) );
98-
// => -1
97+
out = nextGraphemeClusterBreak( '🌷', 0 );
98+
// returns -1
9999
```
100100

101101
</section>
@@ -123,7 +123,7 @@ Options:
123123
124124
-h, --help Print this message.
125125
-V, --version Print the package version.
126-
--fromIndex index Position in string. Default: 0.
126+
--from index Starting search position in string. Default: 0.
127127
```
128128

129129
</section>
@@ -145,14 +145,14 @@ Options:
145145
### Examples
146146

147147
```bash
148-
$ next-grapheme-cluster-break --fromIndex=1 अनुच्छेद
148+
$ next-grapheme-cluster-break --from=1 अनुच्छेद
149149
3
150150
```
151151

152152
To use as a [standard stream][standard-streams],
153153

154154
```bash
155-
$ echo -n 'अनुच्छेद' | next-grapheme-cluster-break --fromIndex=1
155+
$ echo -n 'अनुच्छेद' | next-grapheme-cluster-break --from=1
156156
3
157157
```
158158

0 commit comments

Comments
 (0)