@stdlib/string-base-format-tokenize NPM

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: ', {...} ]

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.