Directus / @directus/sdk / realtime / SubscriptionOutput

Type Alias: SubscriptionOutput<Schema, Collection, TQuery, Events, TItem> ​

SubscriptionOutput<Schema, Collection, TQuery, Events, TItem>: object & { [Event in Events]: { data: SubscriptionPayload<TItem>[Event]; event: Event } }[Events] | { error: { code: string; message: string; }; event: "error"; }

Defined in: realtime/types.ts:71

Type declaration ​

type ​

type: "subscription"

uid? ​

optional uid: string

Type Parameters ​

• Schema

• Collection extends keyof Schema

• TQuery extends Query<Schema, Schema[Collection]> | undefined

• Events extends SubscriptionEvents

• TItem = TQuery extends Query<Schema, Schema[Collection]> ? ApplyQueryFields<Schema, CollectionType<Schema, Collection>, TQuery["fields"]> : Partial<Schema[Collection]>