Interface ParticleEventChannelParameters<Payload>

Construction parameters for a bounded typed data channel.

interface ParticleEventChannelParameters<
    Payload extends ParticleEventChannelPayload,
> {
    capacity: number;
    name?: string;
    overflow?: ParticleEventOverflowPolicy;
    schema: Readonly<{ [Name in keyof Payload]: ParticleEventFieldType }>;
}

Type Parameters

Payload extends ParticleEventChannelPayload

Index

Properties

capacity name? overflow? schema

Properties

`Readonly`capacity

capacity: number

`Optional` `Readonly`name

name?: string

`Optional` `Readonly`overflow

overflow?: ParticleEventOverflowPolicy

`Readonly`schema

schema: Readonly<{ [Name in keyof Payload]: ParticleEventFieldType }>