API reference

• onRequest(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all requests no matter the request method.
• onRequestGet(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all GET requests.
• onRequestPost(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all POST requests.
• onRequestPatch(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all PATCH requests.
• onRequestPut(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all PUT requests.
• onRequestDelete(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all DELETE requests.
• onRequestHead(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all HEAD requests.
• onRequestOptions(contextEventContext) Response | Promise<Response>
  • This function will be invoked on all OPTIONS requests.

The following are the properties on the context object which are passed through on the onRequest methods:

• request Request

  This is the incoming Request.

• functionPath string

  This is the path of the request.

• waitUntil(promisePromise<any>) void

  Refer to waitUntil documentation for more information.

• passThroughOnException() void

  Refer to passThroughOnException documentation for more information. Note that this will not work on an advanced mode project.

• next(input?Request | string, init?RequestInit) Promise<Response>

  Passes the request through to the next Function or to the asset server if no other Function is available.

• env EnvWithFetch

• params Params<P>

  Holds the values from dynamic routing.

  In the following example, you have a dynamic path that is /users/[user].js. When you visit the site on /users/nevi the params object would look like:

  
  {
    user: "nevi"
  }
  

  This allows you fetch the dynamic value from the path:

  
  export function onRequest(context) {
    return new Response(`Hello ${context.params.user}`);
  }
  

  Which would return "Hello nevi".

• data Data