@litert/televoke/lib/transporters/websocket/WebSocket.Client.d.ts

A simple RPC service framework.

/**
 * Copyright 2025 Angus.Fenying <fenying@litert.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as LibWS from '@litert/websocket';
import type * as NodeHttp from 'node:http';
import type * as dT from '../Transporter.decl';
export interface IWsConnector extends dT.IConnector {
    /**
     * Setup the custom headers for websocket negotiation on each connection.
     *
     * **WARNING:**
     * **In browser environment, the Websocket class cannot send custom headers.**
     * **Considering the compatibility, custom headers in Websocket protocol are not recommended to use.**
     * ***Don't use this feature unless you don't care about the compatibility in browser environment.***
     *
     * @param newHeaders    The new headers to set.
     * @param append        Whether to append the new headers to existing headers, or replace all headers. [Default: true]
     */
    setHeaders(newHeaders: NodeHttp.OutgoingHttpHeaders, append?: boolean): void;
}
export declare function createWsConnector(opts: LibWS.IWsConnectOptions): IWsConnector;
export declare function createWssConnector(opts: LibWS.IWssConnectOptions): IWsConnector;
//# sourceMappingURL=WebSocket.Client.d.ts.map