time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1290B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 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 /**
     22 * Pad a string.
     23 *
     24 * @module @stdlib/string/pad
     25 *
     26 * @example
     27 * var pad = require( '@stdlib/string/pad' );
     28 *
     29 * var str = pad( 'a', 5 );
     30 * // returns 'a    '
     31 *
     32 * str = pad( 'a', 10, {
     33 *     'lpad': 'b'
     34 * });
     35 * // returns 'bbbbbbbbba'
     36 *
     37 * str = pad( 'a', 12, {
     38 *     'rpad': 'b'
     39 * });
     40 * // returns 'abbbbbbbbbbb'
     41 *
     42 * var opts = {
     43 *     'lpad': 'a',
     44 *     'rpad': 'c'
     45 * };
     46 * str = pad( 'b', 10, opts );
     47 * // returns 'aaaabccccc'
     48 *
     49 * opts = {
     50 *     'lpad': 'a',
     51 *     'rpad': 'c',
     52 *     'centerRight': true
     53 * };
     54 * str = pad( 'b', 10, opts );
     55 * // returns 'aaaaabcccc'
     56 */
     57 
     58 // MODULES //
     59 
     60 var pad = require( './pad.js' );
     61 
     62 
     63 // EXPORTS //
     64 
     65 module.exports = pad;