tomo-Path.children.3

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