@stdlib/string-base-format-tokenize
Tokenize a string into an array of string parts and format identifier objects.
Last updated 2 years ago by kgryte .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ npm install @stdlib/string-base-format-tokenize 
SYNC missed versions from official npm registry.
<summary> About stdlib... </summary>

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

NPM version Build Status Coverage Status

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Current Tags

  • 0.2.2                                ...           latest (4 months ago)

9 Versions

  • 0.2.2                                ...           4 months ago
  • 0.2.1                                ...           9 months ago
  • 0.2.0                                ...           9 months ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           a year ago
  • 0.0.4                                ...           2 years ago
  • 0.0.3                                ...           2 years ago
  • 0.0.2                                ...           2 years ago
  • 0.0.1                                ...           3 years ago
Downloads
Total 5
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
None
Dev Dependencies (5)
Dependents (1)

© 2010 - cnpmjs.org x YWFE | Home | YWFE