Function ws

ws<Req, Res, Meta>(url: string, opts?: Omit<Meta, "url" | "method">): Endpoint<Duplex<Req, Res>, void, unknown, Meta>
Describes a WebSocket connection with JsonTransport encoding of Req and Res objects over a Duplex stream.

Returns
Endpoint definition
Type Parameters
- Req
- Res
- Meta extends SimpleMeta = SimpleMeta
Parameters
- url: string
  
  URL at which the endpoint is accessed
- Optional opts: Omit<Meta, "url" | "method">
  
  Additional metadata
Returns Endpoint<Duplex<Req, Res>, void, unknown, Meta>
- Defined in estuary-rpc/api.ts:107

Generated using TypeDoc