# formatTokenize
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Tokenize a string into an array of string parts and format identifier objects.
## Installation
```bash
npm install @stdlib/string-base-format-tokenize
```
## Usage
```javascript
var formatTokenize = require( '@stdlib/string-base-format-tokenize' );
```
#### formatTokenize( str )
Tokenizes a string into an array of string parts and format identifier objects.
```javascript
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 (one of 's', 'c', 'd', 'i', 'u', 'b', 'o', 'x', 'X', 'e', 'E', 'f', 'F', 'g', 'G') |
| 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
```javascript
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 [ 'Foo ', {...} ]
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-base-format-tokenize.svg
[npm-url]: https://npmjs.org/package/@stdlib/string-base-format-tokenize
[test-image]: https://github.com/stdlib-js/string-base-format-tokenize/actions/workflows/test.yml/badge.svg?branch=v0.0.4
[test-url]: https://github.com/stdlib-js/string-base-format-tokenize/actions/workflows/test.yml?query=branch:v0.0.4
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-base-format-tokenize/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/string-base-format-tokenize?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/string-base-format-tokenize/tree/deno
[umd-url]: https://github.com/stdlib-js/string-base-format-tokenize/tree/umd
[esm-url]: https://github.com/stdlib-js/string-base-format-tokenize/tree/esm
[branches-url]: https://github.com/stdlib-js/string-base-format-tokenize/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-base-format-tokenize/main/LICENSE