docs: review comments

dreamorosi · dreamorosi · commit a8ee8d16a2a1 · 2023-01-10T16:41:23.000+01:00
diff --git a/docs/snippets/parameters/adjustingCacheTTL.ts b/docs/snippets/parameters/adjustingCacheTTL.ts
@@ -2,14 +2,14 @@ import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
 
 const parametersProvider = new SSMProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const parameter = await parametersProvider.get('/my/parameter', { maxAge: 60 }); // 1 minute
   console.log(parameter);
 
   // Retrieve multiple parameters from a path prefix
   const parameters = await parametersProvider.getMultiple('/my/path/prefix', { maxAge: 120 }); // 2 minutes
-  for (const [ key, value ] of Object.entries(parameters)) {
+  for (const [ key, value ] of Object.entries(parameters || {})) {
     console.log(`${key}: ${value}`);
   }
 };
diff --git a/docs/snippets/parameters/appConfigProvider.ts b/docs/snippets/parameters/appConfigProvider.ts
@@ -8,7 +8,7 @@ const configsProvider = new AppConfigProvider({
   clientConfig,
 });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a config
   const config = await configsProvider.get('my-config');
   console.log(config);
diff --git a/docs/snippets/parameters/appConfigProviderCustomClient.ts b/docs/snippets/parameters/appConfigProviderCustomClient.ts
@@ -6,7 +6,7 @@ const appConfigClient = new AppConfigDataClient({ region: 'us-east-1' });
 // pass the client to the provider
 const configsProvider = new AppConfigProvider({ awsSdkV3Client: appConfigClient });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const config = await configsProvider.get('my-config');
   console.log(config);
 };
diff --git a/docs/snippets/parameters/clientConfig.ts b/docs/snippets/parameters/clientConfig.ts
@@ -4,7 +4,7 @@ import type { SSMClientConfig } from '@aws-sdk/client-ssm';
 const clientConfig: SSMClientConfig = { region: 'us-east-1' };
 const parametersProvider = new SSMProvider({ clientConfig });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const value = await parametersProvider.get('/my/parameter');
   console.log(value);
diff --git a/docs/snippets/parameters/dynamoDBProvider.ts b/docs/snippets/parameters/dynamoDBProvider.ts
@@ -2,7 +2,7 @@ import { DynamoDBProvider } from '@aws-lambda-powertools/parameters/dynamodb';
 
 const dynamoDBProvider = new DynamoDBProvider({ tableName: 'my-table' });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a value from DynamoDB
   const value = await dynamoDBProvider.get('my-parameter');
   console.log(value);
diff --git a/docs/snippets/parameters/dynamoDBProviderCustomClient.ts b/docs/snippets/parameters/dynamoDBProviderCustomClient.ts
@@ -6,7 +6,7 @@ const dynamoDBClient = new DynamoDBClient({ region: 'us-east-1' });
 // pass the client to the provider
 const valuesProvider = new DynamoDBProvider({ awsSdkV3Client: dynamoDBClient });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single value
   const value = await valuesProvider.get('my-value');
   console.log(value);
diff --git a/docs/snippets/parameters/dynamoDBProviderCustomizeTable.ts b/docs/snippets/parameters/dynamoDBProviderCustomizeTable.ts
@@ -7,7 +7,7 @@ const dynamoDBProvider = new DynamoDBProvider({
   valueAttr:'val'
 });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const value = await dynamoDBProvider.get('my-parameter');
   console.log(value);
 };
diff --git a/docs/snippets/parameters/dynamoDBProviderLocal.ts b/docs/snippets/parameters/dynamoDBProviderLocal.ts
@@ -7,7 +7,7 @@ const dynamoDBProvider = new DynamoDBProvider({
 	  },
 });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a value from DynamoDB
   const value = await dynamoDBProvider.get('my-parameter');
   console.log(value);
diff --git a/docs/snippets/parameters/dynamoDBProviderMultiple.ts b/docs/snippets/parameters/dynamoDBProviderMultiple.ts
@@ -2,13 +2,13 @@ import { DynamoDBProvider } from '@aws-lambda-powertools/parameters/dynamodb';
 
 const dynamoDBProvider = new DynamoDBProvider({ tableName: 'my-table' });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   /**
 	 * Retrieve multiple values by performing a Query on the DynamoDB table.
 	 * This returns a dict with the sort key attribute as dict key.
 	 */
   const values = await dynamoDBProvider.getMultiple('my-hash-key');
