@folklore/socket 0.4.29 → 0.4.32

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+import { EventEmitter } from '@folklore/events';
+import * as react from 'react';
+import { ReactNode, JSX } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+interface SocketAdapterOptions {
+    [key: string]: unknown;
+}
+type SocketAdapterEvents = {
+    ready?: void;
+    start?: void;
+    started?: void;
+    stop?: number;
+    message?: unknown;
+};
+interface SocketAdapter extends EventEmitter<SocketAdapterEvents> {
+    destroy: () => void;
+    start: () => void;
+    stop: () => void;
+    send: (data: unknown) => void;
+    updateChannels: (channels: string[] | string) => void;
+}
+interface SocketAdapterContructor {
+    new (options?: SocketAdapterOptions): SocketAdapter;
+}
+
+type SocketEvents = {
+    ready: void;
+    start: void;
+    started: void;
+    stop: void;
+    message: unknown;
+};
+declare class Socket extends EventEmitter<SocketEvents> {
+    static adapters: Record<string, SocketAdapterContructor>;
+    options: {
+        adapter: string | SocketAdapterContructor | null;
+        host: string | null;
+        namespace: string | null;
+        uuid: string | null;
+        publishKey: string | null;
+        subscribeKey: string | null;
+        secretKey: string | null;
+        channels: string[];
+        [key: string]: unknown;
+    };
+    adapter: SocketAdapter | null;
+    channels: string[];
+    shouldStart: boolean;
+    started: boolean;
+    starting: boolean;
+    ready: boolean;
+    static getAdapters(): Record<string, SocketAdapterContructor>;
+    static getAdapter(adapter: any): SocketAdapterContructor;
+    static addAdapter(name: any, adapter: any): typeof Socket;
+    static setAdapters(adapters: any): typeof Socket;
+    constructor(opts: any);
+    onAdapterReady(): void;
+    onAdapterStart(): void;
+    onAdapterStarted(): void;
+    onAdapterStop(): void;
+    onAdapterMessage(message: unknown): void;
+    getChannelWithoutNamespace(name: any): any;
+    getChannelWithNamespace(name: any): string;
+    setChannels(channels: any): void;
+    addChannel(channel: any): void;
+    addChannels(channels: any): void;
+    removeChannel(channel: any): void;
+    removeChannels(channels: any): void;
+    updateChannels(channels: any): void;
+    hasChannel(channel: any): boolean;
+    getChannels(): any[];
+    init(): void;
+    destroy(): void;
+    restart(): void;
+    start(): void;
+    stop(): void;
+    send(data: any, channel: any): void | Promise<never>;
+    isStarted(): boolean;
+}
+
+type SocketContextType = {
+    socket: Socket | null;
+    subscribe: (channels: string[] | string) => void;
+    unsubscribe: (channels: string[] | string) => void;
+    channels?: string[];
+};
+declare const SocketContext: react.Context<SocketContextType>;
+
+type SocketContainerProps = {
+    children?: ReactNode;
+    socket?: Socket | null;
+    autoStart?: boolean;
+    adapter?: string | null;
+    host?: string | null;
+    namespace?: string | null;
+    uuid?: string | null;
+    publishKey?: string | null;
+    subscribeKey?: string | null;
+    secretKey?: string | null;
+    channels?: string[];
+    [key: string]: unknown;
+};
+declare function SocketContainer({ children, socket, autoStart, adapter, host, namespace, uuid, publishKey, subscribeKey, secretKey, channels: initialChannels, ...props }: SocketContainerProps): JSX.Element;
+
+declare const withSocket: (WrappedComponent: any) => {
+    (props: any): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+interface UseSocketOptions {
+    socket?: Socket;
+    onMessage?: (...args: unknown[]) => void;
+    keepAlive?: boolean;
+}
+declare function useSocket(channelNames?: string | string[] | null, opts?: UseSocketOptions): {
+    socket: Socket;
+    started: boolean;
+    subscribe: (channels: string[] | string) => void;
+    unsubscribe: (channels: string[] | string) => void;
+};
+
+type debugCreator = (namespace: string) => debug;
+type debug = (...args: unknown[]) => void;
+declare let debug: debug;
+declare function setDebug(newDebug: debugCreator | string): void;
+
+export { Socket, SocketContainer, SocketContext, debug, Socket as default, setDebug, useSocket, withSocket };
+export type { SocketAdapter, SocketAdapterContructor, SocketAdapterEvents, SocketAdapterOptions };