Appearance

On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / realtime / SubscriptionOutput

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

SubscriptionOutput<Schema, Collection, TQuery, Events, TItem>: Object & { [Event in Events]: Object }[Events] | Object

Type declaration ​

type ​

type: "subscription"

uid? ​

optional uid: string

Type parameters ​

• Schema extends object

• 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]>

Source ​

realtime/types.ts:71