Class MqlSubscriptionApi

Index

Methods

_clearAllForTesting _drainScheduledForTesting _getDependencyIndexEntryCountForTesting _getRegistrySizeForTesting cancelAllForInteractive fireFieldChange handleQuery handleSubscribe handleUnsubscribe projectFields

Methods

`Static`_clearAllForTesting

_clearAllForTesting(): void
Returns void
- Defined in packages/server/src/mud/api/mql-subscription.ts:302

`Static`_drainScheduledForTesting

_drainScheduledForTesting(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/mud/api/mql-subscription.ts:297

`Static`_getDependencyIndexEntryCountForTesting

_getDependencyIndexEntryCountForTesting(): number
Returns number
- Defined in packages/server/src/mud/api/mql-subscription.ts:292

`Static`_getRegistrySizeForTesting

_getRegistrySizeForTesting(): number
Returns number
- Defined in packages/server/src/mud/api/mql-subscription.ts:287

`Static`cancelAllForInteractive

cancelAllForInteractive(interactive: default): void
Parameters
- interactive: default
Returns void
- Defined in packages/server/src/mud/api/mql-subscription.ts:281

`Static`fireFieldChange

fireFieldChange<T>(target: object, field: string, oldValue: T, newValue: T): T
Compress the noop-check + capture + assign + fire boilerplate at every fact-mixin setter into one call.

Lives on MqlSubscriptionApi rather than next to FieldChangedEvent so the substrate owns its own helpers — the event class stays a pure DTO. Stateless: MqlSubscriptionApi.fireFieldChange does not touch any Registry state.
Type Parameters
- T
Parameters
- target: object
- field: string
- oldValue: T
- newValue: T
Returns T
- Defined in packages/server/src/mud/api/mql-subscription.ts:209

`Static`handleQuery

handleQuery(
    req: Omit<QueryRequest, "query" | "cardinality"> & Partial<
        Pick<QueryRequest, "query" | "cardinality">,
    >,
): void
Parameters
- req: Omit<QueryRequest, "query" | "cardinality"> & Partial<
  Pick<QueryRequest, "query" | "cardinality">,
  >
Returns void
- Defined in packages/server/src/mud/api/mql-subscription.ts:267

`Static`handleSubscribe

handleSubscribe(req: SubscribeRequest): void
Parameters
- req: SubscribeRequest
Returns void
- Defined in packages/server/src/mud/api/mql-subscription.ts:263

`Static`handleUnsubscribe

handleUnsubscribe(interactive: default, subscriptionId: string): void
Parameters
- interactive: default
- subscriptionId: string
Returns void
- Defined in packages/server/src/mud/api/mql-subscription.ts:274

`Static`projectFields

projectFields(
    stuff: Stuff,
    fieldNames: FieldSet,
    viewer: Stuff & Sensor,
): Record<string, unknown>
Project the named field-set into a flat record. Iterates fieldNames in order, looks up each name in the stuff's subscribable-field descriptors, invokes read(stuff, viewer), and omits fields whose descriptor is missing OR whose read returns undefined. Stateless.
Parameters
- stuff: Stuff
- fieldNames: FieldSet
- viewer: Stuff & Sensor
Returns Record<string, unknown>
- Defined in packages/server/src/mud/api/mql-subscription.ts:236