Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReflectionFlags

Hierarchy

  • Array<string>
    • ReflectionFlags

Indexable

[n: number]: string

Index

Properties

Array

Array: ArrayConstructor

Optional flags

Optional hasExportAssignment

hasExportAssignment: boolean

Optional isAbstract

isAbstract: boolean

Optional isConst

isConst: boolean

Optional isConstructorProperty

isConstructorProperty: boolean

Optional isExported

isExported: boolean

Is this member exported?

Optional isExternal

isExternal: boolean

Is this a declaration from an external document?

Optional isLet

isLet: boolean

Optional isOptional

isOptional: boolean

Whether this reflection is an optional component or not.

Applies to function parameters and object members.

Optional isPrivate

isPrivate: boolean

Is this a private member?

Optional isProtected

isProtected: boolean

Is this a protected member?

Optional isPublic

isPublic: boolean

Is this a public member?

Optional isRest

isRest: boolean

Whether it's a rest parameter, like foo(...params);.

Optional isStatic

isStatic: boolean

Is this a static member?

length

length: number

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

Methods

__@iterator

  • __@iterator(): IterableIterator<string>
  • Iterator

    Returns IterableIterator<string>

concat

  • concat(...items: (T[] | ReadonlyArray<T>)[]): string[]
  • concat(...items: (T[] | T | ReadonlyArray<T>)[]): string[]
  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns string[]

  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns string[]

copyWithin

  • copyWithin(target: number, start: number, end?: number): this
  • 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 this

entries

  • entries(): IterableIterator<[number, string]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, string]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

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

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

          Returns boolean

    • 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 boolean

fill

  • fill(value: string, start?: number, end?: number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: string

      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 this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): string[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: string

    Parameters

    • callbackfn: function

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

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

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

          Returns boolean

    • 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 S[]

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

    Parameters

    • callbackfn: function

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

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

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

          Returns any

    • 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 string[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): string | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: string

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: string, index: number, obj: string[]): boolean
        • Parameters

          • this: void
          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: string, index: number, obj: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

    Returns string | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: string, index: number, obj: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      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: string[]): void
        • Parameters

          • value: string
          • index: number
          • array: 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

keys

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

    Returns IterableIterator<number>

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: function, 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: function

      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: string[]): U
        • Parameters

          • value: string
          • index: number
          • array: 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[]

pop

  • pop(): string | undefined
  • Removes the last element from an array and returns it.

    Returns string | undefined

push

  • push(...items: string[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: string[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): string
  • reduce(callbackfn: function, initialValue: string): string
  • reduce<U>(callbackfn: function, 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: function

      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: string[]): string
        • Parameters

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

          Returns string

    Returns string

  • Parameters

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

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: 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: function

      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: string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: 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: function): string
  • reduceRight(callbackfn: function, initialValue: string): string
  • reduceRight<U>(callbackfn: function, 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: function

      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: string[]): string
        • Parameters

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

          Returns string

    Returns string

  • Parameters

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

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: 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: function

      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: string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: 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

reverse

  • reverse(): string[]
  • Reverses the elements in an Array.

    Returns string[]

shift

  • shift(): string | undefined
  • Removes the first element from an array and returns it.

    Returns string | undefined

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.

    Returns string[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

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

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

          Returns boolean

    • 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 boolean

sort

  • sort(compareFn?: function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

        • (a: string, b: string): number
        • Parameters

          • a: string
          • b: string

          Returns number

    Returns this

splice

  • splice(start: number, deleteCount?: number): string[]
  • splice(start: number, deleteCount: number, ...items: string[]): string[]
  • 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 string[]

  • 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: string[]

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

    Returns string[]

toLocaleString

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

    Returns string

toString

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

    Returns string

unshift

  • unshift(...items: string[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: string[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<string>
  • Returns an iterable of values in the array

    Returns IterableIterator<string>

Generated using TypeDoc