space_pad.js (1393B)
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 // FUNCTIONS // 22 23 /** 24 * Returns `n` spaces. 25 * 26 * @private 27 * @param {number} n - number of spaces 28 * @returns {string} string of spaces 29 */ 30 function spaces( n ) { 31 var out = ''; 32 var i; 33 for ( i = 0; i < n; i++ ) { 34 out += ' '; 35 } 36 return out; 37 } 38 39 40 // MAIN // 41 42 /** 43 * Pads a token with spaces to the specified width. 44 * 45 * @private 46 * @param {string} str - token argument 47 * @param {number} width - token width 48 * @param {boolean} [right=false] - boolean indicating whether to pad to the right 49 * @returns {string} padded token argument 50 */ 51 function spacePad( str, width, right ) { 52 var pad = width - str.length; 53 if ( pad < 0 ) { 54 return str; 55 } 56 str = ( right ) ? 57 str + spaces( pad ) : 58 spaces( pad ) + str; 59 return str; 60 } 61 62 63 // EXPORTS // 64 65 module.exports = spacePad;