ZenFS
    Preparing search index...

    Class IndexInternal

    An index of file metadata

    Hierarchy

    Index

    Constructors

    • Parameters

      • Optionalentries: readonly (readonly [string, Inode])[] | null

      Returns Index

    • Parameters

      • Optionaliterable: Iterable<readonly [string, Inode], any, any> | null

      Returns Index

    Properties

    "[toStringTag]": string
    maxSize: number = size_max
    size: number

    the number of elements in the Map.

    "[species]": MapConstructor

    Accessors

    • get byteSize(): number

      Get the size in bytes of the index (including the size reported for each entry)

      Returns number

    Methods

    • Returns an iterable of entries in the map.

      Returns MapIterator<[string, Inode]>

    • Removes all elements from the Map.

      Returns void

    • Parameters

      • key: string

      Returns boolean

      true if an element in the Map existed and has been removed, or false if the element does not exist.

    • Gets a list of entries for each directory in the index. Use

      Returns Map<string, Record<string, number>>

    • Parameters

      • path: string

      Returns Record<string, number>

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

      Returns MapIterator<[string, Inode]>

    • Executes a provided function once per each key/value pair in the Map, in insertion order.

      Parameters

      • callbackfn: (value: Inode, key: string, map: Map<string, Inode>) => void
      • OptionalthisArg: any

      Returns void

    • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

      Parameters

      • key: string

      Returns Inode | undefined

      Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

    • Returns a specified element from the Map object. If no element is associated with the specified key, a new element with the value defaultValue will be inserted into the Map and returned.

      Parameters

      • key: string
      • defaultValue: Inode

      Returns Inode

      The element associated with the specified key, which will be defaultValue if no element previously existed.

    • Returns a specified element from the Map object. If no element is associated with the specified key, the result of passing the specified key to the callback function will be inserted into the Map and returned.

      Parameters

      • key: string
      • callback: (key: string) => Inode

      Returns Inode

      The element associated with the specific key, which will be the newly computed value if no element previously existed.

    • Parameters

      • key: string

      Returns boolean

      boolean indicating whether an element with the specified key exists or not.

    • Returns an iterable of keys in the map

      Returns MapIterator<string>

    • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

      Parameters

      Returns this

    • Returns an iterable of values in the map

      Returns MapIterator<Inode>

    • Groups members of an iterable according to the return value of the passed callback.

      Type Parameters

      • K
      • T

      Parameters

      • items: Iterable<T>

        An iterable.

      • keySelector: (item: T, index: number) => K

        A callback which will be invoked for each item in items.

      Returns Map<K, T[]>