Function useConnectionState

Returns {
    connect: ((identifier: string) => Promise<void>);
    connected: boolean;
    disconnect: ((identifier: string) => Promise<void>);
    error?: string | null;
    isError: boolean;
    isLoading: boolean;
    toggle: ((identifier: string) => Promise<void>);
}

An object containing connection state and methods to manage the connection.

• connect: ((identifier: string) => Promise<void>)

  • • (identifier): Promise<void>

    • Parameters

      • identifier: string

      Returns Promise<void>

• connected: boolean

• disconnect: ((identifier: string) => Promise<void>)

  • • (identifier): Promise<void>

    • Parameters

      • identifier: string

      Returns Promise<void>

• Optionalerror?: string | null

• isError: boolean

• isLoading: boolean

• toggle: ((identifier: string) => Promise<void>)

  • • (identifier): Promise<void>

    • Parameters

      • identifier: string

      Returns Promise<void>