Skip to main content
zerotal

Documentation


Documentation / @zerotal/broadcasting / ChannelCallback

Type Alias: ChannelCallback

ChannelCallback = (user, ...params) => boolean | PresenceMemberData | null | undefined | Promise<boolean | PresenceMemberData | null | undefined>

Defined in: broadcasting/src/ChannelRegistry.ts:24

A channel authorization callback.

  • Private channel: return a boolean (true = authorized).
  • Presence channel: return a member-data object to authorize + publish presence, or false/null/undefined to deny.

Parameters

user

unknown

params

...string[]

Returns

boolean | PresenceMemberData | null | undefined | Promise<boolean | PresenceMemberData | null | undefined>