Listener

Represents a socket message listener bound to a specific topic. Use it to subscribe to typed messages from WebSocket or Server-Sent Events connections via the socket adapter.

---

Import

import { Listener } from "@hyper-fetch/sockets"

Source

View the source code

Package

@hyper-fetch/sockets

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	Socket
listenerOptions	ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>

Properties

listenerOptions

Source

View the source code

Type

ListenerOptionsType<Topic, ExtractSocketAdapterType<Socket>>

---

options

Source

View the source code

Type

ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>

---

params

Source

View the source code

Type

ParamsType

---

socket

Source

View the source code

Type

Socket

---

topic

Source

View the source code

Type

Topic

---

Methods

clone()

Create a new listener instance with optional configuration overrides.

Source

View the source code

Preview

clone<NewHasParams>(options: ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket>)

Parameters

Parameters

Name	Type	Description
options	ListenerConfigurationType<ExtractUrlParams<Topic>, Topic, Socket>

Returns

Listener<Response, Topic, Socket, NewHasParams>

---

setOptions()

Set adapter-specific listener options.

Source

View the source code

Preview

setOptions(options: ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>)

Parameters

Parameters

Name	Type	Description
options	ExtractAdapterListenerOptionsType<ExtractSocketAdapterType<Socket>>

Returns

Listener<Response, Topic, Socket, HasParams>

---

setParams()

Set the URL path parameters for the topic (e.g., :channelId ).

Source

View the source code

Preview

setParams(params: ExtractUrlParams<Topic>)

Parameters

Parameters

Name	Type	Description
params	ExtractUrlParams<Topic>

Returns

Listener<Response, Topic, Socket, true>

---