aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.is_symlink.3
blob: d38591d031d583c6c9f51be630f5f4b6d938f306 (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.is_symlink 3 2025-11-29 "Tomo man-pages"
.SH NAME
Path.is_symlink \- check if a path is a symbolic link
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_symlink\ :\ func(path:\ Path\ ->\ Bool)
.fi
.SH DESCRIPTION
Checks if the path represents a symbolic link.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx
l l l.
Name	Type	Description
path	Path	The path to check. 
.TE
.SH RETURN
`True` if the path is a symbolic link, `False` otherwise.

.SH EXAMPLES
.EX
assert (./link).is_symlink() == yes
.EE
.SH SEE ALSO
.BR Tomo-Path (3)