createDeliveryController

Instantiates a delivery controller for one listen() subscription.

---

Import

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

Source

View the source code

Package

@hyper-fetch/sockets

Parameters

createDeliveryController<Input, Output, Extra>(delivery: DeliveryPresetType | DeliveryStrategyType<Input, any, Extra>, context: DeliveryStrategyContextType<Output, Extra>)

Parameters

Name	Type	Description
delivery	DeliveryPresetType | DeliveryStrategyType<Input, any, Extra>
context	DeliveryStrategyContextType<Output, Extra>

Returns

type DeliveryControllerType<Input,Extra> = {
  dispose: () => void; 
  push: (message: DeliveryMessageType<Input, Extra>) => void; 
}

createDeliveryController

Name	Type	Description
dispose	() => void	Called when the subscription ends ( unlisten() / component unmount). Clear timers and drop pending state here. Nothing may be delivered after dispose was called. Must be safe to call more than once.
push	(message: DeliveryMessageType<Input, Extra>) => void	Receives every raw message of the subscription. The strategy decides if and when to call deliver .