Skip to content

AIDK API Reference / aidk-kernel / createHook

Function: createHook() ​

Call Signature ​

ts
function createHook<THandler>(handler: THandler): Procedure<THandler>;

Defined in: packages/kernel/src/procedure.ts:1400

Create a Hook Procedure from a function.

Type Parameters ​

Type Parameter
THandler extends (...args: any[]) => any

Parameters ​

ParameterType
handlerTHandler

Returns ​

Procedure<THandler>

Example ​

typescript
const processChunk = createHook(async (chunk: string) => chunk.toUpperCase());
// Type inferred: Procedure<[string], string>

Call Signature ​

ts
function createHook<THandler>(options: ProcedureOptions, handler: THandler): Procedure<THandler>;

Defined in: packages/kernel/src/procedure.ts:1403

Create a Hook Procedure from a function.

Type Parameters ​

Type Parameter
THandler extends (...args: any[]) => any

Parameters ​

ParameterType
optionsProcedureOptions
handlerTHandler

Returns ​

Procedure<THandler>

Example ​

typescript
const processChunk = createHook(async (chunk: string) => chunk.toUpperCase());
// Type inferred: Procedure<[string], string>

Released under the MIT License.