Interface LockstepClientOptions

interface LockstepClientOptions {
    allowInsecure?: boolean;
    create?: (url: string) => WebSocketLike;
    maxMessageBytes?: number;
    url: string;
    validateInput?: (payload: unknown) => string | boolean;
}

Properties

allowInsecure?: boolean

accept ws:// to a host other than this machine; off by default

create?: (url: string) => WebSocketLike

defaults to the global WebSocket; inject a fake in tests, or ws's own client in Node

maxMessageBytes?: number

largest server message accepted, in bytes; defaults to 1 MB

url: string

validateInput?: (payload: unknown) => string | boolean

Optional client-side command contract. Returning a string rejects with that reason.