← Cloudflare Pages / pages / functions

Справочник по API

Для настройки Pages Function можно использовать следующие методы.

onRequest метод будет вызван, если не задан более специфичный onRequestVerb метод экспортирован. Например, если экспортированы оба onRequest и onRequestGet экспортируются, только onRequestGet будет вызван для GET запросы.

• onRequest(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех запросов независимо от метода запроса, если не экспортирован конкретный глагол запроса (один из методов ниже).

• onRequestGet(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех GET запросы.

• onRequestPost(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех POST запросы.

• onRequestPatch(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех PATCH запросы.

• onRequestPut(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех PUT запросы.

• onRequestDelete(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех DELETE запросы.

• onRequestHead(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех HEAD запросы.

• onRequestOptions(contextEventContext) Response | Promise<Response>

  • Эта функция будет вызываться для всех OPTIONS запросы.

env.ASSETS.fetch() функция позволяет получить статический ресурс из вашего проекта Pages.

Можно передать Объект Request, строку URL или объект URL, чтобы env.ASSETS.fetch() функция. URL-адрес должен указывать на удобный путь, а не напрямую на ресурс. Например, если у вас есть путь /users/index.html, вы запросите /users/ вместо /users/index.html. Этот вызов метода выполнит правила заголовков и редиректов, изменив возвращаемый ответ.

Ниже перечислены свойства context объект, которые передаются далее в onRequest методы:

• request Запрос

  Это входящий Запрос.

• functionPath строка

  Это путь запроса.

• waitUntil(promisePromise<any>) void

  См. waitUntil документация, где это описано подробнее.

• passThroughOnException() void

  См. passThroughOnException документация для получения дополнительной информации. Обратите внимание, что это не будет работать на проект в расширенном режиме.

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

  Передаёт запрос следующей функции или серверу ресурсов, если другие функции недоступны.

• env EnvWithFetch

• params Params<P>

  Здесь хранятся значения из динамическая маршрутизация.

  В следующем примере используется динамический путь, который /users/[user].js. При посещении сайта на /users/nevi params объект будет выглядеть так:

  {
  	user: "nevi";
  }

  Это позволяет получить динамическое значение из пути:

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

  Это вернёт "Hello nevi".

• data Данные

Здесь хранятся переменные окружения, секреты и привязки для функции. Также здесь хранится ASSETS привязку, с помощью которой можно вернуться к стандартному поведению раздачи ресурсов.