style(docs): apply stricter linting

biome.json

@@ -1,5 +1,6 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.2.4/schema.json",
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "root": true,
   "assist": {
     "actions": {
       "source": {

docs/features/event-handler/appsync-events.md

@@ -210,7 +210,7 @@ When processing batch of items with `aggregate` enabled, you must format the pay
 
 === "Error handling with batch of items"
 
-    ```typescript hl_lines="21-24"
+    ```typescript hl_lines="25-28"
     --8<-- "examples/snippets/event-handler/appsync-events/errorHandlingWithBatchOfItems.ts"
     ```
 

docs/features/event-handler/appsync-graphql.md

@@ -176,7 +176,7 @@ You can use an AppSync JavaScript resolver or a VTL response mapping template to
 
 === "Exception Handling response"
 
-    ```json hl_lines="11 20"
+    ```json hl_lines="9 18"
     --8<-- "examples/snippets/event-handler/appsync-graphql/exceptionHandlingResponse.json"
     ```
 

docs/features/event-handler/rest.md

@@ -479,7 +479,7 @@ You can enable response compression by using the `compress` middleware. This wil
 
 === "Response"
 
-    ```json hl_lines="7-9 11 12"
+    ```json hl_lines="4-5 7-8"
     --8<-- "examples/snippets/event-handler/rest/samples/advanced_compress_res.json"
     ```
 

docs/features/tracer.md

@@ -230,7 +230,7 @@ You can trace other class methods using the `captureMethod` decorator or any arb
 
 === "Manual"
 
-    ```typescript hl_lines="7-13 19 22 26-31"
+    ```typescript hl_lines="7-10 16 21 25 27"
     --8<-- "examples/snippets/tracer/captureMethodManual.ts"
     ```
 

examples/snippets/batch/advancedTracingRecordHandler.ts

@@ -22,7 +22,7 @@ const recordHandler = async (record: SQSRecord): Promise<void> => {
       // do something with the item
       subsegment?.addMetadata('item', item);
     } catch (error) {
-      subsegment?.addError(error);
+      subsegment?.addError(error as Error);
       throw error;
     }
   }

examples/snippets/biome.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "../../node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": "//",
+  "root": false,
+  "linter": {
+    "rules": {
+      "suspicious": {
+        "useAwait": "off"
+      }
+    }
+  }
+}

examples/snippets/event-handler/appsync-events/errorHandlingWithBatchOfItems.ts

@@ -18,9 +18,13 @@ app.onPublish(
           payload: { processed: true, original_payload: payload },
         });
       } catch (error) {
+        const errorString =
+          error instanceof Error
+            ? `${error.name} - ${error.message}`
+            : 'Unknown error';
         returnValues.push({
           id: payload.id,
-          error: `${error.name} - ${error.message}`,
+          error: errorString,
         });
       }
     }

examples/snippets/event-handler/appsync-graphql/advancedTestYourCode.ts

