Skip to main content

ReadonlyMapInlined Interface

Copy of TypeScript's ReadonlyMap, but with TreeNodeFromImplicitAllowedTypesUnsafe<T> inlined into it. Using this instead of ReadonlyMap in TreeMapNodeUnsafe is necessary to make recursive map schema not generate compile errors in the d.ts files when exported.

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 ReadonlyMapInlined<K, T extends Unenforced<ImplicitAllowedTypes>>

Type Parameters​

Parameter Constraint Description
K
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.

Properties​

Property Modifiers Type Description
size readonly number

Methods​

Method Return Type Description
[Symbol.iterator]() IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]> Returns an iterable of entries in the map.
entries() IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]> Returns an iterable of key, value pairs for every entry in the map.
forEach(callbackfn, thisArg) void
get(key) TreeNodeFromImplicitAllowedTypesUnsafe<T> | undefined
has(key) boolean
keys() IterableIterator<K> Returns an iterable of keys in the map
values() IterableIterator<TreeNodeFromImplicitAllowedTypesUnsafe<T>> Returns an iterable of values in the map

Property Details​

size​

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​

readonly size: number;

Type: number

Method Details​

[Symbol.iterator]​

Returns an iterable of entries in the map.

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​

[Symbol.iterator](): IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]>;

Returns​

Return type: IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]>

entries​

Returns an iterable of key, value pairs for every entry in the map.

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​

entries(): IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]>;

Returns​

Return type: IterableIterator<[K, TreeNodeFromImplicitAllowedTypesUnsafe<T>]>

forEach​

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​

forEach(callbackfn: (value: TreeNodeFromImplicitAllowedTypesUnsafe<T>, key: K, map: ReadonlyMap<K, TreeNodeFromImplicitAllowedTypesUnsafe<T>>) => void, thisArg?: any): void;

Parameters​

Parameter Modifiers Type Description
callbackfn (value: TreeNodeFromImplicitAllowedTypesUnsafe<T>, key: K, map: ReadonlyMap<K, TreeNodeFromImplicitAllowedTypesUnsafe<T>>) => void
thisArg optional any

get​

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​

get(key: K): TreeNodeFromImplicitAllowedTypesUnsafe<T> | undefined;

Parameters​

Parameter Type Description
key K

Returns​

Return type: TreeNodeFromImplicitAllowedTypesUnsafe<T> | undefined

has​

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​

has(key: K): boolean;

Parameters​

Parameter Type Description
key K

Returns​

Return type: boolean

keys​

Returns an iterable of keys in the map

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​

keys(): IterableIterator<K>;

Returns​

Return type: IterableIterator<K>

values​

Returns an iterable of values in the map

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​

values(): IterableIterator<TreeNodeFromImplicitAllowedTypesUnsafe<T>>;

Returns​

Return type: IterableIterator<TreeNodeFromImplicitAllowedTypesUnsafe<T>>