Function truncate

  • truncate(str: ToStringAble, options?: Options): string

  • Truncates string if it's longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "...".

    Parameters

    • str: ToStringAble

      The string to truncate.

    • Optionaloptions: Options

      The options object.

    Returns string

    Returns the truncated string.

    Since

    5.6.0

    See

    [[replace]]

    Example

    truncate('hi-diddly-ho there, neighborino')
    // => 'hi-diddly-ho there, neighbo...'

    truncate('hi-diddly-ho there, neighborino', {
      'length': 24,
      'separator': ' '
    })
    // => 'hi-diddly-ho there,...'

    truncate('hi-diddly-ho there, neighborino', {
      'length': 24,
      'separator': /,? +/
    })
    // => 'hi-diddly-ho there...'

    truncate('hi-diddly-ho there, neighborino', {
      'omission': ' [...]'
    })
    // => 'hi-diddly-ho there, neig [...]'
  • truncate(str: string, options?: Options): string

  • Truncates string if it's longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "...".

    Parameters

    • str: string

      The string to truncate.

    • Optionaloptions: Options

      The options object.

    Returns string

    Returns the truncated string.

    Since

    5.6.0

    See

    [[replace]]

    Example

    truncate('hi-diddly-ho there, neighborino')
    // => 'hi-diddly-ho there, neighbo...'

    truncate('hi-diddly-ho there, neighborino', {
      'length': 24,
      'separator': ' '
    })
    // => 'hi-diddly-ho there,...'

    truncate('hi-diddly-ho there, neighborino', {
      'length': 24,
      'separator': /,? +/
    })
    // => 'hi-diddly-ho there...'

    truncate('hi-diddly-ho there, neighborino', {
      'omission': ' [...]'
    })
    // => 'hi-diddly-ho there, neig [...]'

Settings

Member Visibility