@adaskothebeast/ngxs-signalr-plugin
Version:
Bind server SignalR events to Ngxs store actions.
56 lines (55 loc) • 1.4 kB
TypeScript
import { InjectionToken } from '@angular/core';
import { HttpTransportType, IHttpConnectionOptions, IHubProtocol, ILogger, IRetryPolicy, LogLevel } from '@microsoft/signalr';
export declare const NGXS_SIGNALR_OPTIONS: InjectionToken<unknown>;
export interface SignalROptions {
/**
* URL of the SignalR endpoint.
*/
baseUrl?: string;
/**
* URL of the SignalR endpoint.
*/
url?: string;
/**
* Specifies a specific HTTP transport type.
*/
transportType?: HttpTransportType;
/**
* Http connection options.
*/
httpConnectionOptions?: IHttpConnectionOptions;
/**
* Retry policy implementation
*/
reconnectPolicy?: IRetryPolicy;
/**
* Retry delays
*/
retryDelays?: number[];
/**
* Automatic reconnect
*/
automaticReconnect?: boolean;
/**
* Hub protocol options.
*/
protocol?: IHubProtocol;
/**
* The property name to distinguish this type for the store.
* Default: 'type'
*/
typeKey?: string;
/**
* Logging options
*/
logging?: string | LogLevel | ILogger;
/**
* Keep alive interval in milliseconds.
*/
keepAliveIntervalInMilliseconds?: number;
/**
* Server timeout in milliseconds.
*/
serverTimeoutInMilliseconds?: number;
}
export declare function noop(..._args: unknown[]): () => void;