Skip to content

createInboxRoute

function createInboxRoute(options: CreateInboxRouteOptions): MftRoute;

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

Creates a route that pulls files out of an inbox into a destination directory.

ParameterTypeDescription
optionsCreateInboxRouteOptionsInbox layout, destination endpoint, and optional metadata.

MftRoute

An MftRoute ready to register with RouteRegistry.