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
Map
<number
,Promise
<DBPFEntry
>>
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
Deprecated
Overrides
Map<number,Promise<DBPFEntry>>.constructor
Defined in
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
/ _emitter
private
_emitter:_EventEmitter
Defined in
/ _entry / _length
private
_entry_length:undefined
|number
Defined in
/ _header / _segments
private
_header_segments:undefined
|Map
<number
,number
>
Defined in
/ _init
private
_init:undefined
|EventedPromise
<void
>
Defined in
/ _mode / _flag
private
_mode_flag:undefined
|number
Defined in
/ _offset
private
_offset:number
Defined in
/ _reader
private
_reader:BufferReader
Defined in
/ _size
private
_size:number
Defined in
emit
emit:
EventEmitMethod
Implementation of
EventEmitter.emit
Defined in
length
readonly
length:number
The size of the DBPF Index Table.
See
DBPFIndexHeader.size
Defined in
off()
off: (
event
,listener
) =>this
Parameters
• event: string
• listener: EventListener
Returns
this
Implementation of
EventEmitter.off
Defined in
on()
on: (
event
,listener
) =>this
Parameters
• event: string
• listener: EventListener
Returns
this
Implementation of
EventEmitter.on
Defined in
once()
once: (
event
,listener
) =>this
Parameters
• event: string
• listener: EventListener
Returns
this
Implementation of
EventEmitter.once
Defined in
ON / _GET
readonly
static
ON_GET:"get"
="get"
The event name for when the DBPF Index Table retrieves an entry.
Defined in
/ [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.
- see: ../../other/spec/DBPF.md - DBPF v2.0
- note: That this may not be the full 32 bytes, as the header segments are shared and reused in each entry.
Returns
number
Defined in
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
mode
get
mode():number
The DBPF v2.0 mode flag (AKA the "Index Table Type").
Returns
number
Defined in
size
get
size():number
Returns
number
the number of elements in the Map.
Overrides
Map.size
Defined in
Methods
[iterator]()
[iterator]():
IterableIterator
<[number
,Promise
<DBPFEntry
>]>
Returns
IterableIterator
<[number
, Promise
<DBPFEntry
>]>
Overrides
Map.[iterator]
Defined in
clear()
clear():
void
Returns
void
Deprecated
No-ops. Implemented for Map interface.
Overrides
Map.clear
Defined in
delete()
delete(
key
):boolean
Parameters
• key: number
Returns
boolean
Deprecated
No-ops. Implemented for Map interface.
Overrides
Map.delete
Defined in
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
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
get()
get(
key
):EventedPromise
<DBPFEntry
>
Gets a DBPF entry from the DBPF Index Table by index
Parameters
• key: number
Returns
An evented promise that resolves with the DBPF entry.
Overrides
Map.get
Defined in
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
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
keys()
keys():
IterableIterator
<number
>
Returns an iterable of keys in the map
Returns
IterableIterator
<number
>
Overrides
Map.keys
Defined in
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
values()
values():
IterableIterator
<Promise
<DBPFEntry
>>
Returns an iterable of values in the map
Returns
IterableIterator
<Promise
<DBPFEntry
>>
Overrides
Map.values
Defined in
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
Events
ON_CREATE
readonly
static
ON_CREATE:"create"
="create"
The event name for when the DBPF Index Table is created properly.
Defined in
ON / _ERROR
readonly
static
ON_ERROR:"error"
="error"
The event name for when the DBPF Index Table encounters an error.
Defined in
ON / _INIT
readonly
static
ON_INIT:"init"
="init"
The event name for when the DBPF Index Table is initialized.