194 lines
6.0 KiB
Markdown
194 lines
6.0 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2022 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# formatInterpolate
|
|
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
|
|
> Generate string from a token array by interpolating values.
|
|
|
|
<section class="intro">
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<section class="installation">
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @stdlib/string-base-format-interpolate
|
|
```
|
|
|
|
</section>
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var formatInterpolate = require( '@stdlib/string-base-format-interpolate' );
|
|
```
|
|
|
|
#### formatInterpolate( tokens, ...args )
|
|
|
|
Generates string from a token array by interpolating values.
|
|
|
|
```javascript
|
|
var formatTokenize = require( '@stdlib/string-base-format-tokenize' );
|
|
|
|
var str = 'Hello, %s! My name is %s.';
|
|
var tokens = formatTokenize( str );
|
|
var out = formatInterpolate( tokens, 'World', 'Bob' );
|
|
// returns 'Hello, World! My name is Bob.'
|
|
```
|
|
|
|
The array of `tokens` should contain string parts and format identifier objects.
|
|
|
|
```javascript
|
|
var tokens = [ 'beep ', { 'specifier': 's' } ];
|
|
var out = formatInterpolate( tokens, 'boop' );
|
|
// returns 'beep boop'
|
|
```
|
|
|
|
Format identifier objects can 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 |
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var formatTokenize = require( '@stdlib/string-base-format-tokenize' );
|
|
var PI = require( '@stdlib/constants-float64-pi' );
|
|
var formatInterpolate = require( '@stdlib/string-base-format-interpolate' );
|
|
|
|
var tokens = formatTokenize( 'Hello %s!' );
|
|
var out = formatInterpolate( tokens, 'World' );
|
|
// returns 'Hello World!'
|
|
|
|
tokens = formatTokenize( 'Pi: ~%.2f' );
|
|
out = formatInterpolate( tokens, PI );
|
|
// returns 'Pi: ~3.14'
|
|
|
|
tokens = formatTokenize( 'Index: %d, Value: %s' );
|
|
out = formatInterpolate( tokens, 0, 'foo' );
|
|
// returns 'Index: 0, Value: foo'
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
|
|
<section class="main-repo" >
|
|
|
|
* * *
|
|
|
|
## 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].
|
|
|
|
</section>
|
|
|
|
<!-- /.stdlib -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/string-base-format-interpolate.svg
|
|
[npm-url]: https://npmjs.org/package/@stdlib/string-base-format-interpolate
|
|
|
|
[test-image]: https://github.com/stdlib-js/string-base-format-interpolate/actions/workflows/test.yml/badge.svg?branch=v0.0.4
|
|
[test-url]: https://github.com/stdlib-js/string-base-format-interpolate/actions/workflows/test.yml?query=branch:v0.0.4
|
|
|
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-base-format-interpolate/main.svg
|
|
[coverage-url]: https://codecov.io/github/stdlib-js/string-base-format-interpolate?branch=main
|
|
|
|
<!--
|
|
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/string-base-format-interpolate.svg
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/string-base-format-interpolate/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-interpolate/tree/deno
|
|
[umd-url]: https://github.com/stdlib-js/string-base-format-interpolate/tree/umd
|
|
[esm-url]: https://github.com/stdlib-js/string-base-format-interpolate/tree/esm
|
|
[branches-url]: https://github.com/stdlib-js/string-base-format-interpolate/blob/main/branches.md
|
|
|
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-base-format-interpolate/main/LICENSE
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|