GraphReFlyTS

API Reference

eventMessage()

Creates an event message.

Import

import { eventMessage } from "@graphrefly/ts/messaging";

Signature

function eventMessage(
	type: string,
	payload: T,
	opts: EventMessageOptions,
): EventMessage<T>

Parameters

ParameterTypeDescription
typestringtype value used by the helper.
payloadTPayload to lower or wrap.
optsEventMessageOptionsOptions that configure the helper.

Returns

The event message result.

Example

import { eventMessage } from "@graphrefly/ts/messaging";

Source

packages/ts/src/messaging/event-message.ts