/**
* @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';

/**
* Pad a string.
*
* @module @stdlib/string/pad
*
* @example
* var pad = require( '@stdlib/string/pad' );
*
* var str = pad( 'a', 5 );
* // returns 'a    '
*
* str = pad( 'a', 10, {
*     'lpad': 'b'
* });
* // returns 'bbbbbbbbba'
*
* str = pad( 'a', 12, {
*     'rpad': 'b'
* });
* // returns 'abbbbbbbbbbb'
*
* var opts = {
*     'lpad': 'a',
*     'rpad': 'c'
* };
* str = pad( 'b', 10, opts );
* // returns 'aaaabccccc'
*
* opts = {
*     'lpad': 'a',
*     'rpad': 'c',
*     'centerRight': true
* };
* str = pad( 'b', 10, opts );
* // returns 'aaaaabcccc'
*/

// MODULES //

var pad = require( './pad.js' );


// EXPORTS //

module.exports = pad;
