aboutsummaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-11-27 12:35:52 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-11-27 12:35:52 -0500
commit8b897851facaa177e2346e0d97fcba7411dfc0aa (patch)
treef2f3ef96a5628ec4d76c4097ef7c26a85f1d855a /api
parent31c47caa0282cbdf43361a3c0f45fff9699a8814 (diff)
Update `setenv()` to take an optional value, also bugfix for `setenv()`
returning a value.
Diffstat (limited to 'api')
-rw-r--r--api/api.md4
-rw-r--r--api/builtins.md4
-rw-r--r--api/builtins.yaml5
3 files changed, 7 insertions, 6 deletions
diff --git a/api/api.md b/api/api.md
index ec6ffb49..f52691d3 100644
--- a/api/api.md
+++ b/api/api.md
@@ -166,7 +166,7 @@ say("world!")
## setenv
```tomo
-setenv : func(name: Text, value: Text -> Void)
+setenv : func(name: Text, value: Text? -> Void)
```
Sets an environment variable.
@@ -174,7 +174,7 @@ Sets an environment variable.
Argument | Type | Description | Default
---------|------|-------------|---------
name | `Text` | The name of the environment variable to set. | -
-value | `Text` | The new value of the environment variable. | -
+value | `Text?` | The new value of the environment variable. If `none`, then the environment variable will be unset. | -
**Return:** Nothing.
diff --git a/api/builtins.md b/api/builtins.md
index 6d042741..2ef14275 100644
--- a/api/builtins.md
+++ b/api/builtins.md
@@ -166,7 +166,7 @@ say("world!")
## setenv
```tomo
-setenv : func(name: Text, value: Text -> Void)
+setenv : func(name: Text, value: Text? -> Void)
```
Sets an environment variable.
@@ -174,7 +174,7 @@ Sets an environment variable.
Argument | Type | Description | Default
---------|------|-------------|---------
name | `Text` | The name of the environment variable to set. | -
-value | `Text` | The new value of the environment variable. | -
+value | `Text?` | The new value of the environment variable. If `none`, then the environment variable will be unset. | -
**Return:** Nothing.
diff --git a/api/builtins.yaml b/api/builtins.yaml
index 764a1bd4..af7c9319 100644
--- a/api/builtins.yaml
+++ b/api/builtins.yaml
@@ -157,9 +157,10 @@ setenv:
description: >
The name of the environment variable to set.
value:
- type: 'Text'
+ type: 'Text?'
description: >
- The new value of the environment variable.
+ The new value of the environment variable. If `none`, then the
+ environment variable will be unset.
example: |
setenv("FOOBAR", "xyz")