Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TemplateStringsArray

Hierarchy

Indexable

[n: number]: string

Index

Properties

Readonly length

length: number

Gets the length of the array. This is a number one higher than the highest element defined in an array.

Readonly raw

raw: keyof string[]

Methods

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<string>[]

      Additional items to add to the end of array1.

    Returns string[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns string[]

every

  • every<S>(predicate: (value: string, index: number, array: keyof string[]) => value is S, thisArg?: any): this is keyof S[]
  • every(predicate: (value: string, index: number, array: keyof string[]) => unknown, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Type parameters

    • S: string

    Parameters

    • predicate: (value: string, index: number, array: keyof string[]) => value is S

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: string, index: number, array: keyof string[]): value is S
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns this is keyof S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: string, index: number, array: keyof string[]) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: string, index: number, array: keyof string[]): unknown
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter<S>(predicate: (value: string, index: number, array: keyof string[]) => value is S, thisArg?: any): S[]
  • filter(predicate: (value: string, index: number, array: keyof string[]) => unknown, thisArg?: any): string[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: string

    Parameters

    • predicate: (value: string, index: number, array: keyof string[]) => value is S

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: string, index: number, array: keyof string[]): value is S
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: string, index: number, array: keyof string[]) => unknown

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: string, index: number, array: keyof string[]): unknown
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns string[]

forEach

  • forEach(callbackfn: (value: string, index: number, array: keyof string[]) => void, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: string, index: number, array: keyof string[]) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: keyof string[]): void
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: string, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: string

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

lastIndexOf

  • lastIndexOf(searchElement: string, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: string

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: (value: string, index: number, array: keyof string[]) => U, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: string, index: number, array: keyof string[]) => U

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: keyof string[]): U
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

reduce

  • reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string): string
  • reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string, initialValue: string): string
  • reduce<U>(callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns string

    Returns string

  • Parameters

    • callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string
        • (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns string

    • initialValue: string

    Returns string

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]) => U

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string): string
  • reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string, initialValue: string): string
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns string

    Returns string

  • Parameters

    • callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]) => string
        • (previousValue: string, currentValue: string, currentIndex: number, array: keyof string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns string

    • initialValue: string

    Returns string

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]) => U

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: string, currentIndex: number, array: keyof string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: keyof string[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

slice

  • slice(start?: number, end?: number): string[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns string[]

some

  • some(predicate: (value: string, index: number, array: keyof string[]) => unknown, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: string, index: number, array: keyof string[]) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

        • (value: string, index: number, array: keyof string[]): unknown
        • Parameters

          • value: string
          • index: number
          • array: keyof string[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

Generated using TypeDoc