86 lines
3.7 KiB
TypeScript
86 lines
3.7 KiB
TypeScript
import { Subject, AnonymousSubject } from '../../Subject';
|
|
import { Subscriber } from '../../Subscriber';
|
|
import { Observable } from '../../Observable';
|
|
import { Subscription } from '../../Subscription';
|
|
import { Operator } from '../../Operator';
|
|
import { Observer, NextObserver } from '../../types';
|
|
export interface WebSocketSubjectConfig<T> {
|
|
/** The url of the socket server to connect to */
|
|
url: string;
|
|
/** The protocol to use to connect */
|
|
protocol?: string | Array<string>;
|
|
/** @deprecated use {@link deserializer} */
|
|
resultSelector?: (e: MessageEvent) => T;
|
|
/**
|
|
* A serializer used to create messages from passed values before the
|
|
* messages are sent to the server. Defaults to JSON.stringify.
|
|
*/
|
|
serializer?: (value: T) => WebSocketMessage;
|
|
/**
|
|
* A deserializer used for messages arriving on the socket from the
|
|
* server. Defaults to JSON.parse.
|
|
*/
|
|
deserializer?: (e: MessageEvent) => T;
|
|
/**
|
|
* An Observer that watches when open events occur on the underlying web socket.
|
|
*/
|
|
openObserver?: NextObserver<Event>;
|
|
/**
|
|
* An Observer than watches when close events occur on the underlying webSocket
|
|
*/
|
|
closeObserver?: NextObserver<CloseEvent>;
|
|
/**
|
|
* An Observer that watches when a close is about to occur due to
|
|
* unsubscription.
|
|
*/
|
|
closingObserver?: NextObserver<void>;
|
|
/**
|
|
* A WebSocket constructor to use. This is useful for situations like using a
|
|
* WebSocket impl in Node (WebSocket is a DOM API), or for mocking a WebSocket
|
|
* for testing purposes
|
|
*/
|
|
WebSocketCtor?: {
|
|
new (url: string, protocols?: string | string[]): WebSocket;
|
|
};
|
|
/** Sets the `binaryType` property of the underlying WebSocket. */
|
|
binaryType?: 'blob' | 'arraybuffer';
|
|
}
|
|
export declare type WebSocketMessage = string | ArrayBuffer | Blob | ArrayBufferView;
|
|
/**
|
|
* We need this JSDoc comment for affecting ESDoc.
|
|
* @extends {Ignored}
|
|
* @hide true
|
|
*/
|
|
export declare class WebSocketSubject<T> extends AnonymousSubject<T> {
|
|
private _config;
|
|
/** @deprecated This is an internal implementation detail, do not use. */
|
|
_output: Subject<T>;
|
|
private _socket;
|
|
constructor(urlConfigOrSource: string | WebSocketSubjectConfig<T> | Observable<T>, destination?: Observer<T>);
|
|
lift<R>(operator: Operator<T, R>): WebSocketSubject<R>;
|
|
private _resetState;
|
|
/**
|
|
* Creates an {@link Observable}, that when subscribed to, sends a message,
|
|
* defined by the `subMsg` function, to the server over the socket to begin a
|
|
* subscription to data over that socket. Once data arrives, the
|
|
* `messageFilter` argument will be used to select the appropriate data for
|
|
* the resulting Observable. When teardown occurs, either due to
|
|
* unsubscription, completion or error, a message defined by the `unsubMsg`
|
|
* argument will be send to the server over the WebSocketSubject.
|
|
*
|
|
* @param subMsg A function to generate the subscription message to be sent to
|
|
* the server. This will still be processed by the serializer in the
|
|
* WebSocketSubject's config. (Which defaults to JSON serialization)
|
|
* @param unsubMsg A function to generate the unsubscription message to be
|
|
* sent to the server at teardown. This will still be processed by the
|
|
* serializer in the WebSocketSubject's config.
|
|
* @param messageFilter A predicate for selecting the appropriate messages
|
|
* from the server for the output stream.
|
|
*/
|
|
multiplex(subMsg: () => any, unsubMsg: () => any, messageFilter: (value: T) => boolean): Observable<any>;
|
|
private _connectSocket;
|
|
/** @deprecated This is an internal implementation detail, do not use. */
|
|
_subscribe(subscriber: Subscriber<T>): Subscription;
|
|
unsubscribe(): void;
|
|
}
|