HookDbApi
Defined in: hooks.ts:94
Properties
Section titled “Properties”appendEvent
Section titled “appendEvent”appendEvent: (
sessionId,type,data?,context?) => {created_at:string;event_id:string; } |null
Defined in: hooks.ts:103
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string | null | undefined
string
DbFieldValue
context?
Section titled “context?”EventContext | null
Returns
Section titled “Returns”{ created_at: string; event_id: string; } | null
getPushSubscriptionCount
Section titled “getPushSubscriptionCount”getPushSubscriptionCount: () =>
number
Defined in: hooks.ts:106
Returns
Section titled “Returns”number
resolveProjectPath
Section titled “resolveProjectPath”resolveProjectPath: (
ref) =>string|null
Defined in: hooks.ts:98
Parameters
Section titled “Parameters”string | null | undefined
Returns
Section titled “Returns”string | null
resolveProjectSlug
Section titled “resolveProjectSlug”resolveProjectSlug: (
ref) =>string
Defined in: hooks.ts:97
Parameters
Section titled “Parameters”string | null | undefined
Returns
Section titled “Returns”string
sendPushToAll
Section titled “sendPushToAll”sendPushToAll: (
payload) =>Promise<{cleaned:number;failed:number;sent:number; }>
Defined in: hooks.ts:105
Parameters
Section titled “Parameters”payload
Section titled “payload”badge?
Section titled “badge?”string
string
Record<string, unknown>
string
string
string
Returns
Section titled “Returns”Promise<{ cleaned: number; failed: number; sent: number; }>
Methods
Section titled “Methods”broadcast()
Section titled “broadcast()”broadcast(
channel,payload?):void
Defined in: hooks.ts:107
Parameters
Section titled “Parameters”channel
Section titled “channel”string
payload?
Section titled “payload?”unknown
Returns
Section titled “Returns”void
createSession()
Section titled “createSession()”createSession(
opts):Session|null
Defined in: hooks.ts:100
Parameters
Section titled “Parameters”CreateSessionOpts
Returns
Section titled “Returns”Session | null
getSession()
Section titled “getSession()”getSession(
id):Session|null
Defined in: hooks.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Session | null
getSettings()
Section titled “getSettings()”getSettings():
Settings
Defined in: hooks.ts:95
Returns
Section titled “Returns”Settings