Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VNodeChildren

Hierarchy

  • ReadonlyArray<VNode>
    • VNodeChildren

Indexable

[n: number]: VNode

Index

Properties

Methods

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.

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<VNode>

  • Iterator of values in the array.

    Returns IterableIterator<VNode>

concat

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

  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns VNode[]

  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns VNode[]

entries

  • entries(): IterableIterator<[number, VNode]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VNode]>

every

  • every(callbackfn: (value: VNode, index: number, array: keyof VNode[]) => unknown, thisArg?: any): boolean

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

    Parameters

    • callbackfn: (value: VNode, index: number, array: keyof VNode[]) => unknown

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

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

        • Parameters

          Returns unknown

    • 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

filter

  • filter<S>(callbackfn: (value: VNode, index: number, array: keyof VNode[]) => value is S, thisArg?: any): S[]
  • filter(callbackfn: (value: VNode, index: number, array: keyof VNode[]) => unknown, thisArg?: any): VNode[]

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

    Type parameters

    Parameters

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

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

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

        • Parameters

          Returns value is S

    • 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: (value: VNode, index: number, array: keyof VNode[]) => unknown

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

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

        • Parameters

          Returns unknown

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

find

  • find<S>(predicate: (this: void, value: VNode, index: number, obj: keyof VNode[]) => value is S, thisArg?: any): S | undefined
  • find(predicate: (value: VNode, index: number, obj: keyof VNode[]) => unknown, thisArg?: any): VNode | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: (this: void, value: VNode, index: number, obj: keyof VNode[]) => value is S

      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: VNode, index: number, obj: keyof VNode[]): value is S

        • Parameters

          • this: void
          • value: VNode
          • index: number
          • obj: keyof VNode[]

          Returns value is S

    • 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: (value: VNode, index: number, obj: keyof VNode[]) => unknown
        • (value: VNode, index: number, obj: keyof VNode[]): unknown

        • Parameters

          Returns unknown

    • Optional thisArg: any

    Returns VNode | undefined

findIndex

  • findIndex(predicate: (value: VNode, index: number, obj: keyof VNode[]) => unknown, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: VNode, index: number, obj: keyof VNode[]) => unknown

      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: VNode, index: number, obj: keyof VNode[]): unknown

        • Parameters

          Returns unknown

    • 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: (value: VNode, index: number, array: keyof VNode[]) => void, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

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

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

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

        • Parameters

          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

includes

  • includes(searchElement: VNode, fromIndex?: undefined | number): boolean

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

    Parameters

    • searchElement: VNode

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VNode, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VNode

      The value to locate in the array.

    • Optional fromIndex: undefined | 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?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | 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: VNode, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VNode

      The value to locate in the array.

    • Optional fromIndex: undefined | 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: VNode, index: number, array: keyof VNode[]) => 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: VNode, index: number, array: keyof VNode[]) => 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: VNode, index: number, array: keyof VNode[]): U

        • Parameters

          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: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode): VNode
  • reduce(callbackfn: (previousValue: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode, initialValue: VNode): VNode
  • reduce<U>(callbackfn: (previousValue: U, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => 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: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode

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

        • Parameters

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

          Returns VNode

    Returns VNode

  • Parameters

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

        • Parameters

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

          Returns VNode

    • initialValue: VNode

    Returns VNode

  • 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: VNode, currentIndex: number, array: keyof VNode[]) => 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: VNode, currentIndex: number, array: keyof VNode[]): U

        • Parameters

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

          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: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode): VNode
  • reduceRight(callbackfn: (previousValue: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode, initialValue: VNode): VNode
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => 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: VNode, currentValue: VNode, currentIndex: number, array: keyof VNode[]) => VNode

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

        • Parameters

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

          Returns VNode

    Returns VNode

  • Parameters

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

        • Parameters

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

          Returns VNode

    • initialValue: VNode

    Returns VNode

  • 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: VNode, currentIndex: number, array: keyof VNode[]) => 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: VNode, currentIndex: number, array: keyof VNode[]): U

        • Parameters

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

          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?: undefined | number, end?: undefined | number): VNode[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

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

    Returns VNode[]

some

  • some(callbackfn: (value: VNode, index: number, array: keyof VNode[]) => unknown, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: (value: VNode, index: number, array: keyof VNode[]) => unknown

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

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

        • Parameters

          Returns unknown

    • 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

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

values

  • values(): IterableIterator<VNode>

  • Returns an iterable of values in the array

    Returns IterableIterator<VNode>

Generated using TypeDoc