Get started

This guide will instruct you on creating and deploying a Pages Function.

​​ Prerequisites

You must have a Pages project set up on your local machine or deployed on the Cloudflare dashboard. To create a Pages project, refer to Get started.

​​ Create a Function

To get started with generating a Pages Function, create a /functions directory at the root of your Pages project.

Writing your Functions files in the /functions directory will automatically generate a Worker with custom functionality at predesignated routes.

Copy and paste the following code into a helloworld.js file that you create in your /functions folder:

helloworld.js
export function onRequest(context) {
  return new Response("Hello, world!")
}

In the above example code, the onRequest handler takes a request context object. The handler must return a Response or a Promise of a Response.

This Function will run on the /helloworld route and returns "Hello, world!". The reason this Function is available on this route is because the file is named helloworld.js. Similarly, if this file was called howdyworld.js, this function would run on /howdyworld.

Refer to Routing for more information on route customization.

​​ Runtime features

Workers runtime features, including compatibility with a subset of Node.js APIs and setting a compatibility date or compatibility flag are configurable on Pages Functions.

Set these configurations by passing an argument to your Wrangler command or by setting them in the dashboard. To set Pages compatibility flags in the Cloudflare dashboard:

1. Log into the Cloudflare dashboard Open external link and select your account.
2. Select Pages and select your Pages project.
3. Select Settings > Functions > Compatibility Flags.
4. Configure your Production and Preview compatiblity flags as needed.

Additionally, use other Cloudflare products such as D1 (serverless DB) and R2 from within your Pages project by configuring bindings.

​​ Deploy your Function

After you have set up your Function, deploy your Pages project. Deploy your project by:

• Connecting your Git provider.
• Using Wrangler from the command line.

​​ Related resources

• Customize your Function’s routing
• Review the API reference
• Learn how to debug your Function