← Cloudflare Pages / pages / functions

Referenční dokumentace API

Ke konfiguraci vaší Pages Function lze použít tyto metody.

onRequest metoda se zavolá, pokud neexistuje specifičtější onRequestVerb metoda exportovaná. Pokud jsou exportované například obě onRequest a onRequestGet jsou exportovány, pouze onRequestGet se zavolá pro GET požadavky.

• onRequest(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech požadavků bez ohledu na metodu požadavku, pokud není exportováno konkrétní sloveso požadavku (jedna z níže uvedených metod).

• onRequestGet(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech GET požadavky.

• onRequestPost(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech POST požadavky.

• onRequestPatch(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech PATCH požadavky.

• onRequestPut(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech PUT požadavky.

• onRequestDelete(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech DELETE požadavky.

• onRequestHead(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech HEAD požadavky.

• onRequestOptions(contextEventContext) Response | Promise<Response>

  • Tato funkce se zavolá u všech OPTIONS požadavky.

env.ASSETS.fetch() funkce umožňuje načíst statické aktivum z vašeho projektu Pages.

Můžete předat Objekt Request, řetězec URL nebo objekt URL do env.ASSETS.fetch() funkce. URL adresa musí vést na přehlednou cestu, nikoli přímo na aktivum. Pokud byste měli například cestu /users/index.html, odešlete požadavek na /users/ místo /users/index.html. Toto volání metody spustí pravidla pro hlavičky a přesměrování a upraví vracenou odpověď.

Následují vlastnosti objektu context objektu, které se předávají dál na onRequest metody:

• request Požadavek

  Toto je příchozí Požadavek.

• functionPath string

  Toto je cesta požadavku.

• waitUntil(promisePromise<any>) void

  Viz waitUntil dokumentace s dalšími informacemi.

• passThroughOnException() void

  Viz passThroughOnException dokumentace s dalšími informacemi. Mějte na paměti, že to nebude fungovat na projekt v pokročilém režimu.

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

  Předá požadavek další funkci, případně serveru se statickými soubory, pokud žádná jiná funkce není k dispozici.

• env EnvWithFetch

• params Params<P>

  Obsahuje hodnoty z dynamické směrování.

  V následujícím příkladu máte dynamickou cestu, která je /users/[user].js. Když navštívíte web na /users/nevi params objekt by vypadal takto:

  {
  	user: "nevi";
  }

  Díky tomu můžete z cesty načíst dynamickou hodnotu:

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

  Což by vrátilo "Hello nevi".

• data Data

Obsahuje proměnné prostředí, Secrets a vazby pro Function. Obsahuje také ASSETS binding, díky kterému se můžete vrátit k výchozímu chování pro obsluhu statických souborů.