@anycable/core/transport/index.d.ts

AnyCable JavaScript client library core functionality

import { Unsubscribe } from 'nanoevents'

import { Logger } from '../logger/index.js'

export type TransportEvents<T> = {
  open: () => void
  close: (err?: Error) => void
  error: (err: Error) => void
  data: (payload: T) => void
}

export interface Env {
  [index: string]: string
}

export interface Transport<PayloadType = string> {
  readonly url: string

  open(): Promise<void>
  send(data: PayloadType): void
  close(): Promise<void>

  setURL(url: string): void
  setParam(key: string, value: string): void
  setToken(value: string, param?: string): void

  displayName(): string

  on<E extends keyof TransportEvents<PayloadType>>(
    event: E,
    callback: TransportEvents<PayloadType>[E]
  ): Unsubscribe
  once<E extends keyof TransportEvents<PayloadType>>(
    event: E,
    callback: TransportEvents<PayloadType>[E]
  ): Unsubscribe
}

export type FallbackTransportOpts = Partial<{
  logger: Logger
}>

export class FallbackTransport<PayloadType = string>
  implements Transport<PayloadType>
{
  readonly url: string

  constructor(
    transports: Transport<PayloadType>[],
    opts?: FallbackTransportOpts
  )

  open(): Promise<void>
  send(data: PayloadType): void
  close(): Promise<void>

  displayName(): string

  setURL(url: string): void
  setParam(key: string, value: string): void
  setToken(value: string, param?: string): void

  on<E extends keyof TransportEvents<PayloadType>>(
    event: E,
    callback: TransportEvents<PayloadType>[E]
  ): Unsubscribe
  once<E extends keyof TransportEvents<PayloadType>>(
    event: E,
    callback: TransportEvents<PayloadType>[E]
  ): Unsubscribe
}