@laravel/echo-react/dist/index.d.ts

React hooks for seamless integration with Laravel Echo.

import { BroadcastDriver } from 'laravel-echo';
import { Broadcaster } from 'laravel-echo';
import { default as default_2 } from 'laravel-echo';
import { EchoOptions } from 'laravel-echo';

declare type BroadcastNotification<TPayload> = TPayload & {
    id: string;
    type: string;
};

declare type Channel = {
    name: string;
    id: string;
    visibility: "private" | "public" | "presence";
};

declare type ChannelReturnType<T extends BroadcastDriver, V extends Channel["visibility"]> = V extends "presence" ? Broadcaster[T]["presence"] : V extends "private" ? Broadcaster[T]["private"] : Broadcaster[T]["public"];

/**
 * Configure the Echo instance with sensible defaults.
 *
 * @link https://laravel.com/docs/broadcasting#client-side-installation
 */
export declare const configureEcho: <T extends BroadcastDriver>(config: EchoOptions<T>) => void;

export declare const echo: <T extends BroadcastDriver>() => default_2<T>;

export declare const echoIsConfigured: () => boolean;

declare type ModelEvent = "Retrieved" | "Creating" | "Created" | "Updating" | "Updated" | "Saving" | "Saved" | "Deleting" | "Deleted" | "Trashed" | "ForceDeleting" | "ForceDeleted" | "Restoring" | "Restored" | "Replicating";

declare type ModelEvents<T extends string> = `.${ModelName<T>}${ModelEvent}` | `${ModelName<T>}${ModelEvent}`;

declare type ModelName<T extends string> = T extends `${infer _}.${infer U}` ? ModelName<U> : T;

declare type ModelPayload<T> = {
    model: T;
    connection: string | null;
    queue: string | null;
    afterCommit: boolean;
};

export declare const useEcho: <TPayload, TDriver extends BroadcastDriver = BroadcastDriver, TVisibility extends Channel["visibility"] = "private">(channelName: string, event?: string | string[], callback?: (payload: TPayload) => void, dependencies?: any[], visibility?: TVisibility) => {
    /**
     * Leave the channel
     */
    leaveChannel: (leaveAll?: boolean) => void;
    /**
     * Leave the channel and also its associated private and presence channels
     */
    leave: () => void;
    /**
     * Stop listening for event(s) without leaving the channel
     */
    stopListening: () => void;
    /**
     * Listen for event(s)
     */
    listen: () => void;
    /**
     * Channel instance
     */
    channel: () => ChannelReturnType<TDriver, TVisibility>;
};

export declare const useEchoModel: <TPayload, TModel extends string, TDriver extends BroadcastDriver = BroadcastDriver>(model: TModel, identifier: string | number, event?: ModelEvents<TModel> | ModelEvents<TModel>[], callback?: (payload: ModelPayload<TPayload>) => void, dependencies?: any[]) => {
    /**
     * Leave the channel
     */
    leaveChannel: (leaveAll?: boolean) => void;
    /**
     * Leave the channel and also its associated private and presence channels
     */
    leave: () => void;
    /**
     * Stop listening for event(s) without leaving the channel
     */
    stopListening: () => void;
    /**
     * Listen for event(s)
     */
    listen: () => void;
    /**
     * Channel instance
     */
    channel: () => Broadcaster[TDriver]["private"];
};

export declare const useEchoNotification: <TPayload, TDriver extends BroadcastDriver = BroadcastDriver>(channelName: string, callback?: (payload: BroadcastNotification<TPayload>) => void, event?: string | string[], dependencies?: any[]) => {
    /**
     * Stop listening for notification events
     */
    stopListening: () => void;
    /**
     * Listen for notification events
     */
    listen: () => void;
    /**
     * Leave the channel
     */
    leaveChannel: (leaveAll?: boolean) => void;
    /**
     * Leave the channel and also its associated private and presence channels
     */
    leave: () => void;
    /**
     * Channel instance
     */
    channel: () => Broadcaster[TDriver]["private"];
};

export declare const useEchoPresence: <TPayload, TDriver extends BroadcastDriver = BroadcastDriver>(channelName: string, event?: string | string[], callback?: (payload: TPayload) => void, dependencies?: any[]) => {
    /**
     * Leave the channel
     */
    leaveChannel: (leaveAll?: boolean) => void;
    /**
     * Leave the channel and also its associated private and presence channels
     */
    leave: () => void;
    /**
     * Stop listening for event(s) without leaving the channel
     */
    stopListening: () => void;
    /**
     * Listen for event(s)
     */
    listen: () => void;
    /**
     * Channel instance
     */
    channel: () => Broadcaster[TDriver]["presence"];
};

export declare const useEchoPublic: <TPayload, TDriver extends BroadcastDriver = BroadcastDriver>(channelName: string, event?: string | string[], callback?: (payload: TPayload) => void, dependencies?: any[]) => {
    /**
     * Leave the channel
     */
    leaveChannel: (leaveAll?: boolean) => void;
    /**
     * Leave the channel and also its associated private and presence channels
     */
    leave: () => void;
    /**
     * Stop listening for event(s) without leaving the channel
     */
    stopListening: () => void;
    /**
     * Listen for event(s)
     */
    listen: () => void;
    /**
     * Channel instance
     */
    channel: () => Broadcaster[TDriver]["public"];
};

export { }