@types/protoo-client

Installation

npm install --save @types/protoo-client

Summary

This package contains type definitions for protoo-client (https://protoojs.org).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/protoo-client.

index.d.ts

import * as http from "http";
import * as retry from "retry";
import * as websocket from "websocket";

export interface ProtooRequest {
    request: true;
    id: number;
    method: string;
    data?: any;
}

export type ProtooResponse =
    | { response: true; id: number; ok: true; data: any }
    | { response: true; id: number; ok: false; errorCode: number; errorReason: string };

export interface ProtooNotification {
    notification: true;
    method: string;
    data?: any;
}

export class WebSocketTransport {
    constructor(
        url: string,
        options?: {
            protocols?: string | string[] | undefined;
            origin?: string | undefined;
            headers?: http.OutgoingHttpHeaders | undefined;
            requestOptions?: object | undefined;
            clientConfig?: websocket.IClientConfig | undefined;
            retry?: retry.OperationOptions | undefined;
        },
    );

    readonly closed: boolean;

    close(): void;

    send(message: any): Promise<void>;
}

export class Peer {
    constructor(transport: WebSocketTransport);

    data: any;

    readonly closed: boolean;
    readonly connected: boolean;

    request(method: string, data?: any): Promise<any>;

    notify(method: string, data?: any): Promise<any>;

    close(): void;

    on(evt: "open" | "disconnected" | "close", handler: () => any): void;

    on(evt: "failed", handler: (currentAttempt: number) => any): void;

    on(
        evt: "request",
        handler: (
            request: ProtooRequest,
            accept: (data?: ProtooResponse) => void,
            reject: (error?: Error | number, errorReason?: string) => void,
        ) => any,
    ): void;

    on(evt: "notification", handler: (notif: ProtooNotification) => any): void;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/retry, @types/websocket

Credits

These definitions were written by Marks Polakovs.