Skip to main content
Version: v2 RC

removeChannel()

Unsubscribes and removes Realtime channel from Realtime client.

supabase.removeChannel(myChannel)

Parameters

  • RealtimeChannelrequiredobject

    No description provided.

      Properties
    • updateJoinPayloadrequiredobject

      No description provided.

    • untrackrequiredobject

      No description provided.

    • unsubscriberequiredobject

      No description provided.

    • triggerrequiredobject

      No description provided.

    • trackrequiredobject

      No description provided.

    • topicrequiredstring

      No description provided.

    • timeoutrequirednumber

      No description provided.

    • subscriberequiredobject

      No description provided.

    • staterequiredCHANNEL_STATES

      No description provided.

    • socketrequireddefault

      No description provided.

    • sendrequiredobject

      No description provided.

    • replyEventNamerequiredobject

      No description provided.

    • rejoinUntilConnectedrequiredobject

      No description provided.

    • rejoinTimerrequireddefault

      No description provided.

    • rejoinrequiredobject

      No description provided.

    • pushBufferrequiredobject

      No description provided.

    • pushrequiredobject

      No description provided.

    • presenceStaterequiredobject

      No description provided.

    • presencerequireddefault

      No description provided.

    • paramsrequiredobject

      No description provided.

    • onMessagerequiredobject

      No description provided.

    • onErrorrequiredobject

      No description provided.

    • onCloserequiredobject

      No description provided.

    • onrequiredobject

      No description provided.

    • offrequiredobject

      No description provided.

    • joinRefrequiredobject

      No description provided.

    • joinPushrequireddefault

      No description provided.

    • joinedOncerequiredboolean

      No description provided.

    • isMemberrequiredobject

      No description provided.

    • isLeavingrequiredobject

      No description provided.

    • isJoiningrequiredobject

      No description provided.

    • isJoinedrequiredobject

      No description provided.

    • isErroredrequiredobject

      No description provided.

    • isEqualrequiredany

      No description provided.

    • isClosedrequiredobject

      No description provided.

    • getPayloadRecordsrequiredany

      No description provided.

    • constructorrequiredobject

      No description provided.

    • canPushrequiredobject

      No description provided.

    • bindingsrequiredobject

      No description provided.

Notes

  • Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed.

Examples

Removes a channel

supabase.removeChannel(myChannel)