Header menu logo FSharp.ATProto

Jetstream Module

Functions and values

Function or value Description

buildUri options

Full Usage: buildUri options

Parameters:
Returns: Uri

Build the WebSocket URI from options.

options : JetstreamOptions
Returns: Uri

defaultOptions

Full Usage: defaultOptions

Returns: JetstreamOptions

Default Jetstream options pointing at the US-East relay.

Returns: JetstreamOptions

parseEvent json

Full Usage: parseEvent json

Parameters:
    json : string

Returns: Result<JetstreamEvent, StreamError>

Parse a raw Jetstream JSON message into a JetstreamEvent.

json : string
Returns: Result<JetstreamEvent, StreamError>

subscribe options ct

Full Usage: subscribe options ct

Parameters:
Returns: IAsyncEnumerable<Result<JetstreamEvent, StreamError>>

Subscribe to a Jetstream relay. Returns an IAsyncEnumerable that yields events until the connection closes or the CancellationToken is triggered. On disconnect the final element will be Error Closed.

options : JetstreamOptions
ct : CancellationToken
Returns: IAsyncEnumerable<Result<JetstreamEvent, StreamError>>

Type something to start searching.