-  for (const [ key, value ] of Object.entries(values)) {
+  for (const [ key, value ] of Object.entries(values || {})) {
     // key: param-a
     // value: my-value-a
     console.log(`${key}: ${value}`);
diff --git a/docs/snippets/parameters/forceFetch.ts b/docs/snippets/parameters/forceFetch.ts
@@ -1,6 +1,6 @@
 import { getParameter } from '@aws-lambda-powertools/parameters/ssm';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const parameter = await getParameter('/my/parameter', { forceFetch: true });
   console.log(parameter);
diff --git a/docs/snippets/parameters/getAppConfig.ts b/docs/snippets/parameters/getAppConfig.ts
@@ -1,6 +1,6 @@
 import { getAppConfig } from '@aws-lambda-powertools/parameters/appconfig';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a configuration, latest version
   const config = await getAppConfig('my-configuration', {
     environment: 'my-env',
diff --git a/docs/snippets/parameters/getParameter.ts b/docs/snippets/parameters/getParameter.ts
@@ -1,6 +1,6 @@
 import { getParameter } from '@aws-lambda-powertools/parameters/ssm';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const parameter = await getParameter('/my/parameter');
   console.log(parameter);
diff --git a/docs/snippets/parameters/getParameters.ts b/docs/snippets/parameters/getParameters.ts
@@ -1,12 +1,12 @@
 import { getParameters } from '@aws-lambda-powertools/parameters/ssm';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   /**
    * Retrieve multiple parameters from a path prefix recursively.
    * This returns an object with the parameter name as key
    */ 
   const parameters = await getParameters('/my/path/prefix');
-  for (const [ key, value ] of Object.entries(parameters)) {
+  for (const [ key, value ] of Object.entries(parameters || {})) {
     console.log(`${key}: ${value}`);
   }
 };
diff --git a/docs/snippets/parameters/getParametersByName.ts b/docs/snippets/parameters/getParametersByName.ts
@@ -1,12 +1,15 @@
 import { getParametersByName } from '@aws-lambda-powertools/parameters/ssm';
+import type {
+  SSMGetParametersByNameOptionsInterface
+} from '@aws-lambda-powertools/parameters/ssm';
 
-const props = {
+const props: Record<string, SSMGetParametersByNameOptionsInterface> = {
   '/develop/service/commons/telemetry/config': { maxAge: 300, transform: 'json' },
   '/no_cache_param': { maxAge: 0 },
   '/develop/service/payment/api/capture/url': {}, // When empty or undefined, it uses default values
 };
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // This returns an object with the parameter name as key
   const parameters = await getParametersByName(props, { maxAge: 60 });
   for (const [ key, value ] of Object.entries(parameters)) {
diff --git a/docs/snippets/parameters/getParametersByNameGracefulErrorHandling.ts b/docs/snippets/parameters/getParametersByNameGracefulErrorHandling.ts
@@ -1,11 +1,14 @@
 import { getParametersByName } from '@aws-lambda-powertools/parameters/ssm';
+import type {
+  SSMGetParametersByNameOptionsInterface
+} from '@aws-lambda-powertools/parameters/ssm';
 
-const props = {
+const props: Record<string, SSMGetParametersByNameOptionsInterface> = {
   '/develop/service/commons/telemetry/config': { maxAge: 300, transform: 'json' },
   '/this/param/does/not/exist': {}, // <- Example of non-existent parameter
 };
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const {
     _errors: errors,
     ...parameters
diff --git a/docs/snippets/parameters/getSecret.ts b/docs/snippets/parameters/getSecret.ts
@@ -1,6 +1,6 @@
 import { getSecret } from '@aws-lambda-powertools/parameters/secrets';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single secret
   const secret = await getSecret('my-secret');
   console.log(secret);
diff --git a/docs/snippets/parameters/sdkOptions.ts b/docs/snippets/parameters/sdkOptions.ts
@@ -3,7 +3,7 @@ import type { GetSecretValueCommandInput } from '@aws-sdk/client-secrets-manager
 
 const secretsProvider = new SecretsProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const sdkOptions: Partial<GetSecretValueCommandInput> = {
     VersionId: 'e62ec170-6b01-48c7-94f3-d7497851a8d2'
   };
diff --git a/docs/snippets/parameters/secretsProvider.ts b/docs/snippets/parameters/secretsProvider.ts
@@ -4,7 +4,7 @@ import type { SecretsManagerClientConfig } from '@aws-sdk/client-secretsmanager'
 const clientConfig: SecretsManagerClientConfig = { region: 'us-east-1' };
 const secretsProvider = new SecretsProvider({ clientConfig });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single secret
   const secret = await secretsProvider.get('my-secret');
   console.log(secret);
diff --git a/docs/snippets/parameters/secretsProviderCustomClient.ts b/docs/snippets/parameters/secretsProviderCustomClient.ts
@@ -6,7 +6,7 @@ const secretsManagerClient = new SecretsManagerClient({ region: 'us-east-1' });
 // pass the client to the provider
 const secretsProvider = new SecretsProvider({ awsSdkV3Client: secretsManagerClient });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single secret
   const secret = await secretsProvider.get('my-secret');
   console.log(secret);
diff --git a/docs/snippets/parameters/ssmProvider.ts b/docs/snippets/parameters/ssmProvider.ts
@@ -4,14 +4,14 @@ import type { SSMClientConfig } from '@aws-sdk/client-ssm';
 const clientConfig: SSMClientConfig = { region: 'us-east-1' };
 const parametersProvider = new SSMProvider({ clientConfig });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const parameter = await parametersProvider.get('/my/parameter');
   console.log(parameter);
 
   // Retrieve multiple parameters from a path prefix
   const parameters = await parametersProvider.getMultiple('/my/path/prefix');
-  for (const [ key, value ] of Object.entries(parameters)) {
+  for (const [ key, value ] of Object.entries(parameters || {})) {
     console.log(`${key}: ${value}`);
   }
 };
diff --git a/docs/snippets/parameters/ssmProviderCustomClient.ts b/docs/snippets/parameters/ssmProviderCustomClient.ts
@@ -6,7 +6,7 @@ const ssmClient = new SSMClient({ region: 'us-east-1' });
 // pass the client to the provider
 const parametersProvider = new SSMProvider({ awsSdkV3Client: ssmClient });
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Retrieve a single parameter
   const parameter = await parametersProvider.get('/my/parameter');
   console.log(parameter);
diff --git a/docs/snippets/parameters/ssmProviderDecryptAndRecursive.ts b/docs/snippets/parameters/ssmProviderDecryptAndRecursive.ts
@@ -2,12 +2,12 @@ import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
 
 const parametersProvider = new SSMProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const decryptedValue = await parametersProvider.get('/my/encrypted/parameter', { decrypt: true });
   console.log(decryptedValue);
 
   const noRecursiveValues = await parametersProvider.getMultiple('/my/path/prefix', { recursive: false });
-  for (const [ key, value ] of Object.entries(noRecursiveValues)) {
+  for (const [ key, value ] of Object.entries(noRecursiveValues || {})) {
     console.log(`${key}: ${value}`);
   }
 };
diff --git a/docs/snippets/parameters/transform.ts b/docs/snippets/parameters/transform.ts
@@ -1,6 +1,6 @@
 import { getParameter } from '@aws-lambda-powertools/parameters/ssm';
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const valueFromJson = await getParameter('/my/json/parameter', { transform: 'json' });
   console.log(valueFromJson);
 };
diff --git a/docs/snippets/parameters/transformAuto.ts b/docs/snippets/parameters/transformAuto.ts
@@ -2,9 +2,9 @@ import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
 
 const parametersProvider = new SSMProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   const values = await parametersProvider.getMultiple('/param', { transform: 'auto' });
-  for (const [ key, value ] of Object.entries(values)) {
+  for (const [ key, value ] of Object.entries(values || {})) {
     console.log(`${key}: ${value}`);
   }
 };
diff --git a/docs/snippets/parameters/transformPartialFailures.ts b/docs/snippets/parameters/transformPartialFailures.ts
@@ -2,15 +2,15 @@ import { SSMProvider } from '@aws-lambda-powertools/parameters/ssm';
 
 const parametersProvider = new SSMProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   /**
    * This will display:
    * /param/a: [some value]
    * /param/b: [some value]
    * /param/c: undefined
    */
   const parameters = await parametersProvider.getMultiple('/param', { transform: 'json' });
-  for (const [ key, value ] of Object.entries(parameters)) {
+  for (const [ key, value ] of Object.entries(parameters || {})) {
     console.log(`${key}: ${value}`);
   }
 
@@ -20,7 +20,7 @@ export const handler = async (_event, _context): Promise<void> => {
       transform: 'json',
       throwOnTransformError: true
     });
-    for (const [ key, value ] of Object.entries(parameters2)) {
+    for (const [ key, value ] of Object.entries(parameters2 || {})) {
       console.log(`${key}: ${value}`);
     }
   } catch (err) {
diff --git a/docs/snippets/parameters/transformProvider.ts b/docs/snippets/parameters/transformProvider.ts
@@ -2,7 +2,7 @@ import { SecretsProvider } from '@aws-lambda-powertools/parameters/secrets';
 
 const secretsProvider = new SecretsProvider();
 
-export const handler = async (_event, _context): Promise<void> => {
+export const handler = async (): Promise<void> => {
   // Transform a JSON string
   const json = await secretsProvider.get('my-secret-json', { transform: 'json' });
   console.log(json);
diff --git a/docs/snippets/parameters/tsconfig.json b/docs/snippets/parameters/tsconfig.json
@@ -0,0 +1,48 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "target": "ES2020",
+    "module": "commonjs",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "lib",
+    "removeComments": false,
+    "strict": true,
+    "inlineSourceMap": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "pretty": true,
+    "esModuleInterop": true,
+    "allowJs": true,
+    "baseUrl": ".",
+    "paths": {
+      "@aws-lambda-powertools/parameters/ssm": [
+        "../../../packages/parameters/lib/ssm"
+      ],
+      "@aws-lambda-powertools/parameters/secrets": [
+        "../../../packages/parameters/lib/secrets"
+      ],
+      "@aws-lambda-powertools/parameters/appconfig": [
+        "../../../packages/parameters/lib/appconfig"
+      ],
+      "@aws-lambda-powertools/parameters/dynamodb": [
+        "../../../packages/parameters/lib/dynamodb"
+      ],
+    },
+  },
+  "exclude": [
+    "./node_modules"
+  ],
+  "watchOptions": {
+    "watchFile": "useFsEvents",
+    "watchDirectory": "useFsEvents",
+    "fallbackPolling": "dynamicPriority"
+  },
+  "lib": [
+    "ES2020"
+  ],
+  "types": [
+    "node"
+  ]
+}
diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md
