blob: cf72a388fbd560453585f7d8687bfef6c2d6d61a (
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
36
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.files 3 2025-11-29 "Tomo man-pages"
.SH NAME
Path.files \- list files in a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.files\ :\ func(path:\ Path,\ include_hidden:\ Bool\ =\ no\ ->\ [Path])
.fi
.SH DESCRIPTION
Returns a list of files 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 Bool Whether to include hidden files. no
.TE
.SH RETURN
A list of file paths.
.SH EXAMPLES
.EX
assert (./directory).files(include_hidden=yes) == [(./directory/file1.txt), (./directory/file2.txt)]
.EE
.SH SEE ALSO
.BR Tomo-Path (3)
|
