Giter VIP home page Giter VIP logo

string-next-code-point-index's Introduction

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

nextCodePointIndex

NPM version Build Status Coverage Status

Return the position of the next Unicode code point in a string after a specified position.

Installation

npm install @stdlib/string-next-code-point-index

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
  • To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var nextCodePointIndex = require( '@stdlib/string-next-code-point-index' );

nextCodePointIndex( string[, fromIndex] )

Returns the position of the next Unicode code point in a string after a specified position.

var out = nextCodePointIndex( 'last man standing' );
// returns 1

By default, the function searches for a Unicode code point starting from the first index. To specify an alternative starting search index, provide a fromIndex argument.

var out = nextCodePointIndex( 'last man standing', 4 );
// returns 5

Notes

  • If string is an empty string, the function returns -1 irrespective of fromIndex.
  • If a code point does not exist after fromIndex, the function returns -1.
  • Note that fromIndex does not refer to a visual character position, but to an index in the ordered sequence of UTF-16 code units.

Examples

var nextCodePointIndex = require( '@stdlib/string-next-code-point-index' );

var out = nextCodePointIndex( 'last man standing', 4 );
// returns 5

out = nextCodePointIndex( 'presidential election', 8 );
// returns 9

out = nextCodePointIndex( '๐’ป๐“Ÿ๐’ป๐“Ÿ', 0 );
// returns 2

out = nextCodePointIndex( '๐ŸŒท', 0 );
// returns -1

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/string-next-code-point-index-cli

Usage

Usage: next-code-point-index [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --from index          Starting search position in string. Default: 0.

Examples

$ next-code-point-index --from=0 ๐’ป๐“Ÿ๐’ป๐“Ÿ
2

To use as a standard stream,

$ echo -n '๐’ป๐“Ÿ๐’ป๐“Ÿ' | next-code-point-index --from=0
2

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright ยฉ 2016-2024. The Stdlib Authors.

string-next-code-point-index's People

Contributors

stdlib-bot avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.