@@ -38,7 +38,7 @@ describe('Unit test for AppSync GraphQL Resolver', () => {
     const event = onGraphqlEventFactory('listLocations', 'Query');
 
     // Act
-    const result = (await handler(event, {} as Context)) as Promise<unknown[]>;
+    const result = (await handler(event, {} as Context)) as unknown[];
 
     // Assess
     expect(result).toHaveLength(2);

examples/snippets/event-handler/appsync-graphql/exceptionHandling.ts

@@ -1,6 +1,6 @@
+import { AssertionError } from 'node:assert';
 import { AppSyncGraphQLResolver } from '@aws-lambda-powertools/event-handler/appsync-graphql';
 import { Logger } from '@aws-lambda-powertools/logger';
-import { AssertionError } from 'node:assert';
 import type { Context } from 'aws-lambda';
 
 const logger = new Logger({

examples/snippets/event-handler/appsync-graphql/exceptionHandlingResponse.json

@@ -4,9 +4,7 @@
   },
   "errors": [
     {
-      "path": [
-        "createSomething"
-      ],
+      "path": ["createSomething"],
       "data": null,
       "errorType": "AssertionError",
       "errorInfo": null,
@@ -20,4 +18,4 @@
       "message": "This is an assertion Error"
     }
   ]
-}
+}

examples/snippets/event-handler/rest/samples/advanced_binary_req.json

@@ -6,4 +6,4 @@
   "resource": "/logo",
   "path": "/logo",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_binary_res.json

@@ -1,13 +1,9 @@
 {
   "body": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iMjU2cHgiIGhlaWdodD0iMjU2cHgiIHZpZXdCb3g9IjAgMCAyNTYgMjU2IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIj4KICAgIDx0aXRsZT5BV1MgTGFtYmRhPC90aXRsZT4KICAgIDxkZWZzPgogICAgICAgIDxsaW5lYXJHcmFkaWVudCB4MT0iMCUiIHkxPSIxMDAlIiB4Mj0iMTAwJSIgeTI9IjAlIiBpZD0ibGluZWFyR3JhZGllbnQtMSI+CiAgICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNDODUxMUIiIG9mZnNldD0iMCUiPjwvc3RvcD4KICAgICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iI0ZGOTkwMCIgb2Zmc2V0PSIxMDAlIj48L3N0b3A+CiAgICAgICAgPC9saW5lYXJHcmFkaWVudD4KICAgIDwvZGVmcz4KICAgIDxnPgogICAgICAgIDxyZWN0IGZpbGw9InVybCgjbGluZWFyR3JhZGllbnQtMSkiIHg9IjAiIHk9IjAiIHdpZHRoPSIyNTYiIGhlaWdodD0iMjU2Ij48L3JlY3Q+CiAgICAgICAgPHBhdGggZD0iTTg5LjYyNDExMjYsMjExLjIgTDQ5Ljg5MDMyNzcsMjExLjIgTDkzLjgzNTQ4MzIsMTE5LjM0NzIgTDExMy43NDcyOCwxNjAuMzM5MiBMODkuNjI0MTEyNiwyMTEuMiBaIE05Ni43MDI5MzU3LDExMC41Njk2IEM5Ni4xNjQwODU4LDEwOS40NjU2IDk1LjA0MTQ4MTMsMTA4Ljc2NDggOTMuODE2MjM4NCwxMDguNzY0OCBMOTMuODA2NjE2MywxMDguNzY0OCBDOTIuNTcxNzUxNCwxMDguNzY4IDkxLjQ0OTE0NjYsMTA5LjQ3NTIgOTAuOTE5OTE4NywxMTAuNTg1NiBMNDEuOTEzNDIwOCwyMTMuMDIwOCBDNDEuNDM4NzE5NywyMTQuMDEyOCA0MS41MDYwNzU4LDIxNS4xNzc2IDQyLjA5NjI0NTEsMjE2LjEwODggQzQyLjY3OTk5OTQsMjE3LjAzNjggNDMuNzA2MzgwNSwyMTcuNiA0NC44MDY1MzMxLDIxNy42IEw5MS42NTQ0MjMsMjE3LjYgQzkyLjg5NTcwMjcsMjE3LjYgOTQuMDIxNTE0OSwyMTYuODg2NCA5NC41NTM5NTAxLDIxNS43Njk2IEwxMjAuMjAzODU5LDE2MS42ODk2IEMxMjAuNjE3NjE5LDE2MC44MTI4IDEyMC42MTQ0MTIsMTU5Ljc5ODQgMTIwLjE4NzgyMiwxNTguOTI4IEw5Ni43MDI5MzU3LDExMC41Njk2IFogTTIwNy45ODUxMTcsMjExLjIgTDE2OC41MDc5MjgsMjExLjIgTDEwNS4xNzM3ODksNzguNjI0IEMxMDQuNjQ0NTYxLDc3LjUxMDQgMTAzLjUxNTU0MSw3Ni44IDEwMi4yNzc0NjksNzYuOCBMNzYuNDQ3OTQzLDc2LjggTDc2LjQ3NjgwOTksNDQuOCBMMTI3LjEwMzA2Niw0NC44IEwxOTAuMTQ1MzI4LDE3Ny4zNzI4IEMxOTAuNjc0NTU2LDE3OC40ODY0IDE5MS44MDM1NzUsMTc5LjIgMTkzLjA0MTY0NywxNzkuMiBMMjA3Ljk4NTExNywxNzkuMiBMMjA3Ljk4NTExNywyMTEuMiBaIE0yMTEuMTkyNTU4LDE3Mi44IEwxOTUuMDcxOTU4LDE3Mi44IEwxMzIuMDI5Njk2LDQwLjIyNzIgQzEzMS41MDA0NjgsMzkuMTEzNiAxMzAuMzcxNDQ5LDM4LjQgMTI5LjEzMDE2OSwzOC40IEw3My4yNzI1NzYsMzguNCBDNzEuNTA1Mjc1OCwzOC40IDcwLjA2ODM0MjEsMzkuODMwNCA3MC4wNjUxMzQ0LDQxLjU5NjggTDcwLjAyOTg1MjgsNzkuOTk2OCBDNzAuMDI5ODUyOCw4MC44NDggNzAuMzYzNDI2Niw4MS42NjA4IDcwLjk2OTYzMyw4Mi4yNjI0IEM3MS41Njk0MjQ2LDgyLjg2NCA3Mi4zODQxMTQ2LDgzLjIgNzMuMjM3Mjk0MSw4My4yIEwxMDAuMjUzNTczLDgzLjIgTDE2My41OTA5MiwyMTUuNzc2IEMxNjQuMTIzMzU1LDIxNi44ODk2IDE2NS4yNDU5NiwyMTcuNiAxNjYuNDg0MDMyLDIxNy42IEwyMTEuMTkyNTU4LDIxNy42IEMyMTIuOTY2Mjc0LDIxNy42IDIxNC40LDIxNi4xNjY0IDIxNC40LDIxNC40IEwyMTQuNCwxNzYgQzIxNC40LDE3NC4yMzM2IDIxMi45NjYyNzQsMTcyLjggMjExLjE5MjU1OCwxNzIuOCBMMjExLjE5MjU1OCwxNzIuOCBaIiBmaWxsPSIjRkZGRkZGIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==",
   "multiValueHeaders": {
-    "Content-Type": [
-      "image/png"
-    ],
-    "Content-Encoding": [
-      "gzip"
-    ]
+    "Content-Type": ["image/png"],
+    "Content-Encoding": ["gzip"]
   },
   "isBase64Encoded": true,
   "statusCode": 200
-}
+}

