Skip to content

CreateInboxRouteOptions

Defined in: src/mft/conventions.ts:54

Options accepted by createInboxRoute.

PropertyTypeDescriptionDefined in
description?stringOptional human-friendly description.src/mft/conventions.ts:60
destinationConventionEndpointDestination endpoint that receives files from the inbox.src/mft/conventions.ts:64
enabled?booleanWhether the route is enabled. Defaults to true.src/mft/conventions.ts:68
idstringStable route id.src/mft/conventions.ts:56
inboxMftInboxConventionInbox convention.src/mft/conventions.ts:62
metadata?Record<string, unknown>Caller-defined metadata merged into the route.src/mft/conventions.ts:70
name?stringOptional human-friendly route name.src/mft/conventions.ts:58
operation?MftRouteOperationOptional operation override. Defaults to "copy".src/mft/conventions.ts:66