ManagementOptions

Defined in: surface/types.ts:126

Options used to create a management router or OpenAPI handler.

Type Parameters

Type Parameter	Default type	Description
TContext	unknown	Application context supplied through the OpenAPI handler call.

Properties

authorize?

optional authorize?: ManagementAuthorize<TContext>;

Defined in: surface/types.ts:132

Optional authorization hook invoked before reads and mutations.

---

monque

monque: ManagementMonque;

Defined in: surface/types.ts:128

Scheduler instance or facade backing the management endpoints.

---

readOnly?

optional readOnly?: boolean;

Defined in: surface/types.ts:130

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

---

serializePayload?

optional serializePayload?: ManagementPayloadSerializer<TContext>;

Defined in: surface/types.ts:134

Default payload serializer for returned jobs.

---

serializePayloadByJobName?

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

Defined in: surface/types.ts:136

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