Interface StaticHandler

dataRoutes

query

• query(
      request: Request,
      opts?: {
          dataStrategy?: DataStrategyFunction<unknown>;
          filterMatchesToLoad?: (match: DataRouteMatch) => boolean;
          generateMiddlewareResponse?: (
              query: (
                  r: Request,
                  args?: { filterMatchesToLoad?: (match: DataRouteMatch) => boolean },
              ) => Promise<Response | StaticHandlerContext>,
          ) => MaybePromise<Response>;
          normalizePath?: (request: Request) => Path;
          requestContext?: unknown;
          skipLoaderErrorBubbling?: boolean;
          skipRevalidation?: boolean;
      },
  ): Promise<Response | StaticHandlerContext>

  Perform a query for a given request - executing all matched route loaders/actions. Used for document requests.

  Parameters

  • request: Request

    The request to query
  • Optionalopts: {
        dataStrategy?: DataStrategyFunction<unknown>;
        filterMatchesToLoad?: (match: DataRouteMatch) => boolean;
        generateMiddlewareResponse?: (
            query: (
                r: Request,
                args?: { filterMatchesToLoad?: (match: DataRouteMatch) => boolean },
            ) => Promise<Response | StaticHandlerContext>,
        ) => MaybePromise<Response>;
        normalizePath?: (request: Request) => Path;
        requestContext?: unknown;
        skipLoaderErrorBubbling?: boolean;
        skipRevalidation?: boolean;
    }

    Optional query options

    • OptionaldataStrategy?: DataStrategyFunction<unknown>

      Alternate dataStrategy implementation

    • OptionalfilterMatchesToLoad?: (match: DataRouteMatch) => boolean

      Predicate function to filter which matches should be loaded

    • OptionalgenerateMiddlewareResponse?: (
          query: (
              r: Request,
              args?: { filterMatchesToLoad?: (match: DataRouteMatch) => boolean },
          ) => Promise<Response | StaticHandlerContext>,
      ) => MaybePromise<Response>

      To enable middleware, provide a function to generate a response to bubble back up the middleware chain

    • OptionalnormalizePath?: (request: Request) => Path

      Normalize the request path

    • OptionalrequestContext?: unknown

      Context object to pass to loaders/actions

    • OptionalskipLoaderErrorBubbling?: boolean

      Skip loader error bubbling

    • OptionalskipRevalidation?: boolean

      Skip revalidation after action submission

  Returns Promise<Response | StaticHandlerContext>

queryRoute

• queryRoute(
      request: Request,
      opts?: {
          dataStrategy?: DataStrategyFunction<unknown>;
          generateMiddlewareResponse?: (
              queryRoute: (r: Request) => Promise<Response>,
          ) => MaybePromise<Response>;
          normalizePath?: (request: Request) => Path;
          requestContext?: unknown;
          routeId?: string;
      },
  ): Promise<any>

  Perform a query for a specific route. Used for resource requests.

  Parameters

  • request: Request

    The request to query
  • Optionalopts: {
        dataStrategy?: DataStrategyFunction<unknown>;
        generateMiddlewareResponse?: (
            queryRoute: (r: Request) => Promise<Response>,
        ) => MaybePromise<Response>;
        normalizePath?: (request: Request) => Path;
        requestContext?: unknown;
        routeId?: string;
    }

    Optional queryRoute options

    • OptionaldataStrategy?: DataStrategyFunction<unknown>

      Alternate dataStrategy implementation

    • OptionalgenerateMiddlewareResponse?: (queryRoute: (r: Request) => Promise<Response>) => MaybePromise<Response>

      To enable middleware, provide a function to generate a response to bubble back up the middleware chain

    • OptionalnormalizePath?: (request: Request) => Path

      Normalize the request path

    • OptionalrequestContext?: unknown

      Context object to pass to loaders/actions

    • OptionalrouteId?: string

      The ID of the route to query

  Returns Promise<any>