aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Bool.parse.3
blob: 85bef1bbd5c5ec09052d46908b3c702a56641fd1 (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 Bool.parse 3 2025-04-19T14:48:15.709670 "Tomo man-pages"
.SH NAME
Bool.parse \- Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.

.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Bool.parse\ :\ func(text:\ Text\ ->\ Bool?)
.fi

.SH DESCRIPTION
Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.


.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
text	Text	The string containing the boolean value. 	-
.TE
.SH RETURN
`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.

.SH EXAMPLES
.EX
>> Bool.parse("yes")
= yes : Bool?
>> Bool.parse("no")
= no : Bool?
>> Bool.parse("???")
= none : Bool?
.EE