@types/actioncable

Installation

npm install --save @types/actioncable

Summary

This package contains type definitions for actioncable (https://github.com/rails/rails/tree/master/actioncable/app/assets/javascripts).

Details

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

index.d.ts

declare namespace ActionCable {
    interface Channel {
        unsubscribe(): void;
        perform(action: string, data: {}): void;
        send(data: any): boolean;
    }

    interface Subscriptions {
        create<T extends CreateMixin>(
            channel: string | ChannelNameWithParams,
            obj?: T & ThisType<Channel>,
        ): Channel & T;
    }

    interface Cable {
        subscriptions: Subscriptions;
        send(data: any): void;
        connect(): void;
        disconnect(): void;
        ensureActiveConnection(): void;
    }

    interface CreateMixin {
        connected?(): void;
        disconnected?(): void;
        received?(obj: any): void;
        [key: string]: any;
    }

    interface ChannelNameWithParams {
        channel: string;
        [key: string]: any;
    }

    function createConsumer(): Cable;
    function createConsumer(url: string): Cable;
}

declare interface AppInterface {
    cable?: ActionCable.Cable | undefined;
    network?: ActionCable.Channel | undefined;
}

declare var App: AppInterface;

declare module "actioncable" {
    export = ActionCable;
}

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:04 GMT
• Dependencies: none

Credits

These definitions were written by Vincent Zhu, Jared Szechy, and David Mejorado.