levovix
/
Nim
zrcadlo https://github.com/nim-lang/Nim


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
							<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>std/envvars</title>

<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">

<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">

<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
  <div class="document" id="documentId">
    <div class="container">
      <h1 class="title">std/envvars</h1>
      <div class="row">
  <div class="three columns">
    <div class="theme-select-wrapper">
      <label for="theme-select">Theme:&nbsp;</label>
      <select id="theme-select" onchange="setTheme(this.value)">
        <option value="auto">🌗 Match OS</option>
        <option value="dark">🌑 Dark</option>
        <option value="light">🌕 Light</option>
      </select>
    </div>
    <div id="global-links">
      <ul class="simple-boot">
        <li><a href="manual.html">Manual</a></li>
        <li><a href="lib.html">Standard library</a></li>
        <li> <a id="indexLink" href="theindex.html">Index</a></li>
        <li><a href="compiler/theindex.html">Compiler docs</a></li>
        <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
        <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
      </ul>
    </div>
    <div id="searchInputDiv">
      Search: <input type="search" id="searchInput"
        oninput="search()" />
    </div>
    
    <ul class="simple simple-toc" id="toc-list">
  <li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#ReadEnvEffect" title="ReadEnvEffect = object of ReadIOEffect">ReadEnvEffect</a></li>
<li><a class="reference" href="#WriteEnvEffect" title="WriteEnvEffect = object of WriteIOEffect">WriteEnvEffect</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">delEnv
  <li><a class="reference" href="#delEnv%2Cstring" title="delEnv(key: string)">delEnv(key: string)</a></li>

</ul>
<ul class="simple nested-toc-section">existsEnv
  <li><a class="reference" href="#existsEnv%2Cstring" title="existsEnv(key: string): bool">existsEnv(key: string): bool</a></li>

</ul>
<ul class="simple nested-toc-section">getEnv
  <li><a class="reference" href="#getEnv%2Cstring%2Cstring" title="getEnv(key: string; default = &quot;&quot;): string">getEnv(key: string; default = &quot;&quot;): string</a></li>

</ul>
<ul class="simple nested-toc-section">putEnv
  <li><a class="reference" href="#putEnv%2Cstring%2Cstring" title="putEnv(key, val: string)">putEnv(key, val: string)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">envPairs
  <li><a class="reference" href="#envPairs.i" title="envPairs(): tuple[key, value: string]">envPairs(): tuple[key, value: string]</a></li>

</ul>

    </ul>
  </details>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

    <div id="tocRoot"></div>
    
    <p class="module-desc">The <tt class="docutils literal"><span class="pre"><span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">envvars</span></span></tt> module implements environment variable handling.</p>
    <div class="section" id="6">
  <h1><a class="toc-backref" href="#6">Imports</a></h1>
  <dl class="item">
    <a class="reference external" href="oserrors.html">oserrors</a>, <a class="reference external" href="assertions.html">assertions</a>
  </dl>
</div>
<div class="section" id="7">
  <h1><a class="toc-backref" href="#7">Types</a></h1>
  <dl class="item">
    <div id="ReadEnvEffect">
  <dt><pre><a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#ReadIOEffect"><span class="Identifier">ReadIOEffect</span></a></pre></dt>
  <dd>
    
    Effect that denotes a read from an environment variable.
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L18" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L18" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="WriteEnvEffect">
  <dt><pre><a href="envvars.html#WriteEnvEffect"><span class="Identifier">WriteEnvEffect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a></pre></dt>
  <dd>
    
    Effect that denotes a write to an environment variable.
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L20" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L20" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

  </dl>
</div>
<div class="section" id="12">
  <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dl class="item">
    <div id="delEnv-procs-all">
  <div id="delEnv,string">
  <dt><pre><span class="Keyword">proc</span> <a href="#delEnv%2Cstring"><span class="Identifier">delEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#WriteEnvEffect"><span class="Identifier">WriteEnvEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
                           <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Deletes the <span id="environment-variable_1">environment variable</span> named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>. If an error occurs, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
