@pbvex/client / FetchRealtimeTransport

Class: FetchRealtimeTransport

Implements

• RealtimeTransport

Constructors

Constructor

new FetchRealtimeTransport(options): FetchRealtimeTransport

Parameters

options

FetchRealtimeTransportOptions

Returns

FetchRealtimeTransport

Properties

baseUrl

readonly baseUrl: string

---

fetchFn

readonly fetchFn: (input, init?) => Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

---

getAuthToken?

readonly optional getAuthToken?: () => string | Promise<string | undefined> | undefined

Returns

string | Promise<string | undefined> | undefined

---

initialReconnectDelayMs

readonly initialReconnectDelayMs: number

---

maxFunctionArgsBytes

readonly maxFunctionArgsBytes: number

---

maxRealtimeBodyBytes

readonly maxRealtimeBodyBytes: number

---

maxReconnectDelayMs

readonly maxReconnectDelayMs: number

---

maxReconnects

readonly maxReconnects: number

---

maxResponseBodyBytes

readonly maxResponseBodyBytes: number

---

maxReturnValueBytes

readonly maxReturnValueBytes: number

---

maxSseEventDataLength

readonly maxSseEventDataLength: number

---

maxSseLineLength

readonly maxSseLineLength: number

---

realtimePath

readonly realtimePath: string

---

timeoutMs

readonly timeoutMs: number

Accessors

connectionState

Get Signature

get connectionState(): ConnectionState

Returns

ConnectionState

Implementation of

RealtimeTransport.connectionState

Methods

close()

close(): void

Returns

void

Implementation of

RealtimeTransport.close

---

computeSubscriptionId()

computeSubscriptionId(path, canonicalArgs): Promise<string>

Parameters

path

string

canonicalArgs

string

Returns

Promise<string>

---

refreshAuth()

refreshAuth(): void

Returns

void

Implementation of

RealtimeTransport.refreshAuth

---

removeSubscription()

removeSubscription(subscriptionKey): void

Parameters

subscriptionKey

string

Returns

void

---

watch()

watch<Args, Return>(path, args, options): Unsubscribe

Type Parameters

Args

Args

Return

Return

Parameters

path

string

args

Args

options

WatchOptions<Return>

Returns

Unsubscribe

Implementation of

RealtimeTransport.watch