Skip to main content

RuntimeRequestHandler TypeAlias

A request handler for the container runtime. Each handler should handle a specific request, and return undefined if it does not apply. These handlers are called in series, so there may be other handlers before or after. A handler should only return error if the request is for a route the handler owns, and there is a problem with the route, or fulling the specific request.

This API is deprecated and will be removed in a future release.

Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/request-handler/legacy.

For more information about our API support guarantees, see here.

Signature

export type RuntimeRequestHandler = (request: RequestParser, runtime: IContainerRuntime) => Promise<IResponse | undefined>;