aboutsummaryrefslogtreecommitdiff
path: root/api/api.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-11-27 12:05:49 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-11-27 12:07:34 -0500
commit437be558a893ac70c030794df99a866e8ed01879 (patch)
tree63126858e06f14db9e23306d7d9d4c7e25f3f421 /api/api.md
parent35053e65b946264715aca2b348ee25313b55d2f6 (diff)
Add `recursive` arg to Path.create_directory()
Diffstat (limited to 'api/api.md')
-rw-r--r--api/api.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/api/api.md b/api/api.md
index 5c9dc9c4..ec6ffb49 100644
--- a/api/api.md
+++ b/api/api.md
@@ -2777,15 +2777,17 @@ assert (./directory).children(include_hidden=yes) == [".git", "foo.txt"]
## Path.create_directory
```tomo
-Path.create_directory : func(path: Path, permissions = Int32(0o755) -> Void)
+Path.create_directory : func(path: Path, permissions = Int32(0o755), recursive = yes -> Void)
```
Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
+
Argument | Type | Description | Default
---------|------|-------------|---------
path | `Path` | The path of the directory to create. | -
permissions | `` | The permissions to set on the new directory. | `Int32(0o755)`
+recursive | `` | If set to `yes`, then recursively create any parent directories if they don't exist, otherwise fail if the parent directory does not exist. When set to `yes`, this function behaves like `mkdir -p`. | `yes`
**Return:** Nothing.