Package Exports
- @stdlib/string-format
- @stdlib/string-format/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/string-format) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
format
Insert supplied variable values into a format string.
Installation
npm install @stdlib/string-format
Usage
var format = require( '@stdlib/string-format' );
format( str, ...args )
Inserts supplied variable values into a format string.
var str = 'Hello, %s! My name is %s.';
var out = format( str, 'world', 'Bob' );
// returns 'Hello, world! My name is Bob.'
The format string is a string literal containing zero or more conversion specifications, each of which results in a string value being inserted to the output string. A conversion specification consists of a percent sign (%
) followed by one or more of the following flags, width, precision, and conversion type characters:
type | description | notes |
---|---|---|
s | string | |
c | character | |
d | signed decimal integer | |
i | signed decimal integer | |
u | unsigned decimal integer | |
b | unsigned binary integer | |
o | unsigned octal integer | |
x | unsigned hexadecimal | |
X | unsigned hexadecimal | |
f | floating point | |
e | floating point | |
E | floating point | |
g | floating point | |
G | floating point |
Examples
var format = require( '@stdlib/string-format' );
var out = format( '%s %s!', 'Hello', 'World' );
// returns 'Hello World!'
out = format( 'Pi: ~%.2f', 3.141592653589793 );
// returns 'Pi: ~3.14'
out = format( '%-10s %-10s', 'a', 'b' );
// returns 'a b '
out = format( '%10s %10s', 'a', 'b' );
// returns ' a b'
out = format( '%2$s %1$s %3$s', 'b', 'a', 'c' );
// returns 'a b c'
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-2022. The Stdlib Authors.