style(parameters): apply stricter linting

dreamorosi · dreamorosi · commit 074d644be774 · 2025-09-25T19:47:29.000+02:00
diff --git a/packages/parameters/src/appconfig/AppConfigProvider.ts b/packages/parameters/src/appconfig/AppConfigProvider.ts
@@ -231,12 +231,12 @@ class AppConfigProvider extends BaseProvider {
    *
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
-   * @param name - The name of the configuration profile or its ID
-   * @param options - Options to configure the provider
-   * @param options.maxAge - Maximum age of the value in the cache, in seconds.
-   * @param options.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
-   * @param options.sdkOptions - Additional options to pass to the AWS SDK v3 client. Supports all options from {@link StartConfigurationSessionCommandInput | `StartConfigurationSessionCommandInput`} except `ApplicationIdentifier`, `EnvironmentIdentifier`, and `ConfigurationProfileIdentifier`.
-   * @param options.transform - Optional transform to be applied, can be 'json' or 'binary'.
+   * @param name - The name of the configuration profile to retrieve
+   * @param options - Optional options to configure the provider
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link StartConfigurationSessionCommandInput | `StartConfigurationSessionCommandInput`} except `ApplicationIdentifier`, `EnvironmentIdentifier`, and `ConfigurationProfileIdentifier`
    */
   public get<
     ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/appconfig/getAppConfig.ts b/packages/parameters/src/appconfig/getAppConfig.ts
@@ -133,14 +133,14 @@ import { AppConfigProvider } from './AppConfigProvider.js';
  *
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
  *
- * @param name - The name of the configuration profile or its ID
+ * @param name - The name of the configuration profile to retrieve
  * @param options - Options to configure the provider
- * @param options.application - The application ID or the application name.
- * @param options.environment - The environment ID or the environment name.
- * @param options.maxAge - The maximum age (in seconds) to keep values in cache. Default: 5 seconds.
- * @param options.forceFetch - Whether to skip the cache and always fetch the latest value from the store. Default: `false`.
- * @param options.transform - Optional transformation to apply to the retrieved value. Supported options are: 'json' and 'binary'.
- * @param options.sdkOptions - Optional extra options to pass to the AWS SDK v3 for JavaScript client when retrieving the configuration profile.
+ * @param options.application - The application ID or the application name
+ * @param options.environment - The environment ID or the environment name
+ * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+ * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+ * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+ * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link StartConfigurationSessionCommandInput | `StartConfigurationSessionCommandInput`} except `ApplicationIdentifier`, `EnvironmentIdentifier`, and `ConfigurationProfileIdentifier`
  */
 const getAppConfig = <
   ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/dynamodb/DynamoDBProvider.ts b/packages/parameters/src/dynamodb/DynamoDBProvider.ts
@@ -268,12 +268,12 @@ class DynamoDBProvider extends BaseProvider {
    *
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
-   * @param name - The name of the value to retrieve (i.e. the partition key)
-   * @param options - Options to configure the provider
-   * @param options.maxAge - Maximum age of the value in the cache, in seconds.
-   * @param options.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
-   * @param options.sdkOptions - Additional options to pass to the AWS SDK v3 client, supports all options from {@link GetItemCommandInput | `GetItemCommandInput`} except `Key`, `TableName`, and `ProjectionExpression`.
-   * @param options.transform - Transform to be applied, can be 'json' or 'binary'.
+   * @param name - The name of the value to retrieve (partition key)
+   * @param options - Optional options to configure the provider
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetItemCommandInput | `GetItemCommandInput`} except `Key`, `TableName`, and `ProjectionExpression`
    */
   public get<
     ExplicitUserProvidedType = undefined,
