dotenv-parser
A fast, zero-permission Dotenv parser.
This module doesn’t load any file, it only parses their content.
Usage
Import dotenv-parser
:
// From Deno.land
import { dotEnvParser } from "https://deno.land/x/dotenv_parser/mod.ts";
// From Nest.land
import { dotEnvParser } from "https://x.nest.land/dotenv-parser@0.2.0/mod.ts";
// From Denopkg
import { dotEnvParser } from "https://denopkg.com/ymonb1291/dotenv-parser/mod.ts";
// From Github
import { dotEnvParser } from "https://raw.githubusercontent.com/ymonb1291/dotenv-parser/main/mod.ts";
Read your .env
file and decode its content into a string, or just declare a string variable with KEY=VALUE
pairs. For example:
const config = `
SERVER_HOST=localhost
SERVER_PORT=3000
SERVER_HTTPS=true
`;
Parse the configuration:
const res = dotEnvParser(config);
console.log(res);
// Output:
// { SERVER_HOST: "localhost", SERVER_PORT: "3000", SERVER_HTTPS: "true" }
By default, all values are of type string
. If you wish to automatically convert numbers and booleans to their respective types, you need to specify the infer
parameter to true
:
const res = dotEnvParser(config, true);
console.log(res);
// Output:
// { SERVER_HOST: "localhost", SERVER_PORT: 3000, SERVER_HTTPS: true }
dotEnvParser
The parser has the following signature
function dotEnvParser<false>(raw: string): Data;
function dotEnvParser<false>(raw: string, infer: false): Data;
function dotEnvParser<true>(raw: string, infer: true): TypedData;
Data interface
Data
describes the object returned when the infer parameter is false
or undefined
. It describes a plain object where all values are of type string
.
interface Data {
[key: string]: string;
}
TypedData interface
TypedData
describes the object returned when the infer parameter is true
. It describes a plain object where the values can be of type string
, number
or boolean
.
interface TypedData {
[key: string]: string | number | boolean;
}
Parsing rules
The parser supports key/value pairs formatted as KEY=VALUE
. The following rules apply:
- Empty lines are skipped
- Lines beginning with
#
are treated as comments and are skipped KEY=VALUE
becomes{KEY="VALUE"}
- Single quoted values can also be used:
KEY='VALUE'
also becomes{KEY="VALUE"}
- Double quoted values can also be used:
KEY="VALUE"
also becomes{KEY="VALUE"}
- Single quoted values can also be used:
- Keys can contain upper case letters
A-Z
, lower case lettersa-z
and underscore character_
. Numbers0-9
are also valid when not in first position. For example:_Key0=VALUE
is valid and becomes{_Key0="VALUE"}
0Key_=VALUE
is not valid
- Empty values are treated as empty string.
EMPTY=
becomes{EMPTY=""}
- Single and double quoted values keep their surrounding spaces. Non quoted values do not.
KEY= VALUE
becomes{KEY="VALUE"}
KEY=" VALUE "
becomes{KEY=" VALUE "}
- Inner quotes are maintained.
JSON={"KEY": "VALUE"}
becomes{JSON="{\"KEY\": \"VALUE\"}"}
- Multiline values are accepted with and without quotes. For example:
becomesSAY_HELLO=Hello World!
{SAY_HELLO: "Hello\nWorld!"}
- Multiline values can contain
=
if escaped
becomesCALC=1+1 \\=2
{CALC: "1+1\n=2",}
- Multiline values can contain
#
if escaped
becomesHASH=New trend on Twitter \\#dotenv-parser
{HASH: "New trend on Twitter\n#dotenv-parser"}
Contributions
PRs are welcome!