Packages > @fluidframework/tree > TreeMapNodeUnsafe

TreeMapNodeUnsafe Interface

Unenforced version of TreeMapNode .

Signature

/** @sealed */
export interface TreeMapNodeUnsafe<T extends Unenforced<ImplicitAllowedTypes>> extends ReadonlyMap<string, TreeNodeFromImplicitAllowedTypesUnsafe<T>>, TreeNode

Extends: ReadonlyMap<string, TreeNodeFromImplicitAllowedTypesUnsafe <T>>, TreeNode

Type Parameters

Parameter Constraint Description
T Unenforced<ImplicitAllowedTypes>

Remarks

Do note use this type directly: its only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.

Methods

Method Return Type Description
delete(key) void Removes the specified element from this map by its key.
set(key, value) void Adds or updates an entry in the map with a specified key and a value.

Method Details

delete

Removes the specified element from this map by its key.

Signature

delete(key: string): void;

Remarks

Note: unlike JavaScript’s Map API, this method does not return a flag indicating whether or not the value was deleted.

Parameters

Parameter Type Description
key string The key of the element to remove from the map.

set

Adds or updates an entry in the map with a specified key and a value.

Signature

set(key: string, value: InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T> | undefined): void;

Remarks

Setting the value at a key to undefined is equivalent to calling delete(key) with that key.

Parameters

Parameter Type Description
key string The key of the element to add to the map.
value InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T> | undefined The value of the element to add to the map.