Skip to content

Commit 2f9901d

Browse files
committed
chore: update API docs
1 parent 95e5095 commit 2f9901d

File tree

5 files changed

+5
-16
lines changed

5 files changed

+5
-16
lines changed

docs/features/logger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ These settings will be used across all logs emitted:
5858

5959
See all environment variables in the [Environment variables](../environment-variables.md) section.
6060

61-
Check API docs to learn more about [Logger constructor options](https://docs.aws.amazon.com/powertools/typescript/latest/api/types/_aws_lambda_powertools_logger.types.ConstructorOptions.html){target="_blank"}.
61+
Check API docs to learn more about [Logger constructor options](https://docs.aws.amazon.com/powertools/typescript/latest/api/types/_aws-lambda-powertools_logger.types.ConstructorOptions.html){target="_blank"}.
6262

6363
#### Example using AWS Serverless Application Model (SAM)
6464

docs/features/tracer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ Tracer exposes a `getRootXrayTraceId()` method that allows you to retrieve the [
369369

370370
### Escape hatch mechanism
371371

372-
You can use `tracer.provider` attribute to access [a subset of the methods provided](https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws_lambda_powertools_tracer.provider_ProviderService.ProviderService.html) by the [AWS X-Ray SDK](https://docs.aws.amazon.com/xray-sdk-for-nodejs/latest/reference/AWSXRay.html).
372+
You can use `tracer.provider` attribute to access [a subset of the methods provided](https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws-lambda-powertools_tracer.provider_ProviderService.ProviderService.html) by the [AWS X-Ray SDK](https://docs.aws.amazon.com/xray-sdk-for-nodejs/latest/reference/AWSXRay.html).
373373

374374
This is useful when you need a feature available in X-Ray that is not available in the Tracer utility, for example [SQL queries tracing](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-sqlclients.html), or [a custom logger](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-nodejs-configuration.html#xray-sdk-nodejs-configuration-logging).
375375

packages/commons/README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,7 @@ if (isTruthy(truthyValue)) {
4242
}
4343
```
4444

45-
Here's a full list of type utilities available in the package:
46-
47-
- [`isInteger`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isIntegerNumber.html)
48-
- [`isNull`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isNull.html)
49-
- [`isNullOrUndefined`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isNullOrUndefined.html)
50-
- [`isNumber`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isNumber.html)
51-
- [`isRecord`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isRecord.html)
52-
- [`isStrictEqual`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isStrictEqual.html)
53-
- [`isString`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isString.html)
54-
- [`isTruthy`](https://docs.aws.amazon.com/powertools/typescript/latest/api/functions/_aws_lambda_powertools_commons.isTruthy.html)
55-
56-
Many of these utilities also double as type guards, which you can use to narrow down the type of an object or value.
45+
You can find a full list of type utilities available [in the API docs](https://docs.aws.amazon.com/powertools/typescript/latest/api/modules/_aws-lambda-powertools_commons.typeUtils.html). Many of these utilities also double as type guards, which you can use to narrow down the type of an object or value.
5746

5847
### Base64 utils
5948

packages/idempotency/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ payload, status for progress, expiration, and much more.
306306

307307
You can customize most of the configuration options of the table, i.e the names of the attributes.
308308
See
309-
the [API documentation](https://docs.aws.amazon.com/powertools/typescript/latest/api/types/_aws_lambda_powertools_idempotency.types.DynamoDBPersistenceOptions.html)
309+
the [API documentation](https://docs.aws.amazon.com/powertools/typescript/latest/api/types/_aws-lambda-powertools_idempotency.types.DynamoDBPersistenceOptions.html)
310310
for more details.
311311

312312
## Contribute

packages/idempotency/src/IdempotencyConfig.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class IdempotencyConfig {
3131
* Options for parsing JMESPath expressions.
3232
*
3333
* By default, you can use any of the {@link https://jmespath.org/specification.html | JMESPath built-in functions} as well as the
34-
* {@link https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws_lambda_powertools_jmespath.PowertoolsFunctions.PowertoolsFunctions.html | custom functions provided}
34+
* {@link https://docs.aws.amazon.com/powertools/typescript/latest/api/classes/_aws-lambda-powertools_jmespath.PowertoolsFunctions.PowertoolsFunctions.html | custom functions provided}
3535
* by the `@aws-lambda-powertools/jmespath` package.
3636
*/
3737
public jmesPathOptions: JMESPathParsingOptions;

0 commit comments

Comments
 (0)