From 7e5368b74f39591e9ea54509e34531f8e31d41f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 18 Jan 2024 08:15:12 +0000 Subject: [PATCH] Auto-generated commit --- first/README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/first/README.md b/first/README.md index 4db9468a..c9ea5b06 100644 --- a/first/README.md +++ b/first/README.md @@ -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. @@ -78,7 +78,6 @@ out = first( 'foo bar', 10 ); -
## Examples @@ -199,6 +198,12 @@ b @@ -211,6 +216,12 @@ b [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions + + +[@stdlib/string/remove-first]: https://github.com/stdlib-js/string/tree/main/remove-first + + +