@types/xsockets
TypeScript icon, indicating that this package has built-in type declarations

3.0.31 • Public • Published

Installation

npm install --save @types/xsockets

Summary

This package contains type definitions for xsockets (http://xsockets.net/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/xsockets.

index.d.ts

declare namespace XSockets {
    export class WebSocket {
        id: string;
        constructor(url: string, subprotocol?: string, settings?: any);
        on(event: string, handler: (data: any) => void, confirmation?: (arg: ConfirmationArgument) => void): void;
        one(event: string, handler: (data: any) => void, confirmation?: (arg: ConfirmationArgument) => void): void;
        many(
            event: string,
            times: number,
            handler: (data: any) => void,
            confirmation?: (arg: ConfirmationArgument) => void,
        ): void;
        unbind(event: string): void;
        publish(topic: string, data: any): void;
    }
    export interface ConfirmationArgument {
        event: string;
    }
    export namespace Events {
        export var close: string;
        export var onBlob: string;
        export var onError: string;
        export namespace bindings {
            export var completed: string;
        }
        export var open: string;
        export namespace pubSub {
            export var subscribe: string;
            export var unsubscribe: string;
        }
        export namespace storage {
            export var get: string;
            export var getAll: string;
            export var remove: string;
            export var set: string;
        }
    }
}

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: none

Credits

These definitions were written by Jeffery Grajkowski.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/xsockets

Weekly Downloads

1

Version

3.0.31

License

MIT

Unpacked Size

5.17 kB

Total Files

5

Last publish

Collaborators

  • types