Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Jan 18, 2024
1 parent 5990ca5 commit 7e5368b
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions first/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The function supports the following options:
- `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
- `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
- `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).

Default: `'grapheme'`.

By default, the function returns the first character. To return the first `n` characters, provide a second argument specifying the number of characters to return.
Expand Down Expand Up @@ -78,7 +78,6 @@ out = first( 'foo bar', 10 );

<!-- /.notes -->


<section class="examples">

## Examples
Expand Down Expand Up @@ -199,6 +198,12 @@ b

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/remove-first`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -211,6 +216,12 @@ b

[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions

<!-- <related-links> -->

[@stdlib/string/remove-first]: https://github.com/stdlib-js/string/tree/main/remove-first

<!-- </related-links> -->

</section>

<!-- /.links -->

0 comments on commit 7e5368b

Please sign in to comment.