camstreamerlib/types/internal/types.d.ts

Helper library for CamStreamer ACAP applications.

export type Options = {
    ip?: string;
    port?: number;
    user?: string;
    pass?: string;
    tls?: boolean;
    tlsInsecure?: boolean;
};
export type HttpOptions = Options & {
    keepAlive?: boolean;
};
export type TParameters = Record<string, string | number | boolean | null | undefined>;
export type TResponse = {
    json: () => Promise<any>;
    text: () => Promise<string>;
    blob: () => Promise<unknown>;
    status: number;
    ok: boolean;
};
export type TGetParams = {
    path: string;
    parameters?: TParameters;
    headers?: Record<string, string>;
    timeout?: number;
};
export type TPostParams<Data> = {
    path: string;
    data: string | Data;
    parameters?: TParameters;
    headers?: Record<string, string>;
    timeout?: number;
};
export interface IClient<TRes extends TResponse, Data> {
    get: (params: TGetParams) => Promise<TRes>;
    post: (params: TPostParams<Data>) => Promise<TRes>;
}
export type TBlobResponse<Client extends IClient<TResponse, any>> = Awaited<ReturnType<Awaited<ReturnType<Client['get']>>['blob']>>;
export interface IWsClient {
    onMessage: null | ((data: ArrayBuffer | string) => void);
    onOpen: () => void;
    onClose: () => void;
    onError: (error: Error) => void;
    send: (data: ArrayBuffer | string) => void;
    reconnect: () => void;
    destroy: () => void;
}