68 lines
1.7 KiB
JavaScript
68 lines
1.7 KiB
JavaScript
|
/**
|
||
|
|
* @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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var interpolate = require( './../../base/format-interpolate' );
|
||
|
|
var tokenize = require( './../../base/format-tokenize' );
|
||
|
|
var isString = require( './is_string.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Inserts supplied variable values into a format string.
|
||
|
|
*
|
||
|
|
* @param {string} str - input string
|
||
|
|
* @param {Array} ...args - variable values
|
||
|
|
* @throws {TypeError} first argument must be a string
|
||
|
|
* @throws {Error} invalid flags
|
||
|
|
* @returns {string} formatted string
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var str = format( 'Hello %s!', 'world' );
|
||
|
|
* // returns 'Hello world!'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var str = format( 'Pi: ~%.2f', 3.141592653589793 );
|
||
|
|
* // returns 'Pi: ~3.14'
|
||
|
|
*/
|
||
|
|
function format( str ) {
|
||
|
|
var tokens;
|
||
|
|
var args;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
if ( !isString( str ) ) {
|
||
|
|
throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
|
||
|
|
}
|
||
|
|
tokens = tokenize( str );
|
||
|
|
args = new Array( arguments.length );
|
||
|
|
args[ 0 ] = tokens;
|
||
|
|
for ( i = 1; i < args.length; i++ ) {
|
||
|
|
args[ i ] = arguments[ i ];
|
||
|
|
}
|
||
|
|
return interpolate.apply( null, args );
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = format;
|