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
packages/admin-sdk/src/data/index.ts:10
get
▸ get(messageOptions): Promise<unknown>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"datasetGet"> |
Returns
Promise<unknown>
Defined in
packages/admin-sdk/src/channel.ts:446
update
▸ update(messageOptions): Promise<unknown>
Parameters
| Name | Type |
|---|---|
messageOptions | MessageDataType<"datasetUpdate"> |
Returns
Promise<unknown>
Defined in
packages/admin-sdk/src/channel.ts:446
register
▸ register(data): Promise<void>
Internal methods used by the administration
Parameters
| Name | Type |
|---|---|
data | Omit<datasetRegistration, "responseType"> |
Returns
Promise<void>
Defined in
packages/admin-sdk/src/channel.ts:566
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
packages/admin-sdk/src/data/index.ts:10
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
packages/admin-sdk/src/channel.ts:464
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
packages/admin-sdk/src/data/index.ts:69
datasetSubscribe
Ƭ datasetSubscribe: Object
Type declaration
| Name | Type |
|---|---|
responseType | unknown |
id | string |
data | unknown |
selectors? | string[] |
Defined in
packages/admin-sdk/src/data/index.ts:80
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
packages/admin-sdk/src/data/index.ts:94
datasetUpdate
Ƭ datasetUpdate: Object
Type declaration
| Name | Type |
|---|---|
responseType | unknown |
id | string |
data | unknown |
Defined in
packages/admin-sdk/src/data/index.ts:102
datasetGet
Ƭ datasetGet: Object
Type declaration
| Name | Type |
|---|---|
responseType | unknown |
id | string |
data? | unknown |
selectors? | string[] |
Defined in
packages/admin-sdk/src/data/index.ts:110
Variables
Classes
• Const Classes: Object
Type declaration
| Name | Type |
|---|---|
Criteria | typeof default |
Entity | typeof default |
EntityCollection | typeof default |
Defined in
packages/admin-sdk/src/data/index.ts:120
References
repository
Renames and re-exports default