Hierarchy

  • UseOpenChannelList
  • Interface

    UseOpenChannelList

    Description

    interface for open channel list hook

    Parameters

    Returns {
        error: unknown;
        loading: boolean;
        next: (() => Promise<void>);
        openChannels: OpenChannel[];
        refresh: (() => Promise<void>);
        refreshing: boolean;
    }

    • error: unknown

      Error state

    • loading: boolean

      Loading state, only available on first render

    • next: (() => Promise<void>)
        • (): Promise<void>
        • Fetch next channels to state

          Returns

          Returns Promise<void>

    • openChannels: OpenChannel[]

      Get open channels state

    • refresh: (() => Promise<void>)
        • (): Promise<void>
        • Refresh, clear and reload messages from latest

          Returns

          Returns Promise<void>

    • refreshing: boolean

      Refreshing state, status is changes when the refresh is called.

Generated using TypeDoc