Event
Constructors
Signature
declare function make<
Tag extends string,
Payload extends Any = Void,
Success extends Any = Void,
Error extends All = Never,
>(options: {
readonly error?: Error;
readonly payload?: Payload;
readonly primaryKey: (payload: Type<Payload>) => string;
readonly success?: Success;
readonly tag: Tag;
}): Event<Tag, Payload, Success, Error>;Guards
Models
Signature
interface Event<
out Tag extends string,
in out Payload extends Schema.Schema.Any = typeof Schema.Void,
in out Success extends Schema.Schema.Any = typeof Schema.Void,
in out Error extends Schema.Schema.All = typeof Schema.Never,
> {
readonly [TypeId]: typeof TypeId;
readonly error: Error;
readonly payload: Payload;
readonly payloadMsgPack: schema<Payload>;
readonly primaryKey: (payload: Type<Payload>) => string;
readonly success: Success;
readonly tag: Tag;
}EventHandler interface
Added in v1.0.0
Source
Signature
interface EventHandler<in out Tag extends string> {
readonly _: typeof _;
readonly tag: Tag;
}
Represents an event in an EventLog.