API reference / @chanx-js/server / core / defineMessage

Function: defineMessage()

Call Signature

function defineMessage<A>(action, options?): MessageDefinition<A, null>;

Defined in: packages/server/src/messages.ts:46

A message with no payload, such as defineMessage('ping').

Type Parameters

Type Parameter
A extends string

Parameters

Parameter	Type
action	A
options?	MessageOptions

Returns

MessageDefinition<A, null>

Call Signature

function defineMessage<A, S>(
   action, 
   payload, 
   options?
): MessageDefinition<A, InferOutput<S>>;

Defined in: packages/server/src/messages.ts:51

A message whose payload any Standard Schema validates: Zod, Valibot, ArkType and others.

Type Parameters

Type Parameter
A extends string
S extends StandardSchemaV1<unknown, unknown>

Parameters

Parameter	Type
action	A
payload	S
options?	MessageOptions

Returns

MessageDefinition<A, InferOutput<S>>