UNPKG

@snail-js/api

Version:

Http Request with Decorators Api, build on axios

31 lines (30 loc) 1.28 kB
import "reflect-metadata"; export declare const EVENT_SOURCE_OPTION_KEY: unique symbol; import { SseOptions } from "../typings"; /** * 将装饰的方法创建为SSE连接 * @param path 路径,要连接到服务端sse端点路径 * @param options 配置选项 * @returns 调用被装饰的方法可获得返回{close,eventSource} */ export declare const Sse: (path?: string, options?: SseOptions) => (target: object) => void; export declare const EVENT_SOURCE_EVENTS_KEY: unique symbol; /** * 将装饰的方法注册为eventSource的对应事件 * @param eventName 事件名称,可选,默认处理message事件 * @param options boolean | AddEventListenerOptions 可选,注册事件选项 * @returns */ export declare const SseEvent: (eventName?: string, options?: boolean | AddEventListenerOptions) => (target: any, propertyKey: string) => void; export declare const EVENT_SOURCE_OPEN_KEY: unique symbol; /** * 将装饰的方法注册为eventSource.onOpen * @returns */ export declare const OnSseOpen: () => (target: any, propertyKey: string) => void; export declare const EVENT_SOURCE_ERROR_KEY: unique symbol; /** * 将装饰的方法注册eventSource.onError * @returns */ export declare const OnSseError: () => (target: any, propertyKey: string) => void;