IFClite TypeScript API
    Preparing search index...

    Interface KickEndpointOptions

    interface KickEndpointOptions {
        allowOrigin?: string;
        isRevoked?: (jti: string) => boolean | Promise<boolean>;
        kick: (roomId: string, clientId: number) => boolean | Promise<boolean>;
        maxBodyBytes?: number;
        now?: () => number;
        secret: SecretResolver;
    }
    Index
    allowOrigin? isRevoked? kick maxBodyBytes? now? secret
    allowOrigin?: string
    isRevoked?: (jti: string) => boolean | Promise<boolean>

    Deny-list check — a bearer whose own jti was revoked (e.g. an admin who was themselves kicked) must not be able to keep kicking peers.

    kick: (roomId: string, clientId: number) => boolean | Promise<boolean>

    Force-disconnect a peer by awareness clientId; returns whether one matched.

    maxBodyBytes?: number
    now?: () => number
    secret: SecretResolver

    Secret used to verify the admin bearer token.

    Settings
    Member Visibility

    On This Page
    Properties