@stdlib/string-base-format-tokenize

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!

formatTokenize

Tokenize a string into an array of string parts and format identifier objects.

Installation

npm install @stdlib/string-base-format-tokenize

Usage

var formatTokenize = require( '@stdlib/string-base-format-tokenize' );

formatTokenize( str )

Tokenizes a string into an array of string parts and format identifier objects.

var str = 'Hello, %s! My name is %s.';
var out = formatTokenize( str );
// returns [ 'Hello, ', {...}, '! My name is ', {...}, '.' ]

The format identifier objects have the following properties:

property	description
specifier	format specifier (single alphabetical character, lower- or uppercase)
flags	format flags (string with any of '0', ' ', '+', '-', '#')
width	minimum field width (integer or '*')
precision	precision (integer or '*')
mapping	positional mapping from format specifier to argument index

Examples

var formatTokenize = require( '@stdlib/string-base-format-tokenize' );

var out = formatTokenize( 'Hello %s!' );
// returns [ 'Hello ', {...}, '!' ]

out = formatTokenize( 'Pi: ~%.2f' );
// returns [ 'Pi: ~', {...} ]

out = formatTokenize( 'Multiple flags: %#+s' );
// returns [ 'Multiple flags: ', {...} ]

See Also

• @stdlib/string-base/format-interpolate: generate string from a token array by interpolating values.

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

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.