docs: add return type annotations

.gitattributes

@@ -0,0 +1,30 @@
+* text=auto
+* text eol=lf
+
+# (binary is a macro for -text -diff)
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.avif binary
+*.webp binary
+*.jxl binary
+*.ico binary
+*.mov binary
+*.mp4 binary
+*.mp3 binary
+*.flv binary
+*.fla binary
+*.swf binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.ttf binary
+*.eot binary
+*.woff binary
+*.woff2 binary
+*.pyc binary
+*.pdf binary
+*.ez binary
+*.bz2 binary
+*.swp binary

content/r2/api/s3/presigned-urls.md

@@ -87,7 +87,7 @@ const r2 = new AwsClient({
 });
 
 export default {
-  async fetch(req: Request) {
+  async fetch(req: Request): Promise<Response> {
     // This is just an example to demonstrating using aws4fetch to generate a presigned URL.
     // This Worker should not be used as-is as it does not authenticate the request, meaning
     // that anyone can upload to your bucket.

content/workers/examples/103-early-hints.md

@@ -87,7 +87,7 @@ const HTML = `
 `;
 
 export default {
-  async fetch(req: Request) {
+  async fetch(req: Request): Promise<Response> {
     // If request is for test.css, serve the raw CSS
     if (/test\.css$/.test(req.url)) {
       return new Response(CSS, {

content/workers/examples/ab-testing.md

@@ -59,7 +59,7 @@ export default {
 const NAME = "myExampleWorkersABTest";
 
 export default {
-  async fetch(req: Request) {
+  async fetch(req: Request): Promise<Response> {
     const url = new URL(req.url);
     // Enable Passthrough to allow direct access to control and test routes.
     if (url.pathname.startsWith("/control") || url.pathname.startsWith("/test"))

content/workers/examples/accessing-the-cloudflare-object.md

@@ -39,7 +39,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(req: Request) {
+  async fetch(req: Request): Promise<Response> {
     const data =
       req.cf !== undefined
         ? req.cf

content/workers/examples/aggregate-requests.md

@@ -66,7 +66,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * someHost is set up to return JSON responses
      * Replace url1 and url2 with the hosts you wish to send requests to

content/workers/examples/alter-headers.md

@@ -48,7 +48,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const response = await fetch(request);
 
     // Clone the response so that it's no longer immutable

content/workers/examples/auth-with-headers.md

@@ -51,7 +51,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * @param {string} PRESHARED_AUTH_HEADER_KEY Custom header to check for key
      * @param {string} PRESHARED_AUTH_HEADER_VALUE Hard coded key value

content/workers/examples/basic-auth.md

@@ -177,7 +177,7 @@ function timingSafeEqual(a: string, b: string) {
 }
 
 export default {
-  async fetch(request: Request, env: { PASSWORD: string }) {
+  async fetch(request: Request, env: { PASSWORD: string }): Promise<Response> {
     const BASIC_USER = "admin";
 
     // You will need an admin password. This should be

content/workers/examples/block-on-tls.md

@@ -42,7 +42,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     try {
       const tlsVersion = request.cf.tlsVersion;
       // Allow only TLS versions 1.2 and 1.3

content/workers/examples/bulk-origin-proxy.md

@@ -44,7 +44,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * An object with different URLs to fetch
      * @param {Object} ORIGINS

content/workers/examples/bulk-redirects.md

@@ -43,7 +43,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const externalHostname = "examples.cloudflareworkers.com";
 
     const redirectMap = new Map([

content/workers/examples/cache-api.md

@@ -57,7 +57,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request, env: unknown, ctx: ExecutionContext) {
+  async fetch(request: Request, env: unknown, ctx: ExecutionContext): Promise<Response> {
     const cacheUrl = new URL(request.url);
 
     // Construct the cache key from the cache URL

content/workers/examples/cache-post-request.md

@@ -64,7 +64,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request, env: unknown, ctx: ExecutionContext) {
+  async fetch(request: Request, env: unknown, ctx: ExecutionContext): Promise<Response> {
     async function sha256(message) {
       // encode as UTF-8
       const msgBuffer = await new TextEncoder().encode(message);

content/workers/examples/cache-tags.md

@@ -60,7 +60,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const requestUrl = new URL(request.url);
     const params = requestUrl.searchParams;
     const tags =

content/workers/examples/cache-using-fetch.md

@@ -130,7 +130,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     let url = new URL(request.url);
 
     if (Math.random() < 0.5) {

content/workers/examples/conditional-response.md

@@ -65,7 +65,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const BLOCKED_HOSTNAMES = ["nope.mywebsite.com", "bye.website.com"];
     // Return a new Response based on a URL's hostname
     const url = new URL(request.url);

content/workers/examples/cors-header-proxy.md

@@ -171,7 +171,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const corsHeaders = {
       "Access-Control-Allow-Origin": "*",
       "Access-Control-Allow-Methods": "GET,HEAD,POST,OPTIONS",

content/workers/examples/country-code-redirect.md

@@ -48,7 +48,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * A map of the URLs to redirect to
      * @param {Object} countryMap

content/workers/examples/data-loss-prevention.md

@@ -89,7 +89,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const DEBUG = true;
     const SOME_HOOK_SERVER = "https://webhook.flow-wolf.io/hook";
 

content/workers/examples/debugging-logs.md

@@ -61,7 +61,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request, env: unknown, ctx: ExecutionContext) {
+  async fetch(request: Request, env: unknown, ctx: ExecutionContext): Promise<Response> {
     // Service configured to receive logs
     const LOG_URL = "https://log-service.example.com/";
 

content/workers/examples/extract-cookie-value.md

@@ -35,7 +35,7 @@ export default {
 ```ts
 import { parse } from "cookie";
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     // The name of the cookie
     const COOKIE_NAME = "__uid";
     const cookie = parse(request.headers.get("Cookie") || "");

content/workers/examples/fetch-html.md

@@ -21,7 +21,7 @@ updated: 2024-01-11
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * Replace `remote` with the host you wish to send requests to
      */

content/workers/examples/fetch-json.md

@@ -57,7 +57,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request, env: unknown, ctx: ExecutionContext) {
+  async fetch(request: Request, env: unknown, ctx: ExecutionContext): Promise<Response> {
     /**
      * Example someHost is set up to take in a JSON request
      * Replace url with the host you wish to send requests to

content/workers/examples/geolocation-app-weather.md

@@ -68,7 +68,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     let endpoint = "https://api.waqi.info/feed/geo:";
     const token = ""; //Use a token from https://aqicn.org/api/
     let html_style = `body{padding:6em; font-family: sans-serif;} h1{color:#f6821f}`;

content/workers/examples/geolocation-custom-styling.md

@@ -186,7 +186,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     let grads = [
       [
         { color: "00000c", position: 0 },

content/workers/examples/geolocation-hello-world.md

@@ -60,7 +60,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     let html_content = "";
     let html_style =
       "body{padding:6em; font-family: sans-serif;} h1{color:#f6821f;}";

content/workers/examples/hot-link-protection.md

@@ -47,7 +47,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const HOMEPAGE_URL = "https://tutorial.cloudflareworkers.com/";
     const PROTECTED_TYPE = "image/";
 

content/workers/examples/images-workers.md

@@ -41,7 +41,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     // You can find this in the dashboard, it should look something like this: ZWd9g1K7eljCn_KDTu_MWA
     const accountHash = "";
 

content/workers/examples/logging-headers.md

@@ -29,7 +29,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     console.log(new Map(request.headers));
     return new Response("Hello world");
   },

content/workers/examples/modify-request-property.md

@@ -76,7 +76,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * Example someHost is set up to return raw JSON
      * @param {string} someUrl the URL to send the request to, since we are setting hostname too only path is applied

content/workers/examples/modify-response.md

@@ -67,7 +67,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * @param {string} headerNameSrc Header to get the new value from
      * @param {string} headerNameDst Header to set based off of value in src

content/workers/examples/post-json.md

@@ -67,7 +67,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * Example someHost is set up to take in a JSON request
      * Replace url with the host you wish to send requests to

content/workers/examples/read-post.md

@@ -77,7 +77,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     /**
      * rawHtmlResponse returns HTML inputted directly
      * into the worker script

content/workers/examples/redirect.md

@@ -60,7 +60,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const base = "https://example.com";
     const statusCode = 301;
 

content/workers/examples/respond-with-another-site.md

@@ -21,7 +21,7 @@ layout: example
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     async function MethodNotAllowed(request) {
       return new Response(`Method ${request.method} not allowed.`, {
         status: 405,

content/workers/examples/return-html.md

@@ -21,7 +21,7 @@ updated: 2024-01-11
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const html = `<!DOCTYPE html>
 		<body>
 		  <h1>Hello World</h1>

content/workers/examples/return-json.md

@@ -23,7 +23,7 @@ updated: 2024-01-11
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const data = {
       hello: "world",
     };

content/workers/examples/rewrite-links.md

@@ -57,7 +57,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const OLD_URL = "developer.mozilla.org";
     const NEW_URL = "mynewdomain.com";
 

content/workers/examples/security-headers.md

@@ -106,7 +106,7 @@ export default {
 
 ```ts
 export default {
-  async fetch(request: Request) {
+  async fetch(request: Request): Promise<Response> {
     const DEFAULT_SECURITY_HEADERS = {
       /*
     Secure your application with Content-Security-Policy headers.

content/workers/examples/signing-requests.md

@@ -148,7 +148,7 @@ const encoder = new TextEncoder();
 const EXPIRY = 60;
 
 export default {
-  async fetch(request: Request, env: { SECRET_DATA: string }) {
+  async fetch(request: Request, env: { SECRET_DATA: string }): Promise<Response> {
     // You will need some secret data to use as a symmetric key. This should be
     // attached to your Worker as an encrypted secret.
     // Refer to https://developers.cloudflare.com/workers/configuration/secrets/