Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Methods

  • [unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean
  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns CustomThemeOptions | CustomThemeOptionsWithScheme

  • copyWithin(target: number, start: number, end?: number): CustomThemes
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns CustomThemes

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: CustomThemeOptions | CustomThemeOptionsWithScheme

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns CustomThemes

  • flat<A, D>(this: A, depth?: D): FlatArray<A, D>[]
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type Parameters

    • A

    • D extends number = 1

    Parameters

    • this: A
    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    Returns boolean

  • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

    Parameters

    Returns number

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

    Parameters

    • Optional separator: string

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

    Returns string

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

  • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

    Parameters

    • searchElement: CustomThemeOptions | CustomThemeOptionsWithScheme

      The value to locate in the array.

    • Optional fromIndex: number

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

    Returns number

  • Appends new elements to the end of an array, and returns the new length of the array.

    Parameters

    Returns number

  • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

    Parameters

    • Optional start: number

      The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

    • Optional end: number

      The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

    Returns (CustomThemeOptions | CustomThemeOptionsWithScheme)[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns (CustomThemeOptions | CustomThemeOptionsWithScheme)[]

    An array containing the elements that were deleted.

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: (CustomThemeOptions | CustomThemeOptionsWithScheme)[]

      Elements to insert into the array in place of the deleted elements.

    Returns (CustomThemeOptions | CustomThemeOptionsWithScheme)[]

    An array containing the elements that were deleted.

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

    Returns string

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

    Returns string

  • Inserts new elements at the start of an array, and returns the new length of the array.

    Parameters

    Returns number

Generated using TypeDoc