main.js (1713B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2022 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var interpolate = require( './../../base/format-interpolate' ); 24 var tokenize = require( './../../base/format-tokenize' ); 25 var isString = require( './is_string.js' ); 26 27 28 // MAIN // 29 30 /** 31 * Inserts supplied variable values into a format string. 32 * 33 * @param {string} str - input string 34 * @param {Array} ...args - variable values 35 * @throws {TypeError} first argument must be a string 36 * @throws {Error} invalid flags 37 * @returns {string} formatted string 38 * 39 * @example 40 * var str = format( 'Hello %s!', 'world' ); 41 * // returns 'Hello world!' 42 * 43 * @example 44 * var str = format( 'Pi: ~%.2f', 3.141592653589793 ); 45 * // returns 'Pi: ~3.14' 46 */ 47 function format( str ) { 48 var tokens; 49 var args; 50 var i; 51 52 if ( !isString( str ) ) { 53 throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) ); 54 } 55 tokens = tokenize( str ); 56 args = new Array( arguments.length ); 57 args[ 0 ] = tokens; 58 for ( i = 1; i < args.length; i++ ) { 59 args[ i ] = arguments[ i ]; 60 } 61 return interpolate.apply( null, args ); 62 } 63 64 65 // EXPORTS // 66 67 module.exports = format;