Module: data

Functions

subscribe

▸ subscribe(id, callback, options?): unknown

Methods used by extension developers to get and update data

Parameters

Name	Type
id	string
callback	(data: { id: string ; data: unknown }) => void | Promise<unknown>
options?	Object
options.selectors?	string[]

Returns

unknown

Defined in

src/data/index.ts:9

---

get

▸ get(messageOptions): Promise<unknown>

Parameters

Name	Type
messageOptions	MessageDataType<"datasetGet">

Returns

Promise<unknown>

Defined in

src/channel.ts:462

---

update

▸ update(messageOptions): Promise<unknown>

Parameters

Name	Type
messageOptions	MessageDataType<"datasetUpdate">

Returns

Promise<unknown>

Defined in

src/channel.ts:462

---

register

▸ register(data): Promise<void>

Internal methods used by the administration

Parameters

Name	Type
data	Omit<datasetRegistration, "responseType">

Returns

Promise<void>

Defined in

src/channel.ts:582

---

updateSubscriber

▸ updateSubscriber(id, callback, options?): unknown

Parameters

Name	Type
id	string
callback	(data: { id: string ; data: unknown }) => void | Promise<unknown>
options?	Object
options.selectors?	string[]

Returns

unknown

Defined in

src/data/index.ts:9

---

handleGet

▸ handleGet(method): () => void

Parameters

Name	Type
method	(data: MessageDataType<"datasetGet">, additionalInformation: { _event_: MessageEvent<string> }) => unknown

Returns

fn

▸ (): void

Returns

void

The return value is a cancel function to stop listening to the events

Defined in

src/channel.ts:480

Type Aliases

datasetRegistration

Ƭ datasetRegistration: Object

Type declaration

Name	Type
responseType	{ id: string ; data: unknown }
responseType.id	string
responseType.data	unknown
id	string
data	unknown

Defined in

src/data/index.ts:63

---

datasetSubscribe

Ƭ datasetSubscribe: Object

Type declaration

Name	Type
responseType	unknown
id	string
data	unknown
selectors?	string[]

Defined in

src/data/index.ts:74

---

datasetSubscribeRegistration

Ƭ datasetSubscribeRegistration: Object

Will be used for giving the admin the information that a window wants to subscribe to a dataset

Type declaration

Name	Type
responseType	unknown
id	string
selectors?	string[]

Defined in

src/data/index.ts:88

---

datasetUpdate

Ƭ datasetUpdate: Object

Type declaration

Name	Type
responseType	unknown
id	string
data	unknown

Defined in

src/data/index.ts:96

---

datasetGet

Ƭ datasetGet: Object

Type declaration

Name	Type
responseType	unknown
id	string
data?	unknown
selectors?	string[]

Defined in

src/data/index.ts:104

Variables

Classes

• Const Classes: Object

Type declaration

Name	Type
Criteria	typeof default
Entity	typeof default
EntityCollection	typeof default

Defined in

src/data/index.ts:114

References

repository

Renames and re-exports default