@@ -312,13 +312,13 @@ class DynamoDBProvider extends BaseProvider {
    *
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
-   * @param path - The path of the values to retrieve (i.e. the partition key)
-   * @param options - Options to configure the provider
-   * @param options.maxAge - Maximum age of the value in the cache, in seconds.
-   * @param options.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
-   * @param options.sdkOptions - Additional options to pass to the AWS SDK v3 client, supports all options from {@link QueryCommandInput | `QueryCommandInput`} except `TableName` and `KeyConditionExpression`.
-   * @param options.transform - Transform to be applied, can be 'json' or 'binary'.
-   * @param options.throwOnTransformError - Whether to throw an error if the transform fails (default: `true`)
+   * @param path - The path of the values to retrieve (partition key)
+   * @param options - Optional options to configure the provider
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link QueryCommandInput | `QueryCommandInput`} except `TableName` and `KeyConditionExpression`
+   * @param options.throwOnTransformError - Optional flag to throw an error if the transform fails (default: `true`)
    */
   public getMultiple<
     ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/secrets/SecretsProvider.ts b/packages/parameters/src/secrets/SecretsProvider.ts
@@ -166,12 +166,12 @@ class SecretsProvider extends BaseProvider {
    *
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
-   * @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.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
-   * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client
+   * @param name - The name of the secret to retrieve
+   * @param options - Optional options to configure the provider
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetSecretValueCommandInput | `GetSecretValueCommandInput`} except `SecretId`
    */
   public get<
     ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/secrets/getSecret.ts b/packages/parameters/src/secrets/getSecret.ts
@@ -1,4 +1,3 @@
-import type { SecretsManagerClientConfig } from '@aws-sdk/client-secrets-manager';
 import { DEFAULT_PROVIDERS } from '../base/DefaultProviders.js';
 import type {
   SecretsGetOptions,
@@ -92,11 +91,11 @@ import { SecretsProvider } from './SecretsProvider.js';
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
  *
  * @param name - The name of the secret to retrieve
- * @param options - Options to configure the provider
- * @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 (default: `false`)
- * @param options.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
- * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client, accepts the same configuration object as the AWS SDK v3 client ({@link SecretsManagerClientConfig | `SecretsManagerClientConfig`}).
+ * @param options - Optional options to configure the provider
+ * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+ * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+ * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+ * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetSecretValueCommandInput | `GetSecretValueCommandInput`} except `SecretId`
  */
 const getSecret = <
   ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/ssm/SSMProvider.ts b/packages/parameters/src/ssm/SSMProvider.ts
@@ -291,13 +291,13 @@ class SSMProvider extends BaseProvider {
 
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
-   * @param name - The name of the value to retrieve (i.e. the partition key)
-   * @param options - Options to configure the provider
-   * @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 (default: false)
-   * @param options.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
-   * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client
-   * @param options.decrypt - Whether to decrypt the value before returning it. (default: false)
+   * @param name - The name of the parameter to retrieve
+   * @param options - Optional options to configure the provider
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetParameterCommandInput | `GetParameterCommandInput`} except `Name`
+   * @param options.decrypt - Optional flag to decrypt the value before returning it (default: `false`)
    */
   public get<
     ExplicitUserProvidedType = undefined,
@@ -390,14 +390,14 @@ class SSMProvider extends BaseProvider {
    * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
    *
    * @param path - The path of the parameters to retrieve
-   * @param options - Options to configure the retrieval
-   * @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.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
-   * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client
-   * @param options.throwOnTransformError - Whether to throw an error if the transform fails (default: `true`)
-   * @param options.decrypt - Whether to decrypt the value before returning it.
-   * @param options.recursive - Whether to recursively retrieve all parameters under the given path (default: `false`)
+   * @param options - Optional options to configure the retrieval
+   * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+   * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+   * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+   * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetParametersByPathCommandInput | `GetParametersByPathCommandInput`} except `Path`
+   * @param options.throwOnTransformError - Optional flag to throw an error if the transform fails (default: `true`)
+   * @param options.decrypt - Optional flag to decrypt the value before returning it (default: `false`)
+   * @param options.recursive - Optional flag to recursively retrieve all parameters under the given path (default: `false`)
    */
   public getMultiple<
     ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/ssm/getParameter.ts b/packages/parameters/src/ssm/getParameter.ts
