Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

API リファレンス

最終更新 Markdown で表示Agent セットアップ

次のメソッドで、Pages Function を設定できます。

メソッド

onRequests

より具体的な onRequestVerb メソッドをエクスポートしていない場合、onRequest メソッドが呼び出されます。たとえば、onRequestonRequestGet の両方をエクスポートしている場合、GET リクエストでは onRequestGet だけが呼び出されます。

  • 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 バインディングもここにあります。

役に立ちましたか?