Index

Defined in: src/internal/file_index.ts:30

Internal

An index of file metadata

Extends

Map<string, Inode>

Constructors

Constructor

new Index(entries?): Index

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:51

Parameters

entries?

readonly readonly [string, Inode][] | null

Returns

Index

Inherited from

Map<string, Inode>.constructor

Constructor

new Index(iterable?): Index

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Parameters

iterable?

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

Returns

Index

Inherited from

Map<string, Inode>.constructor

Properties

[toStringTag]

readonly [toStringTag]: string

Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135

Inherited from

Map.[toStringTag]

maxSize

maxSize: number = size_max

Defined in: src/internal/file_index.ts:31

size

readonly size: number

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:46

Returns

the number of elements in the Map.

Inherited from

Map.size

[species]

readonly static [species]: MapConstructor

Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317

Inherited from

Map.[species]

Accessors

byteSize

Get Signature

get byteSize(): number

Defined in: src/internal/file_index.ts:60

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

Returns

number

Methods

_alloc()

_alloc(): number

Defined in: src/internal/file_index.ts:113

Internal

Get the next available ID in the index

Returns

number

[iterator]()

[iterator](): MapIterator<[string, Inode]>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:141

Returns an iterable of entries in the map.

Returns

MapIterator<[string, Inode]>

Inherited from

Map.[iterator]

clear()

clear(): void

Defined in: src/internal/file_index.ts:52

Removes all elements from the Map.

Returns

void

Overrides

Map.clear

delete()

delete(key): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:25

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.

Inherited from

Map.delete

directories()

directories(): Map<string, Record<string, number>>

Defined in: src/internal/file_index.ts:124

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

Returns

Map<string, Record<string, number>>

directoryEntries()

directoryEntries(path): Record<string, number>

Defined in: src/internal/file_index.ts:89

Parameters

path

string

Returns

Record<string, number>

entries()

entries(): MapIterator<[string, Inode]>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:146

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

Returns

MapIterator<[string, Inode]>

Inherited from

Map.entries

entryByID()

entryByID(id): { inode: Inode; path: string; } | undefined

Defined in: src/internal/file_index.ts:83

Parameters

id

number

Returns

{ inode: Inode; path: string; } | undefined

forEach()

forEach(callbackfn, thisArg?): void

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:29

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

Parameters

callbackfn

(value, key, map) => void

thisArg?

any

Returns

void

Inherited from

Map.forEach

fromJSON()

fromJSON(json): this

Defined in: src/internal/file_index.ts:144

Loads the index from JSON data

Parameters

json

IndexData

Returns

this

get()

get(key): Inode | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:34

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.

Inherited from

Map.get

getByID()

getByID(id): Inode | undefined

Defined in: src/internal/file_index.ts:79

Parameters

id

number

Returns

Inode | undefined

getOrInsert()

getOrInsert(key, defaultValue): Inode

Defined in: ../../node_modules/typescript/lib/lib.esnext.collection.d.ts:25

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.

Inherited from

Map.getOrInsert

getOrInsertComputed()

getOrInsertComputed(key, callback): Inode

Defined in: ../../node_modules/typescript/lib/lib.esnext.collection.d.ts:31

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) => Inode

Returns

Inode

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

Inherited from

Map.getOrInsertComputed

has()

has(key): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:38

Parameters

key

string

Returns

boolean

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

Inherited from

Map.has

keys()

keys(): MapIterator<string>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:151

Returns an iterable of keys in the map

Returns

MapIterator<string>

Inherited from

Map.keys

pathOf()

pathOf(id): string | undefined

Defined in: src/internal/file_index.ts:73

Parameters

id

number

Returns

string | undefined

set()

set(key, value): this

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:42

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

key

string

value

Inode

Returns

this

Inherited from

Map.set

toJSON()

toJSON(): IndexData

Defined in: src/internal/file_index.ts:36

Converts the index to JSON

Returns

IndexData

toString()

toString(): string

Defined in: src/internal/file_index.ts:48

Converts the index to a string

Returns

string

usage()

usage(): UsageInfo

Defined in: src/internal/file_index.ts:66

Returns

UsageInfo

values()

values(): MapIterator<Inode>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:156

Returns an iterable of values in the map

Returns

MapIterator<Inode>

Inherited from

Map.values

groupBy()

static groupBy<K, T>(items, keySelector): Map<K, T[]>

Defined in: ../../node_modules/typescript/lib/lib.es2024.collection.d.ts:23

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

Type Parameters

K

K

T

T

Parameters

items

Iterable<T>

An iterable.

keySelector

(item, index) => K

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

Returns

Map<K, T[]>

Inherited from

Map.groupBy

parse()

static parse(data): Index

Defined in: src/internal/file_index.ts:163

Parses an index from a string

Parameters

data

string

Returns

Index

Contribute Sponsor