aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.is_file.3
blob: 298d7289419131104d9fbf7334d333d3453c7039 (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
37
38
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.is_file 3 2025-04-30 "Tomo man-pages"
.SH NAME
Path.is_file \- check if a path is a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_file\ :\ func(path:\ Path,\ follow_symlinks\ =\ yes\ ->\ Bool)
.fi
.SH DESCRIPTION
Checks if the path represents a file. Optionally follows symbolic links.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	The path to check. 	-
follow_symlinks		Whether to follow symbolic links. 	yes
.TE
.SH RETURN
`True` if the path is a file, `False` otherwise.

.SH EXAMPLES
.EX
>> (./file.txt).is_file()
= yes

>> (./directory/).is_file()
= no
.EE