Interface ChannelDefinition<Name, Params, Events>

Browser-visible channel contract. Authorization belongs in a server binding.

interface ChannelDefinition<
    Name extends string = string,
    Params extends
        StandardSchemaV1<unknown, Record<string, string>> = StandardSchemaV1<
        unknown,
        Record<string, string>,
    >,
    Events extends
        Record<string, StandardSchemaV1> = Record<string, StandardSchemaV1>,
> {
    events: Events;
    kind: "channel";
    name: Name;
    params: Params;
}

Type Parameters

Name extends string = string
Params extends StandardSchemaV1<unknown, Record<string, string>> = StandardSchemaV1<unknown, Record<string, string>>
Events extends Record<string, StandardSchemaV1> = Record<string, StandardSchemaV1>

Index

Properties

events kind name params

Properties

`Readonly`events

events: Events

`Readonly`kind

kind: "channel"

`Readonly`name

name: Name

`Readonly`params

params: Params