UNPKG

@directus/api

Version:

Directus is a real-time API and App dashboard for managing SQL database content

directus.io

directus/directus

44 lines (43 loc) • 2.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import type { Accountability, SchemaOverview } from '@directus/types'; import type { WebSocketEvent } from '../messages.js'; import type { Subscription } from '../types.js'; type PSubscription = Omit<Subscription, 'client'>; /** * Get items from a collection using the appropriate service * * @param subscription Subscription object * @param accountability Accountability object * @param schema Schema object * @param event Event data * @returns the fetched items */ export declare function getPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<Record<string, any>>; /** * Get collection items * * @param accountability Accountability object * @param schema Schema object * @param event Event data * @returns the fetched collection data */ export declare function getCollectionPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | import("../../types/collection.js").Collection | (string | number)[] | import("../../types/collection.js").Collection[]>; /** * Get fields items * * @param accountability Accountability object * @param schema Schema object * @param event Event data * @returns the fetched field data */ export declare function getFieldsPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | Record<string, any> | import("@directus/types").Field[] | (string | number)[]>; /** * Get items from a collection using the appropriate service * * @param subscription Subscription object * @param accountability Accountability object * @param schema Schema object * @param event Event data * @returns the fetched data */ export declare function getItemsPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | import("@directus/types").Item | (string | number)[] | import("@directus/types").Item[]>; export {};