Class PhraseyHooks

constructor

• new PhraseyHooks(phrasey): PhraseyHooks

• Parameters

  • phrasey: Phrasey

  Returns PhraseyHooks

handlers

phrasey

addHandler

• addHandler(handler): (() => void)

• Parameters

  • handler: PhraseyHooksAttachedHandler

  Returns (() => void)

  • • (): void

    • Returns void

addHandlerFile

• addHandlerFile(path, options): PhraseyResult<true, Error>

• Parameters

  • path: string

  • options: Record<string, any>

  Returns PhraseyResult<true, Error>

dispatch

• dispatch<Event>(event, state, data): Promise<PhraseyResult<true, Error>>

• Type Parameters

  • Event extends keyof PhraseyHooksEvents

  Parameters

  • event: Event

  • state: PhraseyState

  • data: PhraseyHooksEvents[Event]

  Returns Promise<PhraseyResult<true, Error>>

removeHandler

• removeHandler(handler): void

• Parameters

  • handler: PhraseyHooksAttachedHandler

  Returns void