Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "string/left-trim-n/docs/types/index.d"

Index

Functions

Functions

Export assignment ltrimN

  • ltrimN(str: string, n: number, chars?: string | Array<string>): string
  • Trims n characters from the beginning of a string.

    Parameters

    • str: string

      input string

    • n: number

      number of characters to trim

    • Optional chars: string | Array<string>

      characters to trim (default: whitespace characters)

    Returns string

    trimmed string

    Example

    var str = '   abc   ';
    var out = ltrimN( str, 2 );
    // returns ' abc   '

    Example

    var str = '   abc   ';
    var out = ltrimN( str, str.length );
    // returns 'abc   '

    Example

    var str = '~~abc!~~';
    var out = ltrimN( str, str.length, [ '~', '!' ] );
    // returns 'abc!~~'

    Example

    var str = '🤖👨🏼‍🎨🤖👨🏼‍🎨🤖👨🏼‍🎨';
    var out = ltrimN( str, str.length, '👨🏼‍🎨🤖' );
    // returns ''