Intermact API Reference / @intermact/core / Registry
Class: Registry<K, V>
Defined in: packages/core/src/extend/registry.ts:27
A keyed collection of extension descriptors. Generic over the key type K (almost always string) and the value type V.
Type Parameters
K
K
V
V
Constructors
Constructor
new Registry<
K,V>():Registry<K,V>
Returns
Registry<K, V>
Accessors
size
Get Signature
get size():
number
Defined in: packages/core/src/extend/registry.ts:93
Number of registered entries.
Returns
number
Methods
clear()
clear():
void
Defined in: packages/core/src/extend/registry.ts:98
Drop every entry (mainly for test isolation).
Returns
void
entriesList()
entriesList(): [
K,V][]
Defined in: packages/core/src/extend/registry.ts:88
All [key, value] pairs (insertion order).
Returns
[K, V][]
get()
get(
key):V|undefined
Defined in: packages/core/src/extend/registry.ts:47
Look up an entry; returns undefined when absent.
Parameters
key
K
Returns
V | undefined
has()
has(
key):boolean
Defined in: packages/core/src/extend/registry.ts:68
Whether an entry exists for key.
Parameters
key
K
Returns
boolean
keys()
keys():
K[]
Defined in: packages/core/src/extend/registry.ts:78
All registered keys (insertion order).
Returns
K[]
register()
register(
key,value,options?):this
Defined in: packages/core/src/extend/registry.ts:34
Register value under key. Throws plugin-error if the key already exists unless { override: true } is passed.
Parameters
key
K
value
V
options?
RegisterOptions = {}
Returns
this
require()
require(
key):V
Defined in: packages/core/src/extend/registry.ts:55
Look up an entry, throwing plugin-error when absent. Use at dispatch sites that require the entry to exist.
Parameters
key
K
Returns
V
unregister()
unregister(
key):boolean
Defined in: packages/core/src/extend/registry.ts:73
Remove an entry; returns whether one was present.
Parameters
key
K
Returns
boolean
values()
values():
V[]
Defined in: packages/core/src/extend/registry.ts:83
All registered values (insertion order).
Returns
V[]