Skip to content

Commit 83efd0d

Browse files
evanlucasMyles Borins
authored and
Myles Borins
committed
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 f5d29d7 commit 83efd0d

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
@@ -389,6 +389,31 @@ But this will:
389389
process.env.foo = 'bar';
390390
console.log(process.env.foo);
391391

392+
Assigning a property on `process.env` will implicitly convert the value
393+
to a string.
394+
395+
Example:
396+
397+
```js
398+
process.env.test = null;
399+
console.log(process.env.test);
400+
// => 'null'
401+
process.env.test = undefined;
402+
console.log(process.env.test);
403+
// => 'undefined'
404+
```
405+
406+
Use `delete` to delete a property from `process.env`.
407+
408+
Example:
409+
410+
```js
411+
process.env.TEST = 1;
412+
delete process.env.TEST;
413+
console.log(process.env.TEST);
414+
// => undefined
415+
```
416+
392417
## process.execArgv
393418

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

0 commit comments

Comments
 (0)