docs: fix env variable name in logEventIfEnabled() docstring (#3197)

kevinpeno · web-flow · commit 16adea62c304 · 2024-10-14T09:55:33.000+02:00
diff --git a/packages/logger/src/Logger.ts b/packages/logger/src/Logger.ts
@@ -432,11 +432,11 @@ class Logger extends Utility implements LoggerInterface {
   }
 
   /**
-   * Log the AWS Lambda event payload for the current invocation if the environment variable `POWERTOOLS_LOG_EVENT` is set to `true`.
+   * Log the AWS Lambda event payload for the current invocation if the environment variable `POWERTOOLS_LOGGER_LOG_EVENT` is set to `true`.
    *
    * @example
    * ```ts
-   * process.env.POWERTOOLS_LOG_EVENT = 'true';
+   * process.env.POWERTOOLS_LOGGER_LOG_EVENT = 'true';
    *
    * import { Logger } from '@aws-lambda-powertools/logger';
    *

Original file line number	Diff line number	Diff line change
`@@ -432,11 +432,11 @@ class Logger extends Utility implements LoggerInterface {`
`432`	`432`	`}`
`433`	`433`
`434`	`434`	`/**`
`435`		- * Log the AWS Lambda event payload for the current invocation if the environment variable `POWERTOOLS_LOG_EVENT` is set to `true`.
	`435`	+ * Log the AWS Lambda event payload for the current invocation if the environment variable `POWERTOOLS_LOGGER_LOG_EVENT` is set to `true`.
`436`	`436`	`*`
`437`	`437`	`* @example`
`438`	`438`	* ```ts
`439`		`- * process.env.POWERTOOLS_LOG_EVENT = 'true';`
	`439`	`+ * process.env.POWERTOOLS_LOGGER_LOG_EVENT = 'true';`
`440`	`440`	`*`
`441`	`441`	`* import { Logger } from '@aws-lambda-powertools/logger';`
`442`	`442`	`*`