HookDbApi
Defined in: hooks.ts:58
Scoped API surface available to server-side hook handlers. Intentionally narrow — handlers should not have full StateDb access.
Properties
Section titled “Properties”appendEvent
Section titled “appendEvent”appendEvent: (
sessionId,type,data?,context?) => {created_at:string;event_id:string; } |null
Defined in: hooks.ts:71
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
generateRetrospective
Section titled “generateRetrospective”generateRetrospective: (
sessionId) =>string|null
Defined in: hooks.ts:73
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
Returns
Section titled “Returns”string | null
getPushSubscriptionCount
Section titled “getPushSubscriptionCount”getPushSubscriptionCount: () =>
number
Defined in: hooks.ts:77
Returns
Section titled “Returns”number
proposeLessonFromRetro
Section titled “proposeLessonFromRetro”proposeLessonFromRetro: (
project,section,content,source?) =>Lesson|null
Defined in: hooks.ts:72
Parameters
Section titled “Parameters”project
Section titled “project”string | null
section
Section titled “section”string
content
Section titled “content”string
source?
Section titled “source?”string
Returns
Section titled “Returns”Lesson | null
resolveProjectPath
Section titled “resolveProjectPath”resolveProjectPath: (
ref) =>string|null
Defined in: hooks.ts:66
Parameters
Section titled “Parameters”string | null | undefined
Returns
Section titled “Returns”string | null
resolveProjectSlug
Section titled “resolveProjectSlug”resolveProjectSlug: (
ref) =>string
Defined in: hooks.ts:65
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:76
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:78
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:70
Parameters
Section titled “Parameters”CreateSessionOpts
Returns
Section titled “Returns”Session | null
getProjectMemory()
Section titled “getProjectMemory()”getProjectMemory(
projectPath?):string
Defined in: hooks.ts:64
Parameters
Section titled “Parameters”projectPath?
Section titled “projectPath?”string | null
Returns
Section titled “Returns”string
getSession()
Section titled “getSession()”getSession(
id):Session|null
Defined in: hooks.ts:61
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Session | null
getSettings()
Section titled “getSettings()”getSettings():
Settings
Defined in: hooks.ts:60
Returns
Section titled “Returns”Settings
getTask()
Section titled “getTask()”getTask(
id):Task|null
Defined in: hooks.ts:62
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Task | null
getTasks()
Section titled “getTasks()”getTasks(
opts?):Task[]
Defined in: hooks.ts:63
Parameters
Section titled “Parameters”GetTasksOpts
Returns
Section titled “Returns”Task[]
updateTask()
Section titled “updateTask()”updateTask(
id,fields):Task|null
Defined in: hooks.ts:69
Parameters
Section titled “Parameters”string
fields
Section titled “fields”object
Returns
Section titled “Returns”Task | null