@anycable/turbo-stream/index.d.ts

AnyCable Client plugin to support Turbo Streams

import { Channel, Cable } from '@anycable/core'

export type ChannelParamsMap = { [token: string]: boolean | number | string }

export class TurboChannel extends Channel {
  readonly element: HTMLElement
  readonly identifier: string

  constructor(element: HTMLElement, channel: string, params?: ChannelParamsMap)
}

export interface StartOptions {
  tagName: string
  channelClass: typeof TurboChannel
  requestSocketIDHeader: boolean | string
  // Number of milliseconds to wait before unsubscribing from a channel after the element has been disconnected.
  // If set to `true`, the default value (300ms) is used.
  delayedUnsubscribe: boolean | number
  // activate presence tag
  presence: boolean
  presenceTagName: string
}

export const DEFAULT_SOCKET_HEADER: string

export function start(cable: Cable, opts?: Partial<StartOptions>): void