Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileSystemEntry<PathElm, FileContent>

Type parameters

  • PathElm

  • FileContent

Hierarchy

  • ReadonlyArray<any>
    • FileSystemEntry

Indexable

[n: number]: any

Index

Properties

Readonly 0

0: PathElm

Readonly 1

1: Content<PathElm, FileContent> | readonly FileSystemEntry<PathElm, FileContent>[]

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<any>
  • Iterator of values in the array.

    Returns IterableIterator<any>

concat

  • concat(...items: ConcatArray<any>[]): any[]
  • concat(...items: (any | ConcatArray<any>)[]): any[]
  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns any[]

  • Combines two or more arrays.

    Parameters

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

      Additional items to add to the end of array1.

    Returns any[]

entries

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

    Returns IterableIterator<[number, any]>

every

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

    Type parameters

    • S: any

    Parameters

    • predicate: (value: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): value is S
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

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

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

    Parameters

    • predicate: (value: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

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

    Type parameters

    • S: any

    Parameters

    • predicate: (value: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): value is S
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

          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: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

          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 any[]

find

  • find<S>(predicate: (this: void, value: any, index: number, obj: readonly any[]) => value is S, thisArg?: any): S | undefined
  • find(predicate: (value: any, index: number, obj: readonly any[]) => unknown, thisArg?: any): any | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: any

    Parameters

    • predicate: (this: void, value: any, index: number, obj: readonly any[]) => 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: any, index: number, obj: readonly any[]): value is S
        • Parameters

          • this: void
          • value: any
          • index: number
          • obj: readonly any[]

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

          • value: any
          • index: number
          • obj: readonly any[]

          Returns unknown

    • Optional thisArg: any

    Returns any | undefined

findIndex

  • findIndex(predicate: (value: any, index: number, obj: readonly any[]) => unknown, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: any, index: number, obj: readonly any[]) => 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: any, index: number, obj: readonly any[]): unknown
        • Parameters

          • value: any
          • index: number
          • obj: readonly any[]

          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

flat

  • 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: number = 1

    Parameters

    • this: A
    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

flatMap

  • flatMap<U, This>(callback: (this: This, value: any, index: number, array: any[]) => U | ReadonlyArray<U>, thisArg?: This): U[]
  • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

    Type parameters

    • U

    • This = undefined

    Parameters

    • callback: (this: This, value: any, index: number, array: any[]) => U | ReadonlyArray<U>

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

        • (this: This, value: any, index: number, array: any[]): U | ReadonlyArray<U>
        • Parameters

          • this: This
          • value: any
          • index: number
          • array: any[]

          Returns U | ReadonlyArray<U>

    • Optional thisArg: This

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

    Returns U[]

forEach

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

    Parameters

    • callbackfn: (value: any, index: number, array: readonly any[]) => void

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

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

          • value: any
          • index: number
          • array: readonly any[]

          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: any, fromIndex?: number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: any

      The element to search for.

    • Optional fromIndex: number

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

    Returns boolean

indexOf

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

    Parameters

    • searchElement: any

      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: any, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: any

      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: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): U
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

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

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

        • (previousValue: any, currentValue: any, currentIndex: number, array: readonly any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

          Returns any

    Returns any

  • Parameters

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

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

          Returns any

    • initialValue: any

    Returns any

  • 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: any, currentIndex: number, array: readonly any[]) => 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: any, currentIndex: number, array: readonly any[]): U
        • Parameters

          • previousValue: U
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

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

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

        • (previousValue: any, currentValue: any, currentIndex: number, array: readonly any[]): any
        • Parameters

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

          Returns any

    Returns any

  • Parameters

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

          • previousValue: any
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

          Returns any

    • initialValue: any

    Returns any

  • 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: any, currentIndex: number, array: readonly any[]) => 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: any, currentIndex: number, array: readonly any[]): U
        • Parameters

          • previousValue: U
          • currentValue: any
          • currentIndex: number
          • array: readonly any[]

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

some

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

    Parameters

    • predicate: (value: any, index: number, array: readonly any[]) => 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: any, index: number, array: readonly any[]): unknown
        • Parameters

          • value: any
          • index: number
          • array: readonly any[]

          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

values

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

    Returns IterableIterator<any>

Generated using TypeDoc