TreeMapNodeUnsafe Interface
Packages > fluid-framework > InternalTypes > TreeMapNodeUnsafe
Unenforced version of TreeMapNode .
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here .
Signature
/** @sealed */
export interface TreeMapNodeUnsafe<T extends Unenforced<ImplicitAllowedTypes>> extends ReadonlyMapInlined<string, T>, TreeNode
Extends: ReadonlyMapInlined <string, 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 | Alerts | Return Type | Description |
|---|---|---|---|
| delete(key) | System |
void | Removes the specified element from this map by its key. |
| set(key, value) | System |
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.
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here .
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.
This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.
For more information about our API support guarantees, see here .
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. |