External module "string/pad/docs/types/index.d"

Export assignment pad

• pad(str: string, len: number, options?: Options): string

• Pads a string such that the padded string has a length of len.

  throws

  second argument must be a nonnegative integer

  throws

  must provide valid options

  throws

  at least one padding must have a length greater than 0

  Parameters

  • str: string

    string to pad

  • len: number

    string length

  • Optional options: Options

    function options

  Returns string

  padded string

  Example

  var str = pad( 'a', 5 );
  // returns 'a    '

  Example

  var str = pad( 'a', 10, {
      'lpad': 'b'
  });
  // returns 'bbbbbbbbba'

  Example

  var str = pad( 'a', 12, {
      'rpad': 'b'
  });
  // returns 'abbbbbbbbbbb'

  Example

  var opts = {
      'lpad': 'a',
      'rpad': 'c'
  };
  var str = pad( 'b', 10, opts );
  // returns 'aaaabccccc'

  Example

  var opts = {
      'lpad': 'a',
      'rpad': 'c',
      'centerRight': true
  };
  var str = pad( 'b', 10, opts );
  // returns 'aaaaabcccc'