Skip to content

Commit d247b1c

Browse files
committed
docs: extend usage examples
1 parent d96f4ff commit d247b1c

File tree

1 file changed

+40
-24
lines changed

1 file changed

+40
-24
lines changed

README.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,53 @@
33
44
## Install
55
```sh
6-
yarn add envapi
6+
npm install envapi
77
```
88

99
## Usage
1010
```ts
1111
import { parse, stringify, config, load, loadSafe } from 'envapi'
1212

13-
const str = `
13+
const input = `A=A\nFOO=BAR`
14+
const env = parse(input) // { A: 'A', FOO: 'BAR' }
15+
const output = stringify(env) // A=A\nFOO=BAR
16+
```
17+
18+
### parse()
19+
Parse a dotenv string into an object.
20+
21+
```ts
22+
const raw = `
1423
A=A
15-
FOO = """bar
16-
baz
17-
"""
18-
X:x #comment`
19-
20-
const env = parse(str)
21-
{
22-
A: 'A',
23-
FOO: 'bar\nbaz',
24-
X: 'x'
25-
}
26-
27-
const nstr = stringify(env)
28-
`A=A
29-
FOO="bar\nbaz"
30-
X=x`
31-
32-
const raw = 'FOO=BAR\nBAZ=QUX'
33-
await fs.writeFile('.env', raw)
34-
const env1 = load('.env')
35-
36-
config('.env')
24+
FOO=BAR #comment`
25+
26+
const env = parse(raw) // { A: 'A', FOO: 'BAR' }
27+
```
28+
29+
### stringify()
30+
Stringify an object into a dotenv string.
31+
32+
```ts
33+
const env = { A: 'A', FOO: 'BAR' }
34+
const raw = stringify(env) // 'A=A\nFOO=BAR'
35+
```
36+
37+
### load()
38+
Read a dotenv file(s) and parse it into an object. `loadSafe()` suppresses ENOENT errors.
39+
```ts
40+
await fs.writeFile('.env1', 'FOO=BAR')
41+
await fs.writeFile('.env2', 'BAZ=QUX')
42+
43+
const env = load('.env1', '.env2') // { FOO: 'BAR', BAZ: 'QUX' }
44+
const _env = loadSafe('.env.notexists') // {}
45+
```
46+
47+
48+
### config()
49+
Load a dotenv file into `process.env`.
50+
51+
```ts
52+
config('.env1')
3753
process.env.FOO // BAR
3854
```
3955

0 commit comments

Comments
 (0)