examples/snippets/event-handler/rest/samples/advanced_compress_req.json

@@ -5,4 +5,4 @@
   "resource": "/todos/1",
   "path": "/todos/1",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_compress_res.json

@@ -1,13 +1,9 @@
 {
   "statusCode": 200,
   "multiValueHeaders": {
-    "Content-Type": [
-      "application/json"
-    ],
-    "Content-Encoding": [
-      "gzip"
-    ]
+    "Content-Type": ["application/json"],
+    "Content-Encoding": ["gzip"]
   },
   "body": "H4sIAAAAAAACE42STU4DMQyFrxJl3QXln96AMyAW7sSDLCVxiJ0Kqerd8TCCUOgii1EmP/783pOPXjmw+N3L0TfB+hz8brvxtC5KGtHvfMCIkzZx0HT5MPmNnziViIr2dIYoeNr8Q1x3xHsjcVadIbkZJoq2RXU8zzQROLseQ9505NzeCNQdMJNBE+UmY4zbzjAJhWtlZ57sB84BWtul+rteH2HPlVgWARwjqXkxpklK5gmEHAQqJBMtFsGVygcKmNVRjG0wxvuzGF2L0dpVUOKMC3bfJNjJgWMrCuZk7cUp02AiD72D6WKHHwUDKbiJs6AZ0VZXKOUx4uNvzdxT+E4mLcMA+6G8nzrLQkaxkNEVrFKW2VGbJCoCY7q2V3+tiv5kGThyxfTecDWbgGz/NfYXhL6ePgF9PnFdPgMAAA==",
   "isBase64Encoded": true
-}
+}

examples/snippets/event-handler/rest/samples/advanced_cors_per_route.json

@@ -6,4 +6,4 @@
   },
   "body": "{\"status\":\"ok\"}",
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_cors_simple.json

@@ -24,4 +24,4 @@
   },
   "body": "{\"todoId\":\"123\",\"task\":\"Example task\",\"completed\":false}",
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_error_debug.json

@@ -6,4 +6,4 @@
   "details": {
     "errorName": "Name of the error class"
   }
-}
+}

examples/snippets/event-handler/rest/samples/advanced_error_prod.json

@@ -2,4 +2,4 @@
   "statusCode": 500,
   "error": "Internal Server Error",
   "message": "Internal Server Error"
-}
+}

examples/snippets/event-handler/rest/samples/advanced_fine_grained_responses.json

@@ -6,4 +6,4 @@
     "Location": "/todos/123"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_mw_early_return.json

@@ -5,4 +5,4 @@
     "Content-Type": "application/json"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/advanced_mw_middleware_order.json

@@ -7,4 +7,4 @@
     "x-post-processed-by": "global-middleware"
   },
   "isBase64Encoded": false
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_dynamic_routes.json

@@ -2,4 +2,4 @@
   "resource": "/todos/{id}",
   "path": "/todos/1",
   "httpMethod": "GET"
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_methods.json

@@ -3,4 +3,4 @@
   "path": "/todos",
   "httpMethod": "POST",
   "body": "{\"title\": \"foo\", \"userId\": 1, \"completed\": false}"
-}
+}

examples/snippets/event-handler/rest/samples/gettingStarted_serialization.json

@@ -5,4 +5,4 @@
   },
   "body": "{'message':'pong'}",
   "isBase64Encoded": false
-}
+}

examples/snippets/getting-started/patterns-functional.ts

