CreateOutboxRouteOptions
Defined in: src/mft/conventions.ts:74
Options accepted by createOutboxRoute.
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
description? | string | Optional human-friendly description. | src/mft/conventions.ts:80 |
enabled? | boolean | Whether the route is enabled. Defaults to true. | src/mft/conventions.ts:88 |
id | string | Stable route id. | src/mft/conventions.ts:76 |
metadata? | Record<string, unknown> | Caller-defined metadata merged into the route. | src/mft/conventions.ts:90 |
name? | string | Optional human-friendly route name. | src/mft/conventions.ts:78 |
operation? | MftRouteOperation | Optional operation override. Defaults to "copy". | src/mft/conventions.ts:86 |
outbox | MftOutboxConvention | Outbox convention. | src/mft/conventions.ts:84 |
source | ConventionEndpoint | Source endpoint that supplies files into the outbox. | src/mft/conventions.ts:82 |