Options
All
  • Public
  • Public/Protected
  • All
Menu

Module src

Index

Type aliases

ChannelCloseReason

ChannelCloseReason: { initiator: "client"; willReconnect: boolean } | { initiator: "channel"; willReconnect: false }

Called as an argument to the cleanup function returned from OpenChannelCb

Channel closed because of the client this can be due to unexpected disconnects in which case willReconnect will be true or intentional closure via Client.close in which case willReconnect will be false

or

Channel closed because the close function returned from Client.openChannel is called

DebugLog

DebugLog: { data?: unknown; message: string; type: "breadcrumb" } | { log: { cmd: Command; direction: "in" | "out" }; type: "log" }

FetchConnectionMetadataResult

FetchConnectionMetadataResult: Result<GovalMetadata, Error | FetchConnectionMetadataError>

The result of fetchConnectionMetadata

OpenChannelCb

OpenChannelCb<Ctx>: (res: { channel: Channel; context: Ctx; error: null } | { channel: null; context: Ctx; error: Error }) => void | ((reason: ChannelCloseReason) => void)

Type parameters

  • Ctx

Type declaration

    • (res: { channel: Channel; context: Ctx; error: null } | { channel: null; context: Ctx; error: Error }): void | ((reason: ChannelCloseReason) => void)
    • Parameters

      • res: { channel: Channel; context: Ctx; error: null } | { channel: null; context: Ctx; error: Error }

      Returns void | ((reason: ChannelCloseReason) => void)

Generated using TypeDoc