Skip to content

ManagementOptions

Defined in: surface/types.ts:124

Options used to create a management router or OpenAPI handler.

Type ParameterDefault typeDescription
TContextunknownApplication context supplied through the OpenAPI handler call.
optional authorize?: ManagementAuthorize<TContext>;

Defined in: surface/types.ts:133

Optional authorization hook invoked before reads and mutations.


optional maxBodySize?: number;

Defined in: surface/types.ts:128

Maximum request body size in bytes. Defaults to 65,536 bytes.


monque: ManagementMonque;

Defined in: surface/types.ts:126

Scheduler instance or facade backing the management endpoints.


optional parallelCapabilityChecks?: boolean;

Defined in: surface/types.ts:135

Opt in only when authorization checks can run independently. Defaults to sequential.


optional readOnly?: boolean;

Defined in: surface/types.ts:131

When true, all mutation endpoints return 403 even if the scheduler supports them.


optional serializePayload?: ManagementPayloadSerializer<TContext>;

Defined in: surface/types.ts:137

Default payload serializer for returned jobs.


optional serializePayloadByJobName?: Record<string, ManagementPayloadSerializer<TContext>>;

Defined in: surface/types.ts:139

Payload serializers keyed by job name, taking precedence over serializePayload.


optional trustedOrigins?: readonly string[];

Defined in: surface/types.ts:129