Add to namespace and update definition file

Planeshifter · Planeshifter · commit 7c99cbd59080 · 2021-10-09T12:46:25.000-04:00
diff --git a/lib/node_modules/@stdlib/string/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/docs/types/index.d.ts
@@ -37,6 +37,7 @@ import numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' );
 import pad = require( '@stdlib/string/pad' );
 import pascalcase = require( '@stdlib/string/pascalcase' );
 import percentEncode = require( '@stdlib/string/percent-encode' );
+import prevGraphemeClusterBreak = require( '@stdlib/string/prev-grapheme-cluster-break' );
 import removeFirst = require( '@stdlib/string/remove-first' );
 import removeLast = require( '@stdlib/string/remove-last' );
 import removePunctuation = require( '@stdlib/string/remove-punctuation' );
@@ -428,6 +429,24 @@ interface Namespace {
 	*/
 	percentEncode: typeof percentEncode;
 
+	/**
+	* Returns the previous extended grapheme cluster break in a string before a specified position.
+	*
+	* @param str - input string
+	* @param fromIndex - position (default: str.length-1)
+	* @throws first argument must be a string
+	* @throws second argument must be an integer
+	* @returns previous grapheme break position
+	*
+	* @example
+	* var out = ns.prevGraphemeClusterBreak( 'अनुच्छेद', 2 );
+	* // returns 0
+	*
+	* out = ns.prevGraphemeClusterBreak( '🌷', 1 );
+	* // returns -1
+	*/
+	prevGraphemeClusterBreak: typeof prevGraphemeClusterBreak;
+
 	/**
 	* Removes the first character of a string.
 	*
@@ -739,6 +758,7 @@ interface Namespace {
 	*
 	* @param str - input string
 	* @param search - search string
+	* @param fromIndex - index at which to start the search (default: 0)
 	* @returns substring
 	*
 	* @example
@@ -756,6 +776,14 @@ interface Namespace {
 	* @example
 	* var out = ns.substringAfter( 'beep boop', 'xyz' );
 	* // returns ''
+	*
+	* @example
+	* var out = ns.substringAfter( 'beep boop', 'beep', 5 );
+	* // returns ''
+	*
+	* @example
+	* var out = ns.substringAfter( 'beep boop beep baz', 'beep', 5 );
+	* // returns ' baz'
 	*/
 	substringAfter: typeof substringAfter;
 
@@ -764,6 +792,7 @@ interface Namespace {
 	*
 	* @param str - input string
 	* @param search - search value
+	* @param fromIndex - index of last character to be considered beginning of a match (default: `str.length`)
 	* @returns substring
 	*
 	* @example
@@ -785,6 +814,10 @@ interface Namespace {
 	* @example
 	* var out = ns.substringAfterLast( 'Hello World', '' );
 	* // returns ''
+	*
+	* @example
+	* var out = ns.substringAfterLast( 'beep boop baz', 'p b', 6 );
+	* // returns 'oop baz'
 	*/
 	substringAfterLast: typeof substringAfterLast;
 
diff --git a/lib/node_modules/@stdlib/string/lib/index.js b/lib/node_modules/@stdlib/string/lib/index.js
@@ -22,6 +22,10 @@
 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
 */
 
+/*
+* The following modules are intentionally not exported: tools
+*/
+
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
@@ -180,6 +184,15 @@ setReadOnly( string, 'pascalcase', require( '@stdlib/string/pascalcase' ) );
 */
 setReadOnly( string, 'percentEncode', require( '@stdlib/string/percent-encode' ) );
 
+/**
+* @name prevGraphemeClusterBreak
+* @memberof string
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/string/prev-grapheme-cluster-break}
+*/
+setReadOnly( string, 'prevGraphemeClusterBreak', require( '@stdlib/string/prev-grapheme-cluster-break' ) );
+
 /**
 * @name removeFirst
 * @memberof string
