Listener
Import
import { Listener } from "@hyper-fetch/sockets"
Source
Package
Parameters
class Listener<Response, Topic, Socket, HasParams> {
constructor(socket: Socket, listenerOptions: ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>) {};
topic: Topic;
socket: Socket;
params: ParamsType;
options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>;
listenerOptions: ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>;
listen() => ListenType<Listener<Response, Topic, Socket, HasParams>, Socket>;
clone<NewHasParams>(options?: ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket>) => Listener<Response, Topic, Socket, NewHasParams>;
setOptions(options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>) => Listener<Response, Topic, Socket, HasParams>;
setParams(params: ExtractUrlParams<Topic>) => Listener<Response, Topic, Socket, true>;
}
Parameters
| Name | Type | Description |
|---|---|---|
| socket | | |
| listenerOptions | |
Properties
Methods
clone()
Source
Preview
clone<NewHasParams>(options: ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket>)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| options | |
Returns
Listener<Response, Topic, Socket, NewHasParams>
setOptions()
Source
Preview
setOptions(options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| options | |
Returns
Listener<Response, Topic, Socket, HasParams>
setParams()
Source
Preview
setParams(params: ExtractUrlParams<Topic>)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| params | |
Returns
Listener<Response, Topic, Socket, true>