CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.
 
+## [8.2.0](https://github.com/motdotla/dotenv/compare/v8.1.0...v8.2.0) (2019-10-16)
+
 ## [8.1.0](https://github.com/motdotla/dotenv/compare/v7.0.0...v8.1.0) (2019-08-18)
 
 

package.json

@@ -1,13 +1,15 @@
 {
   "name": "dotenv",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Loads environment variables from .env file",
   "main": "lib/main.js",
+  "types": "types",
   "scripts": {
     "flow": "flow",
+    "dtslint": "dtslint types",
     "lint": "standard",
     "postlint": "standard-markdown",
-    "pretest": "npm run lint",
+    "pretest": "npm run lint && npm run dtslint",
     "test": "tap tests/*.js --100",
     "prerelease": "npm test",
     "release": "standard-version"
@@ -29,12 +31,13 @@
   "license": "BSD-2-Clause",
   "devDependencies": {
     "decache": "^4.5.1",
-    "flow-bin": "^0.105.2",
-    "sinon": "^7.4.1",
+    "dtslint": "^0.9.8",
+    "flow-bin": "^0.109.0",
+    "sinon": "^7.5.0",
     "standard": "^13.1.0",
     "standard-markdown": "^5.1.0",
     "standard-version": "^7.0.0",
-    "tap": "^14.6.1"
+    "tap": "^14.7.0"
   },
   "dependencies": {},
   "engines": {

types/index.d.ts

@@ -0,0 +1,59 @@
+// TypeScript Version: 3.0
+/// <reference types="node" />
+
+export interface DotenvParseOptions {
+  /**
+   * You may turn on logging to help debug why certain keys or values are not being set as you expect.
+   */
+  debug?: boolean;
+}
+
+export interface DotenvParseOutput {
+  [name: string]: string;
+}
+
+/**
+ * Parses a string or buffer in the .env file format into an object.
+ *
+ * @param src - contents to be parsed
+ * @param options - additional options
+ * @returns an object with keys and values based on `src`
+ */
+export function parse(
+  src: string | Buffer,
+  options?: DotenvParseOptions
+): DotenvParseOutput;
+
+export interface DotenvConfigOptions {
+  /**
+   * You may specify a custom path if your file containing environment variables is located elsewhere.
+   */
+  path?: string;
+
+  /**
+   * You may specify the encoding of your file containing environment variables.
+   */
+  encoding?: string;
+
+  /**
+   * You may turn on logging to help debug why certain keys or values are not being set as you expect.
+   */
+  debug?: boolean;
+}
+
+export interface DotenvConfigOutput {
+  error?: Error;
+  parsed?: DotenvParseOutput;
+}
+
+/**
+ * Loads `.env` file contents into {@link https://nodejs.org/api/process.html#process_process_env | `process.env`}.
+ * Example: 'KEY=value' becomes { parsed: { KEY: 'value' } }
+ *
+ * @param options - controls behavior
+ * @returns an object with a `parsed` key if successful or `error` key if an error occurred
+ *
+ */
+export function config(options?: DotenvConfigOptions): DotenvConfigOutput;
+/** @deprecated since v7.0.0 Use config instead. */
+export const load: typeof config;

types/test.ts

@@ -0,0 +1,19 @@
+import { config, parse } from "dotenv";
+
+const env = config();
+const dbUrl: string | null =
+  env.error || !env.parsed ? null : env.parsed["BASIC"];
+
+config({
+  path: ".env-example",
+  encoding: "utf8",
+  debug: true
+});
+
+const parsed = parse("NODE_ENV=production\nDB_HOST=a.b.c");
+const dbHost: string = parsed["DB_HOST"];
+
+const parsedFromBuffer = parse(new Buffer("JUSTICE=league\n"), {
+  debug: true
+});
+const justice: string = parsedFromBuffer["JUSTICE"];

types/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es6"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "dotenv": ["."]
+    }
+  }
+}

types/tslint.json

@@ -0,0 +1,6 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "strict-export-declare-modifiers": false
+  }
+}