@aptpod/iscp-ts/lib/node/transport/websocket/connector.d.ts

iSCP 2.0 client library for TypeScript

import type { Connector, Transport } from '../transport';
import { NegotiationParams } from '../negotiation-params';
/**
 * {@link WebSocketConnector}に指定するコンフィグです。
 * @category Connector
 */
export interface WebSocketConnectorConfig {
    /**
     * TLS有効化フラグ。Trueの場合は `wss://${address}${path}` 、Falseの場合は `ws://${address}/${path}` でアクセスを試みます。
     * @default true
     */
    enableTLS?: boolean;
    /**
     * 接続先のaddressに続くパス。
     * @default api/iscp/connect
     */
    path?: string;
}
/**
 * WebSocketのiSCPコネクターです。
 *
 * @todo HTTP_PROXY, HTTPS_PROXY, NO_PROXYの説明を追加する。当環境変数を使用するケースは、Node.js で実行する場合のみ。
 *
 * @category Connector
 */
export declare class WebSocketConnector implements Connector {
    #private;
    constructor(config?: WebSocketConnectorConfig);
    connect(address: string, negotiationParams: NegotiationParams): Promise<Transport>;
}