@dotenvx/dotenvx 1.38.1 → 1.38.2

package/CHANGELOG.md

@@ -2,15 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.38.1...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.38.2...main)
+
+## [1.38.2](https://github.com/dotenvx/dotenvx/compare/v1.38.1...v1.38.2)
+
+### Added
+
+* Add typescript types for `main.get`.
 
 ## [1.38.1](https://github.com/dotenvx/dotenvx/compare/v1.38.0...v1.38.1)
 
 ### Changed
 
-* Support `encrypt` when mutliline contains windows `CRLF` (`\\r\\n`) ([#534](https://github.com/dotenvx/dotenvx/pull/534))
+* Support `encrypt` when mutliline contains windows `CRLF` (`\r\n`) ([#534](https://github.com/dotenvx/dotenvx/pull/534))
 
-Note: dotenvx will convert these `\\r\\n` newlines to `\\n`. Our recommendation is to stop using CRLF - its origin is from typewriter days. Instead, set your editor or gitattributes to use LF.
+Note: dotenvx will convert these `\r\n` newlines to `\n`. Our recommendation is to stop using `CRLF` - its origin is from typewriter days. Instead, set your editor or gitattributes to use `LF`.
 
 ## [1.38.0](https://github.com/dotenvx/dotenvx/compare/v1.37.0...v1.38.0)
 

package/README.md

@@ -2212,6 +2212,20 @@ More examples
   dotenvx.set('HELLO', 'World', { path: '.env' })
   ```
 
+  </details>
+* <details><summary>`get(KEY)` - <i>Decryption at Access</i></summary><br>
+
+  Programatically get an environment variable at access/runtime.
+
+  ```js
+  // index.js
+  const dotenvx = require('@dotenvx/dotenvx')
+  const decryptedValue = dotenvx.get('HELLO')
+  console.log(decryptedValue)
+  ```
+
+  This is known as *Decryption at Access* and is written about in [the whitepaper](https://dotenvx.com/dotenvx.pdf).
+
   </details>
 
 &nbsp;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.38.1",
+  "version": "1.38.2",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",

package/src/lib/main.d.ts

@@ -232,6 +232,50 @@ export function set(
   options?: SetOptions
 ): SetOutput;
 
+export interface GetOptions {
+  /**
+   * Suppress specific errors like MISSING_ENV_FILE. The error keys can be found
+   * in src/lib/helpers/errors.js
+   * @default []
+   * @example require('@dotenvx/dotenvx').get('KEY', { ignore: ['MISSING_ENV_FILE'] })
+   */
+  ignore?: string[];
+
+  /**
+   * Override any environment variables that have already been set on your machine with values from your .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { overload: true })
+   * @alias overload
+   */
+  overload?: boolean;
+
+  /**
+   * Customize the path to your .env.keys file. This is useful with monorepos.
+   * @default []
+   * @example require('@dotenvx/dotenvx').get('KEY', { envKeysFile: '../../.env.keys'} })
+   */
+  envKeysFile?: string;
+
+  /**
+   * Throw immediately if an error is encountered - like a missing .env file.
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { strict: true })
+   */
+  strict?: boolean;
+}
+
+/**
+ * Get a single environment variable.
+ *
+ * @see https://dotenvx.com/docs
+ * @param key - KEY 
+ * @param options - additional options. example: `{ overload: true }`
+ */
+export function get(
+  key: string,
+  options?: GetOptions
+): string;
+
 /**
  * List all env files in the current working directory
  *