83 lines
3.0 KiB
TypeScript
83 lines
3.0 KiB
TypeScript
|
/**
|
||
|
|
* Constructor parameters for {@link ProtectableMap}
|
||
|
|
*
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export interface IProtectableMapParameters<K, V> {
|
||
|
|
/**
|
||
|
|
* An optional hook that will be invoked before Map.clear() is performed.
|
||
|
|
*/
|
||
|
|
onClear?: (source: ProtectableMap<K, V>) => void;
|
||
|
|
/**
|
||
|
|
* An optional hook that will be invoked before Map.delete() is performed.
|
||
|
|
*/
|
||
|
|
onDelete?: (source: ProtectableMap<K, V>, key: K) => void;
|
||
|
|
/**
|
||
|
|
* An optional hook that will be invoked before Map.set() is performed.
|
||
|
|
* @remarks
|
||
|
|
* If this hook is provided, the function MUST return the `value` parameter.
|
||
|
|
* This provides the opportunity to modify the value before it is added
|
||
|
|
* to the map.
|
||
|
|
*/
|
||
|
|
onSet?: (source: ProtectableMap<K, V>, key: K, value: V) => V;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* The ProtectableMap provides an easy way for an API to expose a `Map<K, V>` property
|
||
|
|
* while intercepting and validating any write operations that are performed by
|
||
|
|
* consumers of the API.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
* The ProtectableMap itself is intended to be a private object that only its owner
|
||
|
|
* can access directly. Any operations performed directly on the ProtectableMap will
|
||
|
|
* bypass the hooks and any validation they perform. The public property that is exposed
|
||
|
|
* to API consumers should return {@link ProtectableMap.protectedView} instead.
|
||
|
|
*
|
||
|
|
* For example, suppose you want to share your `Map<string, number>` data structure,
|
||
|
|
* but you want to enforce that the key must always be an upper case string:
|
||
|
|
* You could use the onSet() hook to validate the keys and throw an exception
|
||
|
|
* if the key is not uppercase.
|
||
|
|
*
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export declare class ProtectableMap<K, V> {
|
||
|
|
private readonly _protectedView;
|
||
|
|
constructor(parameters: IProtectableMapParameters<K, V>);
|
||
|
|
/**
|
||
|
|
* The owner of the protectable map should return this object via its public API.
|
||
|
|
*/
|
||
|
|
get protectedView(): Map<K, V>;
|
||
|
|
/**
|
||
|
|
* Removes all entries from the map.
|
||
|
|
* This operation does NOT invoke the ProtectableMap onClear() hook.
|
||
|
|
*/
|
||
|
|
clear(): void;
|
||
|
|
/**
|
||
|
|
* Removes the specified key from the map.
|
||
|
|
* This operation does NOT invoke the ProtectableMap onDelete() hook.
|
||
|
|
*/
|
||
|
|
delete(key: K): boolean;
|
||
|
|
/**
|
||
|
|
* Sets a value for the specified key.
|
||
|
|
* This operation does NOT invoke the ProtectableMap onSet() hook.
|
||
|
|
*/
|
||
|
|
set(key: K, value: V): this;
|
||
|
|
/**
|
||
|
|
* Performs an operation for each (key, value) entries in the map.
|
||
|
|
*/
|
||
|
|
forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
|
||
|
|
/**
|
||
|
|
* Retrieves the value for the specified key.
|
||
|
|
* @returns undefined if the value is undefined OR if the key is missing;
|
||
|
|
* otherwise returns the value associated with the key.
|
||
|
|
*/
|
||
|
|
get(key: K): V | undefined;
|
||
|
|
/**
|
||
|
|
* Returns true if the specified key belongs to the map.
|
||
|
|
*/
|
||
|
|
has(key: K): boolean;
|
||
|
|
/**
|
||
|
|
* Returns the number of (key, value) entries in the map.
|
||
|
|
*/
|
||
|
|
get size(): number;
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=ProtectableMap.d.ts.map
|