@@ -114,12 +114,12 @@ import { SSMProvider } from './SSMProvider.js';
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
  *
  * @param name - The name of the parameter to retrieve
- * @param options - Options to configure the provider
- * @param options.maxAge - Maximum age of the value in the cache, in seconds. Will be applied after the first API call.
- * @param options.forceFetch - Force fetch the value from the parameter store, ignoring the cache.
- * @param options.transform - Optional transform to be applied, can be 'json' or 'binary'.
- * @param options.sdkOptions - Additional options to pass to the AWS SDK v3 for JavaScript client. Supports all options from {@link GetParameterCommandInput | `GetParameterCommandInput`} except `Name`.
- * @param options.decrypt - Whether to decrypt the value before returning it. Defaults to `false`.
+ * @param options - Optional options to configure the provider
+ * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+ * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+ * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+ * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetParameterCommandInput | `GetParameterCommandInput`} except `Name`
+ * @param options.decrypt - Optional flag to decrypt the value before returning it (default: `false`)
  */
 const getParameter = <
   ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/src/ssm/getParameters.ts b/packages/parameters/src/ssm/getParameters.ts
@@ -115,13 +115,13 @@ import { SSMProvider } from './SSMProvider.js';
  * @see https://docs.powertools.aws.dev/lambda/typescript/latest/features/parameters/
  *
  * @param path - The path of the parameters to retrieve
- * @param options - Options to configure the provider
- * @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.transform - Whether to transform the value before returning it. Supported values: `json`, `binary`
- * @param options.sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client, accepts the same options as {@link GetParametersByPathCommandInput | `GetParametersByPathCommandInput`}.
- * @param options.decrypt - Whether to decrypt the value before returning it.
- * @param options.recursive - Whether to recursively retrieve all parameters within the path.
+ * @param options - Optional options to configure the provider
+ * @param options.maxAge - Optional maximum age of the value in the cache, in seconds (default: `5`)
+ * @param options.forceFetch - Optional flag to always fetch a new value from the store regardless if already available in cache (default: `false`)
+ * @param options.transform - Optional transform to be applied, can be `json` or `binary`
+ * @param options.sdkOptions - Optional additional options to pass to the AWS SDK v3 client, supports all options from {@link GetParametersByPathCommandInput | `GetParametersByPathCommandInput`} except `Path`
+ * @param options.decrypt - Optional flag to decrypt the value before returning it (default: `false`)
+ * @param options.recursive - Optional flag to recursively retrieve all parameters within the path (default: `false`)
  */
 const getParameters = <
   ExplicitUserProvidedType = undefined,
diff --git a/packages/parameters/typedoc.json b/packages/parameters/typedoc.json
@@ -16,16 +16,16 @@
   "readme": "README.md",
   "externalSymbolLinkMappings": {
     "@aws-sdk/client-secrets-manager": {
-      "GetSecretValueCommandInput": "#"
+      "GetSecretValueCommandInput": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-secrets-manager/Interface/GetSecretValueCommandInput/"
     },
     "@aws-sdk/client-dynamodb": {
-      "DynamoDBClient": "#",
-      "GetItemCommandInput": "#",
-      "QueryCommandInput": "#"
+      "DynamoDBClient": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/",
+      "GetItemCommandInput": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dynamodb/Interface/GetItemCommandInput/",
+      "QueryCommandInput": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dynamodb/Interface/QueryCommandInput/"
     },
     "@aws-sdk/client-appconfigdata": {
-      "AppConfigDataClient": "#",
-      "StartConfigurationSessionCommandInput": "#"
+      "AppConfigDataClient": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/appconfigdata/",
+      "StartConfigurationSessionCommandInput": "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-appconfigdata/Interface/StartConfigurationSessionCommandInput/"
     },
     "@aws-sdk/client-ssm": { "GetParameterCommandInput": "#" }
   }
