blob: 579b0416836df21ee549280a608e93a3e132ae5d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.children 3 2025-09-06 "Tomo man-pages"
.SH NAME
Path.children \- get children of a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.children\ :\ func(path:\ Path,\ include_hidden\ =\ no\ ->\ [Path])
.fi
.SH DESCRIPTION
Returns a list of children (files and directories) within the directory at the specified path. Optionally includes hidden files.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
path Path The path of the directory. -
include_hidden Whether to include hidden files, which start with a `.`. no
.TE
.SH RETURN
A list of paths for the children.
.SH EXAMPLES
.EX
>> (./directory).children(include_hidden=yes)
= [".git", "foo.txt"]
.EE
|