<p>See also:ven</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc getEnv(key: string; default = &quot;&quot;): string" href="#getEnv,string,string">getEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsEnv(key: string): bool" href="#existsEnv,string">existsEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc putEnv(key, val: string)" href="#putEnv,string,string">putEnv proc</a></li>
<li><a class="reference internal nimdoc" title="iterator envPairs(): tuple[key, value: string]" href="#envPairs.i">envPairs iterator</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L137" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L137" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="existsEnv-procs-all">
  <div id="existsEnv,string">
  <dt><pre><span class="Keyword">proc</span> <a href="#existsEnv%2Cstring"><span class="Identifier">existsEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
                                    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Checks whether the environment variable named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> exists. Returns true if it exists, false otherwise.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc getEnv(key: string; default = &quot;&quot;): string" href="#getEnv,string,string">getEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc putEnv(key, val: string)" href="#putEnv,string,string">putEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc delEnv(key: string)" href="#delEnv,string">delEnv proc</a></li>
<li><a class="reference internal nimdoc" title="iterator envPairs(): tuple[key, value: string]" href="#envPairs.i">envPairs iterator</a></li>
</ul>

<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">existsEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;unknownEnv&quot;</span><span class="Punctuation">)</span></pre>
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L105" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L105" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="getEnv-procs-all">
  <div id="getEnv,string,string">
  <dt><pre><span class="Keyword">proc</span> <a href="#getEnv%2Cstring%2Cstring"><span class="Identifier">getEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">default</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Returns the value of the <span id="environment-variable_2">environment variable</span> named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt>.</p>
<p>If the variable does not exist, <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt> is returned. To distinguish whether a variable exists or it's value is just <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt>, call <a class="reference internal nimdoc" title="proc existsEnv(key: string): bool" href="#existsEnv,string">existsEnv(key) proc</a>.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc existsEnv(key: string): bool" href="#existsEnv,string">existsEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc putEnv(key, val: string)" href="#putEnv,string,string">putEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc delEnv(key: string)" href="#delEnv,string">delEnv proc</a></li>
<li><a class="reference internal nimdoc" title="iterator envPairs(): tuple[key, value: string]" href="#envPairs.i">envPairs iterator</a></li>
</ul>

<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">getEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;unknownEnv&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;&quot;</span>
<span class="Identifier">assert</span> <span class="Identifier">getEnv</span><span class="Punctuation">(</span><span class="StringLit">&quot;unknownEnv&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;doesn't exist&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;doesn't exist&quot;</span></pre>
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L83" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L83" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="putEnv-procs-all">
  <div id="putEnv,string,string">
  <dt><pre><span class="Keyword">proc</span> <a href="#putEnv%2Cstring%2Cstring"><span class="Identifier">putEnv</span></a><span class="Other">(</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#WriteEnvEffect"><span class="Identifier">WriteEnvEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
                                <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Sets the value of the <span id="environment-variable_3">environment variable</span> named <tt class="docutils literal"><span class="pre"><span class="Identifier">key</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt>. If an error occurs, <tt class="docutils literal"><span class="pre"><span class="Identifier">OSError</span></span></tt> is raised.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc getEnv(key: string; default = &quot;&quot;): string" href="#getEnv,string,string">getEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsEnv(key: string): bool" href="#existsEnv,string">existsEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc delEnv(key: string)" href="#delEnv,string">delEnv proc</a></li>
<li><a class="reference internal nimdoc" title="iterator envPairs(): tuple[key, value: string]" href="#envPairs.i">envPairs iterator</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L119" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L119" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="15">
  <h1><a class="toc-backref" href="#15">Iterators</a></h1>
  <dl class="item">
    <div id="envPairs-iterators-all">
  <div id="envPairs.i">
  <dt><pre><span class="Keyword">iterator</span> <a href="#envPairs.i"><span class="Identifier">envPairs</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">key</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="envvars.html#ReadEnvEffect"><span class="Identifier">ReadEnvEffect</span></a><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    <p>Iterate over all <span id="environments-variables_1">environments variables</span>.</p>
<p>In the first component of the tuple is the name of the current variable stored, in the second its value.</p>
<p>Works in native backends, nodejs and vm, like the following APIs:</p>
<ul class="simple"><li><a class="reference internal nimdoc" title="proc getEnv(key: string; default = &quot;&quot;): string" href="#getEnv,string,string">getEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc existsEnv(key: string): bool" href="#existsEnv,string">existsEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc putEnv(key, val: string)" href="#putEnv,string,string">putEnv proc</a></li>
<li><a class="reference internal nimdoc" title="proc delEnv(key: string)" href="#delEnv,string">delEnv proc</a></li>
</ul>

    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/std/envvars.nim#L208" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/std/envvars.nim#L208" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>

  </div>
</div>

      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br>
        <small style="color: var(--hint);">Made with Nim. Generated: 2025-01-09 12:00:27 UTC</small>
      </div>
    </div>
  </div>
      <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    
</body>
</html>