Merge pull request #31533 from virkt25/patch-3

Add missing example option
2026-10-06 07:47:04 +00:00 · 2018-12-24 21:44:51 -08:00
parent 2735efd825 9b5517a8b7
commit 360e48f296
1 changed files with 6 additions and 1 deletions
@@ -24,7 +24,12 @@ export interface DotenvSafeOptions {
   */
  path?: string,
  /**
-   * Path to example environment file.
+   * Path to example environment file. (Option 1)
+   * @default ".env.example"
+   */
+  example?: string,
+  /**
+   * Path to example environment file. (Option 2 -- example takes precendence)
   * @default ".env.example"
   */
  sample?: string,