@pisell/pisellos
Version:
一个可扩展的前端模块化SDK框架,支持插件系统
62 lines (61 loc) • 1.87 kB
TypeScript
import { Socket } from './socket';
import { SocketOptions, SocketStatus, SocketMessage } from './types';
import { SocketEvents } from './events';
import { SocketMonitor, SocketMonitorOptions, SocketHistoryItem, SocketStatusItem, SocketStats } from './monitor';
import * as components from './components';
/**
* 创建Socket实例
* @param url WebSocket连接URL
* @param options Socket配置选项
*/
export declare function createSocket(url: string, options?: Partial<Omit<SocketOptions, 'url'>>): Socket;
declare const _default: {
/**
* 创建新的Socket实例
*/
create: (url: string, options?: Partial<Omit<SocketOptions, "url">>, key?: string) => Socket;
/**
* 获取指定键的Socket实例
*/
get: (key: string) => Socket | undefined;
/**
* 移除Socket实例
*/
remove: (key: string) => boolean;
/**
* 关闭并移除所有Socket实例
*/
closeAll: () => void;
/**
* 检查指定键的Socket是否存在
*/
has: (key: string) => boolean;
/**
* 获取所有Socket标识键
*/
getKeys: () => string[];
/**
* 获取所有Socket实例
*/
getAllSockets: () => Socket[];
/**
* 为指定的Socket启用监控
*/
enableMonitoring: (key: string, options?: SocketMonitorOptions) => SocketMonitor | null;
/**
* 获取指定Socket的监控器
*/
getMonitor: (key: string) => SocketMonitor | null;
/**
* 获取所有Socket的监控信息
*/
getAllMonitors: () => Map<string, SocketMonitor | null>;
/**
* 监控组件
*/
components: typeof components;
};
export default _default;
export { Socket, SocketMonitor };
export type { SocketOptions, SocketMessage, SocketMonitorOptions, SocketHistoryItem, SocketStatusItem, SocketStats };
export { SocketStatus, SocketEvents };