ludic/os-env_or.html
2026-09-17 22:10:03 +00:00

33 lines
No EOL
2 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Os.env_or — Ludic</title>
<meta name="description" content="Read an environment variable, or a fallback.">
<link rel="stylesheet" href="base.css">
<link rel="stylesheet" href="docs.css">
</head>
<body>
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
<main class="wrap item">
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="ns-os.html">Os</a> <span>›</span> <span class="here">Os.env_or</span></div>
<div class="item-head">
<span class="kind-badge kind-method">method</span>
<h1 id="top">Os.env_or</h1>
</div>
<code class="sig">Os.env_or(name, fallback) -&gt; string</code>
<div class="desc"><p>Reads an environment variable, returning <code>fallback</code> when it is not set — the null-safe way to read optional configuration. The result is always non-null, so it is safe to use directly.</p></div>
<div class="params"><h2>Parameters</h2><div class="param" id="param-name"><code class="pname">name</code><span class="pdesc">the variable name</span></div><div class="param" id="param-fallback"><code class="pname">fallback</code><span class="pdesc">the value to use when the variable is unset</span></div></div>
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program EnvOr {
entry {
let assets = Os.env_or("LUDIC_ASSETS", "assets/")
print(len(assets))
}
}</pre></div>
<a class="back" href="api.html">← All symbols</a>
</main>
<script src="ludic-highlight.js"></script>
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
</body></html>