Skip to main content
Version: v1

Dictionary Interface

Signature

export interface Dictionary<TKey, TData>

Type Parameters

ParameterDescription
TKey
TData

Methods

MethodReturn TypeDescription
get(key)Property<TKey, TData> | undefined
map(action, accum)void
put(key, data, conflict)void
remove(key)void

Method Details

get

Signature

get(key: TKey): Property<TKey, TData> | undefined;

Parameters

ParameterTypeDescription
keyTKey

Returns

Return type: Property<TKey, TData> | undefined

map

Signature

map<TAccum>(action: PropertyAction<TKey, TData>, accum?: TAccum): void;
Type Parameters
ParameterDescription
TAccum

Parameters

ParameterModifiersTypeDescription
actionPropertyAction<TKey, TData>
accumoptionalTAccum

put

Signature

put(key: TKey, data: TData, conflict?: ConflictAction<TKey, TData>): void;

Parameters

ParameterModifiersTypeDescription
keyTKey
dataTData
conflictoptionalConflictAction<TKey, TData>

remove

Signature

remove(key: TKey): void;

Parameters

ParameterTypeDescription
keyTKey