Function: localSubject()

Makaio Framework

---

Makaio Framework / bus-core / localSubject

Function: localSubject()

localSubject<T>(schema): LocalSubjectSchema<T>

Defined in: ../../../packages/bus-core/src/utils/local-schema.ts:42

Create a local-only subject schema wrapper.

Local subjects are never sent to transports (SharedWorker, WebSocket, etc.). Use this for subjects whose payloads contain non-serializable data like React components or functions.

Type Parameters

T

T extends EventSchema | RequestSchema

Parameters

schema

T

The event or request schema to mark as local

Returns

LocalSubjectSchema<T>

A LocalSubjectSchema wrapper

Example

import { localSubject } from '@makaio/bus-core';

const WidgetSchemas = {
  // Local event - contains React component, can't be serialized
  register: localSubject(widgetDefinitionSchema),

  // Local request - response contains functions
  getRenderer: localSubject({
    request: z.object({ widgetId: z.string() }),
    response: z.object({ render: z.function() }),
  }),
};