'\" t
.\" Copyright (c) 2026 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.children 3 2026-09-01 "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:\ Bool\ =\ no\ ->\ [Path]?)
.fi
.SH DESCRIPTION
Returns a list of children (files and directories) within the directory at the specified path. Optionally includes hidden files. Child ordering is not specified.


.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	Bool	Whether to include hidden files (those starting with a \fB.\fR). 	no
.TE
.SH RETURN
A list of paths for the children, or `none` if the directory could not be read. An existing but empty directory gives an empty list, not `none`.

.SH NOTES
The paths returned keep the form of the path they came from: the children of `(./foo)` are relative and the children of `(~/foo)` stay home-based. Use `.resolved()` on them if you need absolute paths.

.SH ERRORS
Returns `none` if the path is not a readable directory.

.SH EXAMPLES
.EX
assert (./directory).children(include_hidden=yes)!.sorted() == [(./directory/.git), (./directory/foo.txt)]

# A directory that can't be read gives `none`, not an empty list:
assert (./not-a-directory).children() == none
.EE
.SH SEE ALSO
.BR Tomo-Path (3)