fix(metrics): correct typedoc examples

Author: Michael Brewer

packages/metrics/src/Metrics.ts

@@ -43,22 +43,22 @@ const DEFAULT_NAMESPACE = 'default_namespace';
  * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
  * import { Callback, Context } from 'aws-lambda';
  *
- * const metrics = new Metrics({namespace:"MyService", serviceName:"withDecorator"});
+ * const metrics = new Metrics({ namespace:'MyService', serviceName:'withDecorator' });
  *
  * export class MyFunctionWithDecorator {
  *
  *   // FYI: Decorator might not render properly in VSCode mouse over due to https://github.com/microsoft/TypeScript/issues/39371 and might show as *@metrics* instead of `@metrics.logMetrics`
  *
- *   @metrics.logMetrics({captureColdStartMetric: true, throwOnEmptyMetrics: true, })
- *   public handler(_event: any, _context: Context, _callback: Callback<any>): void | Promise<any> {
+ *   @metrics.logMetrics({ captureColdStartMetric: true, throwOnEmptyMetrics: true })
+ *   public handler(_event: any, _context: Context, _callback: Callback<any>): void | Promise<void> {
  *    // ...
  *    metrics.addMetric('test-metric', MetricUnits.Count, 10);
  *    // ...
  *   }
  * }
  *
- * export const handlerClass = new MyFunctionWithDecorator()
- * export const handler = handlerClass.handler
+ * export const handlerClass = new MyFunctionWithDecorator();
+ * export const handler = handlerClass.handler;
  * ```
  *
  * ### Standard function
@@ -70,10 +70,10 @@ const DEFAULT_NAMESPACE = 'default_namespace';
  * ```typescript
  * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
  *
- * const metrics = new Metrics({namespace: "MyService", serviceName: "MyFunction"});
+ * const metrics = new Metrics({ namespace: 'MyService', serviceName: 'MyFunction' });
  *
- * export const handler = async (_event: any, _context: any) => {
- *   metrics.captureColdStart();
+ * export const handler = async (_event: any, _context: any): Promise<void> => {
+ *   metrics.captureColdStartMetric();
  *   metrics.addMetric('test-metric', MetricUnits.Count, 10);
  *   metrics.publishStoredMetrics();
  * };
@@ -161,14 +161,14 @@ class Metrics implements MetricsInterface {
    * @example
    *
    * ```typescript
-   * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
+   * import { Metrics } from '@aws-lambda-powertools/metrics';
    * import { Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
+   * const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
    *
-   * export const handler = async (event: any, context: Context) => {
+   * export const handler = async (event: any, context: Context): Promise<void> => {
    *     metrics.captureColdStartMetric();
-   * }
+   * };
    * ```
    */
   public captureColdStartMetric(): void {
@@ -207,21 +207,21 @@ class Metrics implements MetricsInterface {
    * @example
    *
    * ```typescript
-   * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
+   * import { Metrics } from '@aws-lambda-powertools/metrics';
    * import { Callback, Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"CdkExample", serviceName:"withDecorator"});
+   * const metrics = new Metrics({ namespace:'CdkExample', serviceName:'withDecorator' });
    *
    * export class MyFunctionWithDecorator {
    *
-   *   @metrics.logMetrics({captureColdStartMetric: true})
+   *   @metrics.logMetrics({ captureColdStartMetric: true })
    *   public handler(_event: any, _context: Context, _callback: Callback<any>): void | Promise<any> {
    *    // ...
    *   }
    * }
    *
-   * export const handlerClass = new MyFunctionWithDecorator()
-   * export const handler = handlerClass.handler
+   * export const handlerClass = new MyFunctionWithDecorator();
+   * export const handler = handlerClass.handler;
    * ```
    *
    * @decorator Class
@@ -267,9 +267,9 @@ class Metrics implements MetricsInterface {
    * ```typescript
    * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
    *
-   * const metrics = new Metrics({namespace: "CdkExample", serviceName: "MyFunction"}); // Sets metric namespace, and service as a metric dimension
+   * const metrics = new Metrics({ namespace: 'CdkExample', serviceName: 'MyFunction' }); // Sets metric namespace, and service as a metric dimension
    *
-   * export const handler = async (_event: any, _context: any) => {
+   * export const handler = async (_event: any, _context: any): Promise<void> => {
    *   metrics.addMetric('test-metric', MetricUnits.Count, 10);
    *   metrics.publishStoredMetrics();
    * };
@@ -371,15 +371,15 @@ class Metrics implements MetricsInterface {
    * @example
    *
    * ```typescript
-   * import { Metrics, MetricUnits } from '@aws-lambda-powertools/metrics';
+   * import { Metrics } from '@aws-lambda-powertools/metrics';
    * import { Context } from 'aws-lambda';
    *
-   * const metrics = new Metrics({namespace:"serverlessAirline", serviceName:"orders"});
+   * const metrics = new Metrics({ namespace:'serverlessAirline', serviceName:'orders' });
    *
-   * export const handler = async (event: any, context: Context) => {
+   * export const handler = async (event: any, context: Context): Promise<void> => {
    *     metrics.throwOnEmptyMetrics();
    *     metrics.publishStoredMetrics(); // will throw since no metrics added.
-   * }
+   * };
    * ```
    */
   public throwOnEmptyMetrics(): void {

typedoc.js

@@ -1,8 +1,8 @@
 module.exports = {
   out: 'api',
-  exclude: ['**/node_modules/**', '**/*.test.ts', '**/*.json'],
+  exclude: [ '**/node_modules/**', '**/*.test.ts', '**/*.json' ],
   name: 'aws-lambda-powertools-typescript',
   excludePrivate: true,
   entryPointStrategy: 'packages',
-  readme: "./README.md",
+  readme: './README.md',
 };