Function: createSignalBuilder()

function createSignalBuilder<TPayload>(id, schema?): SignalPayloadBuilder<TPayload>;

Defined in: builders/create-signal-builder.ts:19

Creates a copy-on-write immutable ConfigurableSignalBuilder for P.signal(id).

Defaults the signal payload schema to z.unknown() when schema is omitted and returns a frozen builder supporting .payload(nextSchema) and .toAST().

Type Parameters

Type Parameter	Default type	Description
TPayload	unknown	Signal payload type.

Parameters

Parameter	Type	Description
id	string	Unique signal identifier.
schema?	ZodType<TPayload, unknown, $ZodTypeInternals<TPayload, unknown>>	Optional initial Zod payload schema (defaults to z.unknown()).

Returns

SignalPayloadBuilder<TPayload>

Frozen signal builder instance.