Skip to content

Commit 396e4b9

Browse files
evanlucasrvagg
authored andcommitted
doc: add more details to process.env
process.env has a few quirks that deserve documenting. The commit documents: - How assigning to process.env will implicitly call `toString()` - How to remove an environment variable from process.env PR-URL: #4924 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
1 parent bc11bf4 commit 396e4b9

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

doc/api/process.markdown

+25
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,31 @@ process.env.foo = 'bar';
424424
console.log(process.env.foo);
425425
```
426426

427+
Assigning a property on `process.env` will implicitly convert the value
428+
to a string.
429+
430+
Example:
431+
432+
```js
433+
process.env.test = null;
434+
console.log(process.env.test);
435+
// => 'null'
436+
process.env.test = undefined;
437+
console.log(process.env.test);
438+
// => 'undefined'
439+
```
440+
441+
Use `delete` to delete a property from `process.env`.
442+
443+
Example:
444+
445+
```js
446+
process.env.TEST = 1;
447+
delete process.env.TEST;
448+
console.log(process.env.TEST);
449+
// => undefined
450+
```
451+
427452
## process.execArgv
428453

429454
This is the set of Node.js-specific command line options from the

0 commit comments

Comments
 (0)