APIリファレンス

以下のメソッドを使用して、Pages Functionを構成できます。

メソッド

onRequests

• 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()

env.ASSETS.fetch()関数を使用すると、Pagesプロジェクトから静的アセットを取得できます。

env.ASSETS.fetch()関数には、Requestオブジェクト、URL文字列、またはURLオブジェクトを渡すことができます。URLは、アセットに直接ではなく、きれいなパスである必要があります。たとえば、パスが/users/index.htmlの場合、/users/index.htmlではなく/users/をリクエストします。このメソッド呼び出しは、ヘッダーとリダイレクトルールを実行し、返されるレスポンスを変更します。

タイプ

EventContext

以下は、onRequestメソッドで渡されるcontextオブジェクトのプロパティです：

• request Request

  これは、受信したRequestです。

• functionPath string

  これは、リクエストのパスです。

• waitUntil(promisePromise<any>) void

  詳細については、waitUntilドキュメントを参照してください。

• passThroughOnException() void

  詳細については、passThroughOnExceptionドキュメントを参照してください。これは、高度なモードプロジェクトでは機能しないことに注意してください。

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

  リクエストを次のFunctionまたは他のFunctionが利用できない場合はアセットサーバーに渡します。

• 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 Data

EnvWithFetch

Functionの環境変数、シークレット、およびバインディングを保持します。これには、アセット提供動作にフォールバックするためのASSETSバインディングも含まれています。