Skip to content

Commit 7a9fb2e

Browse files
committed
feat: update string TypeScript declarations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent e427b37 commit 7a9fb2e

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

  • lib/node_modules/@stdlib/string/docs/types

lib/node_modules/@stdlib/string/docs/types/index.d.ts

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import ltrimN = require( '@stdlib/string/left-trim-n' );
4141
import lowercase = require( '@stdlib/string/lowercase' );
4242
import nextCodePointIndex = require( '@stdlib/string/next-code-point-index' );
4343
import nextGraphemeClusterBreak = require( '@stdlib/string/next-grapheme-cluster-break' );
44+
import numCodePoints = require( '@stdlib/string/num-code-points' );
4445
import numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' );
4546
import num2words = require( '@stdlib/string/num2words' );
4647
import pad = require( '@stdlib/string/pad' );
@@ -351,7 +352,7 @@ interface Namespace {
351352
* @returns HTTP header-cased string
352353
*
353354
* @example
354-
* var str = ns.headercase( 'Hello World!' );
355+
* var str = ns.headercase( 'Hello World!' );
355356
* // returns 'Hello-World'
356357
*
357358
* @example
@@ -543,6 +544,30 @@ interface Namespace {
543544
*/
544545
nextGraphemeClusterBreak: typeof nextGraphemeClusterBreak;
545546

547+
/**
548+
* Returns the number of code points in a string.
549+
*
550+
* @param str - input string
551+
* @returns number of code points
552+
*
553+
* @example
554+
* var out = ns.numCodePoints( 'last man standing' );
555+
* // returns 17
556+
*
557+
* @example
558+
* var out = ns.numCodePoints( 'presidential election' );
559+
* // returns 21
560+
*
561+
* @example
562+
* var out = ns.numCodePoints( '六' );
563+
* // returns 1
564+
*
565+
* @example
566+
* var out = ns.numCodePoints( 'अनुच्छेद' );
567+
* // returns 8
568+
*/
569+
numCodePoints: typeof numCodePoints;
570+
546571
/**
547572
* Returns the number of grapheme clusters in a string.
548573
*

0 commit comments

Comments
 (0)