Skip to main content

DBPFIndexTable

DBPF.js v1.1.0 • Docs

DBPF.js v1.1.0 / DBPF / DBPFIndexTable

Class: DBPFIndexTable

The DBPF Index Table class.

This class is a Map of DBPF entries.​

See​

It implements an EventEmitter interface.​

Extends​

Implements​

Constructors​

new DBPFIndexTable()​

private new DBPFIndexTable(DBPF): DBPFIndexTable

Internal

The internal constructor for the DBPF Index Table.

Much like the DBPF reader, this constructor is public, but it is not recommended to use it directly. Instead, use DBPF.create which will create and await the DBPF Index Table for you.

If you must use the constructor directly, ensure to await the DBPFIndexTable.init method before using the instance.

Parameters​

• DBPF: DBPF

The DBPF reader instance to read the index table from.

Returns​

DBPFIndexTable

Deprecated​

Overrides​

Map<number,Promise<DBPFEntry>>.constructor

Defined in​

src/DBPF.ts:625

Properties​

[toStringTag]​

readonly [toStringTag]: string

Inherited from​

Map.[toStringTag]

Defined in​

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137

/ _DBPF​

private _DBPF: DBPF

Defined in​

src/DBPF.ts:596

/ _emitter​

private _emitter: _EventEmitter

Defined in​

src/DBPF.ts:980

/ _entry / _length​

private _entry_length: undefined | number

Defined in​

src/DBPF.ts:704

/ _header / _segments​

private _header_segments: undefined | Map<number, number>

Defined in​

src/DBPF.ts:693

/ _init​

private _init: undefined | EventedPromise<void>

Defined in​

src/DBPF.ts:786

/ _mode / _flag​

private _mode_flag: undefined | number

Defined in​

src/DBPF.ts:679

/ _offset​

private _offset: number

Defined in​

src/DBPF.ts:599

/ _reader​

private _reader: BufferReader

Defined in​

src/DBPF.ts:597

/ _size​

private _size: number

Defined in​

src/DBPF.ts:609

emit​

emit: EventEmitMethod

Implementation of​

EventEmitter.emit

Defined in​

src/DBPF.ts:983

length​

readonly length: number

The size of the DBPF Index Table.

See​

DBPFIndexHeader.size

Defined in​

src/DBPF.ts:606

off()​

off: (event, listener) => this

Parameters​

• event: string

• listener: EventListener

Returns​

this

Implementation of​

EventEmitter.off

Defined in​

src/DBPF.ts:982

on()​

on: (event, listener) => this

Parameters​

• event: string

• listener: EventListener

Returns​

this

Implementation of​

EventEmitter.on

Defined in​

src/DBPF.ts:981

once()​

once: (event, listener) => this

Parameters​

• event: string

• listener: EventListener

Returns​

this

Implementation of​

EventEmitter.once

Defined in​

src/DBPF.ts:984

ON / _GET​

readonly static ON_GET: "get" = "get"

The event name for when the DBPF Index Table retrieves an entry.

Defined in​

src/DBPF.ts:999

/ [species / ]​

readonly static [species]: MapConstructor

Inherited from​

Map.[species]

Defined in​

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319

Accessors​

entryLength​

get entryLength(): number

The amount of memory used by each entry in the DBPF file.

Returns​

number

Defined in​

src/DBPF.ts:699

headerSegments​

get headerSegments(): number[]

An array of indexes (in order) of where each header segment is reused in each entry.

  • see: ../../other/spec/DBPF.md - DBPF v2.0
  • note: The header segments are shared segments between each entry, and are a way to save space in the DBPF file.
    • this means that the amount of bytes used by each entry is reduced by the amount of bytes used for the header segments.

Returns​

number[]

Defined in​

src/DBPF.ts:688

mode​

get mode(): number

The DBPF v2.0 mode flag (AKA the "Index Table Type").

Returns​

number

Defined in​

src/DBPF.ts:674

size​

get size(): number

Returns​

number

the number of elements in the Map.

Overrides​

Map.size

Defined in​

src/DBPF.ts:610

Methods​

[iterator]()​

[iterator](): IterableIterator<[number, Promise<DBPFEntry>]>

Returns​

IterableIterator<[number, Promise<DBPFEntry>]>

Overrides​

Map.[iterator]

Defined in​

src/DBPF.ts:976

clear()​

clear(): void

Returns​

void

Deprecated​

No-ops. Implemented for Map interface.

Overrides​

Map.clear

Defined in​

src/DBPF.ts:803

delete()​

delete(key): boolean

Parameters​

• key: number

Returns​

boolean

Deprecated​

No-ops. Implemented for Map interface.

Overrides​

Map.delete

Defined in​

src/DBPF.ts:797

entries()​

entries(): IterableIterator<[number, Promise<DBPFEntry>]>

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

Returns​

IterableIterator<[number, Promise<DBPFEntry>]>

Overrides​

Map.entries

Defined in​

src/DBPF.ts:955

forEach()​

forEach(callbackfn, thisArg?): void

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

Parameters​

• callbackfn

• thisArg?: any

Returns​

void

Overrides​

Map.forEach

Defined in​

src/DBPF.ts:964

get()​

get(key): EventedPromise<DBPFEntry>

Gets a DBPF entry from the DBPF Index Table by index

Parameters​

• key: number

Returns​

EventedPromise<DBPFEntry>

An evented promise that resolves with the DBPF entry.

Overrides​

Map.get

Defined in​

src/DBPF.ts:812

has()​

has(key): boolean

Parameters​

• key: number

Returns​

boolean

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

Overrides​

Map.has

Defined in​

src/DBPF.ts:943

init()​

init(): EventedPromise<void>

Initializes the DBPF Index Table asynchronously, evented.

Returns​

EventedPromise<void>

An evented promise that resolves when the DBPF Index Table is initialized.

Deprecated​

use DBPFIndexTable.create instead

Defined in​

src/DBPF.ts:711

keys()​

keys(): IterableIterator<number>

Returns an iterable of keys in the map

Returns​

IterableIterator<number>

Overrides​

Map.keys

Defined in​

src/DBPF.ts:947

set()​

set(key, value): this

Parameters​

• key: number

• value: Promise<DBPFEntry>

Returns​

this

Deprecated​

No-ops. Implemented for Map interface.

Overrides​

Map.set

Defined in​

src/DBPF.ts:791

values()​

values(): IterableIterator<Promise<DBPFEntry>>

Returns an iterable of values in the map

Returns​

IterableIterator<Promise<DBPFEntry>>

Overrides​

Map.values

Defined in​

src/DBPF.ts:951

create()​

static create(DBPF): EventedPromise<DBPFIndexTable>

Creates a new DBPF Index Table asynchronously, evented.

Parameters​

• DBPF: DBPF

The DBPF reader to read the index table from.

Returns​

EventedPromise<DBPFIndexTable>

An evented promise that resolves when the DBPF Index Table is created.

Defined in​

src/DBPF.ts:575

Events​

ON_CREATE​

readonly static ON_CREATE: "create" = "create"

The event name for when the DBPF Index Table is created properly.

Defined in​

src/DBPF.ts:990

ON / _ERROR​

readonly static ON_ERROR: "error" = "error"

The event name for when the DBPF Index Table encounters an error.

Defined in​

src/DBPF.ts:1004

ON / _INIT​

readonly static ON_INIT: "init" = "init"

The event name for when the DBPF Index Table is initialized.

Defined in​

src/DBPF.ts:995

Last updated on