92 lines
2.7 KiB
JavaScript
92 lines
2.7 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
|
||
|
|
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
|
||
|
|
var repeat = require( './../../repeat' );
|
||
|
|
var ceil = require( '@stdlib/math/base/special/ceil' );
|
||
|
|
var format = require( './../../format' );
|
||
|
|
var FLOAT64_MAX_SAFE_INTEGER = require( '@stdlib/constants/float64/max-safe-integer' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Right pads a string such that the padded string has a length of at least `len`.
|
||
|
|
*
|
||
|
|
* @param {string} str - string to pad
|
||
|
|
* @param {NonNegativeInteger} len - minimum string length
|
||
|
|
* @param {string} [pad=' '] - string used to pad
|
||
|
|
* @throws {TypeError} first argument must be a string
|
||
|
|
* @throws {TypeError} second argument must be a nonnegative integer
|
||
|
|
* @throws {TypeError} third argument must be a string
|
||
|
|
* @throws {RangeError} padding must have a length greater than `0`
|
||
|
|
* @returns {string} padded string
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var str = rpad( 'a', 5 );
|
||
|
|
* // returns 'a '
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var str = rpad( 'beep', 10, 'p' );
|
||
|
|
* // returns 'beeppppppp'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var str = rpad( 'beep', 12, 'boop' );
|
||
|
|
* // returns 'beepboopboop'
|
||
|
|
*/
|
||
|
|
function rpad( str, len, pad ) {
|
||
|
|
var n;
|
||
|
|
var p;
|
||
|
|
if ( !isString( str ) ) {
|
||
|
|
throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
|
||
|
|
}
|
||
|
|
if ( !isNonNegativeInteger( len ) ) {
|
||
|
|
throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', len ) );
|
||
|
|
}
|
||
|
|
if ( arguments.length > 2 ) {
|
||
|
|
p = pad;
|
||
|
|
if ( !isString( p ) ) {
|
||
|
|
throw new TypeError( format( 'invalid argument. Third argument must be a string. Value: `%s`.', p ) );
|
||
|
|
}
|
||
|
|
if ( p.length === 0 ) {
|
||
|
|
throw new RangeError( 'invalid argument. Pad string must not be an empty string.' );
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
p = ' ';
|
||
|
|
}
|
||
|
|
if ( len > FLOAT64_MAX_SAFE_INTEGER ) {
|
||
|
|
throw new RangeError( format( 'invalid argument. Output string length exceeds maximum allowed string length. Value: `%u`.', len ) );
|
||
|
|
}
|
||
|
|
n = ( len - str.length ) / p.length;
|
||
|
|
if ( n <= 0 ) {
|
||
|
|
return str;
|
||
|
|
}
|
||
|
|
n = ceil( n );
|
||
|
|
return str + repeat( p, n );
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = rpad;
|