add ts-doc comment to getCloudflareContext function

opennextjs · Sep 25, 2024 · a83fba6 · a83fba6
1 parent 6ea8d74
commit a83fba6
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/packages/cloudflare/src/api/get-cloudflare-context.ts b/packages/cloudflare/src/api/get-cloudflare-context.ts
@@ -16,6 +16,19 @@ export type CloudflareContext<
 
 const cloudflareContextSymbol = Symbol.for("__cloudflare-context__");
 
+/**
+ * Utility to get the current Cloudflare context.
+ *
+ * Such context contains three values:
+ *  - `env`: object containing the worker's bindings
+ *          (https://developers.cloudflare.com/workers/runtime-apis/bindings/)
+ *  - `ctx`: the current execution context object
+ *          (https://developers.cloudflare.com/workers/runtime-apis/context)
+ *  - `cf`: object containing information regarding the current request
+ *          (https://developers.cloudflare.com/workers/runtime-apis/request/#the-cf-property-requestinitcfproperties)
+ *
+ * @returns the cloudflare context
+ */
 export async function getCloudflareContext<
   CfProperties extends Record<string, unknown> = IncomingRequestCfProperties,
   Context = ExecutionContext,