Interface KvMap

A map in the Key Value Store.

KVMap is modelled after JavaScript's Map object, except that keys and values must be of type ArrayBuffer and no guarantees on iteration order are provided.

interface KvMap {
    size: number;
    clear(): void;
    delete(key: ArrayBuffer): void;
    forEach(
        callback: (value: ArrayBuffer, key: ArrayBuffer, kvmap: KvMap) => void,
    ): void;
    get(key: ArrayBuffer): undefined | ArrayBuffer;
    getVersionOfPreviousWrite(key: ArrayBuffer): undefined | number;
    has(key: ArrayBuffer): boolean;
    set(key: ArrayBuffer, value: ArrayBuffer): KvMap;
}

Index

Properties

size

Methods

clear delete forEach get getVersionOfPreviousWrite has set

Properties

size

size: number

Methods

clear

clear(): void
Returns void
- Defined in global.ts:45

delete

delete(key: ArrayBuffer): void
Parameters
- key: ArrayBuffer
Returns void
- Defined in global.ts:44

forEach

forEach(
callback: (value: ArrayBuffer, key: ArrayBuffer, kvmap: KvMap) => void,
): void
Parameters
- callback: (value: ArrayBuffer, key: ArrayBuffer, kvmap: KvMap) => void
Returns void
- Defined in global.ts:46

get

get(key: ArrayBuffer): undefined | ArrayBuffer
Parameters
- key: ArrayBuffer
Returns undefined | ArrayBuffer
- Defined in global.ts:41

getVersionOfPreviousWrite

getVersionOfPreviousWrite(key: ArrayBuffer): undefined | number
Parameters
- key: ArrayBuffer
Returns undefined | number
- Defined in global.ts:42

has

has(key: ArrayBuffer): boolean
Parameters
- key: ArrayBuffer
Returns boolean
- Defined in global.ts:40

set

set(key: ArrayBuffer, value: ArrayBuffer): KvMap
Parameters
- key: ArrayBuffer
- value: ArrayBuffer
Returns KvMap
- Defined in global.ts:43

Interface KvMap

Index

Properties

Methods

Properties

size

Methods

clear

Returns void

delete

Parameters

Returns void

forEach

Parameters

Returns void

get

Parameters

Returns undefined | ArrayBuffer

getVersionOfPreviousWrite

Parameters

Returns undefined | number

has

Parameters

Returns boolean

set

Parameters

Returns KvMap

Settings

On This Page