@@ -18,7 +18,7 @@ export const handler = async (event: unknown, context: Context) => {
     throw new Error('An error occurred');
   } catch (error) {
     logger.error('Error occurred', { error });
-    tracer.addErrorAsMetadata(error);
+    tracer.addErrorAsMetadata(error as Error);
     throw error;
   } finally {
     subsegment?.close();

examples/snippets/logger/basicUsage.ts

@@ -2,6 +2,6 @@ import { Logger } from '@aws-lambda-powertools/logger';
 
 const logger = new Logger({ serviceName: 'serverlessAirline' });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async () => {
   logger.info('Hello World');
 };

examples/snippets/logger/unserializableValues.ts

@@ -1,12 +1,12 @@
 import { Logger } from '@aws-lambda-powertools/logger';
-import type { CustomReplacerFn } from '@aws-lambda-powertools/logger/types';
+import type { CustomJsonReplacerFn } from '@aws-lambda-powertools/logger/types';
 
-const jsonReplacerFn: CustomReplacerFn = (_: string, value: unknown) =>
+const jsonReplacerFn: CustomJsonReplacerFn = (_: string, value: unknown) =>
   value instanceof Set ? [...value] : value;
 
 const logger = new Logger({ serviceName: 'serverlessAirline', jsonReplacerFn });
 
-export const handler = async (): Promise<void> => {
+export const handler = async () => {
   logger.info('Serialize with custom serializer', {
     serializedValue: new Set([1, 2, 3]),
   });

examples/snippets/parameters/customProviderVault.ts

@@ -31,13 +31,11 @@ class HashiCorpVaultProvider extends BaseProvider {
   /**
    * Retrieve a secret from HashiCorp Vault.
    *
-   * You can customize the retrieval of the secret by passing options to the function:
-   * * `maxAge` - The maximum age of the value in cache before fetching a new one (in seconds) (default: 5)
-   * * `forceFetch` - Whether to always fetch a new value from the store regardless if already available in cache
-   * * `sdkOptions` - Extra options to pass to the HashiCorp Vault SDK, e.g. `mount` or `version`
-   *
    * @param name - The name of the secret
    * @param options - Options to customize the retrieval of the secret
+   * @param options.maxAge - The maximum age of the value in cache before fetching a new one (in seconds) (default: 5)
+   * @param options.forceFetch - Whether to always fetch a new value from the store regardless if already available in cache
+   * @param options.sdkOptions - Extra options to pass to the HashiCorp Vault SDK, e.g. `mount` or `version`
    */
   public async get<T extends Record<string, unknown>>(
     name: string,

examples/snippets/tracer/basicUsage.ts

@@ -2,6 +2,10 @@ import { Tracer } from '@aws-lambda-powertools/tracer';
 
 const tracer = new Tracer({ serviceName: 'serverlessAirline' });
 
-export const handler = async (_event, _context): Promise<void> => {
-  tracer.getSegment();
+export const handler = async () => {
+  const segment = tracer.getSegment();
+  const subsegment = segment?.addNewSubsegment('subsegment');
+  subsegment?.addAnnotation('annotationKey', 'annotationValue');
+  subsegment?.addMetadata('metadataKey', { foo: 'bar' });
+  subsegment?.close();
 };

examples/snippets/tracer/captureMethodManual.ts

@@ -6,31 +6,26 @@ const tracer = new Tracer({ serviceName: 'serverlessAirline' });
 const getChargeId = async (): Promise<unknown> => {
   const parentSubsegment = tracer.getSegment(); // This is the subsegment currently active
   let subsegment: Subsegment | undefined;
-  if (parentSubsegment) {
-    // Create subsegment for the function & set it as active
-    subsegment = parentSubsegment.addNewSubsegment('### chargeId');
-    tracer.setSegment(subsegment);
-  }
+  subsegment = parentSubsegment?.addNewSubsegment('### chargeId');
+  subsegment && tracer.setSegment(subsegment);
 
-  let res: unknown;
   try {
-    /* ... */
+    const res = { chargeId: '1234' };
+
     // Add the response as metadata
     tracer.addResponseAsMetadata(res, 'chargeId');
+
+    return res;
   } catch (err) {
     // Add the error as metadata
     tracer.addErrorAsMetadata(err as Error);
     throw err;
+  } finally {
+    // Close subsegment
+    subsegment?.close();
+    // Set the facade segment as active again, it'll be closed automatically
+    parentSubsegment && tracer.setSegment(parentSubsegment);
   }
-
-  if (parentSubsegment && subsegment) {
-    // Close subsegment (the AWS Lambda one is closed automatically)
-    subsegment.close();
-    // Set the facade segment as active again
-    tracer.setSegment(parentSubsegment);
-  }
-
-  return res;
 };
 
 export const handler = async (