AIDK API Reference / aidk-kernel / ProcedureEnvelope

Interface: ProcedureEnvelope<TArgs>

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

Metadata envelope passed to middleware containing execution context.

Example

const middleware: Middleware<[string]> = async (args, envelope, next) => {
  if (envelope.sourceType === 'hook') {
    console.log(`Hook ${envelope.operationName} from ${envelope.sourceId}`);
  }
  return next();
};

Type Parameters

Type Parameter	Description
TArgs extends any[]	The argument types of the procedure

Properties

Property	Type	Description	Defined in
args	TArgs	The arguments passed to the procedure	packages/kernel/src/procedure.ts:92
context	KernelContext	The current kernel context	packages/kernel/src/procedure.ts:94
operationName	string	Name of the operation being executed	packages/kernel/src/procedure.ts:90
sourceId?	string	Identifier of the source (e.g., class name for decorated methods)	packages/kernel/src/procedure.ts:88
sourceType	"procedure" | "hook"	Whether this is a regular procedure or a hook	packages/kernel/src/procedure.ts:86