aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Text.ends_with.3
blob: e9cec09244a1b895004c641e8ee756eb1b5f1551 (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
39
40
41
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.ends_with 3 2025-09-06 "Tomo man-pages"
.SH NAME
Text.ends_with \- check suffix
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.ends_with\ :\ func(text:\ Text,\ suffix:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Bool)
.fi
.SH DESCRIPTION
Checks if the `Text` ends with a literal suffix text.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
text	Text	The text to be searched. 	-
suffix	Text	The literal suffix text to check for. 	-
remainder	&Text?	If non-none, this value will be set to the rest of the text up to the trailing suffix. If the suffix is not found, this value will be set to the original text. 	none
.TE
.SH RETURN
`yes` if the text has the target, `no` otherwise.

.SH EXAMPLES
.EX
>> "hello world".ends_with("world")
= yes
remainder : Text
>> "hello world".ends_with("world", &remainder)
= yes
>> remainder
= "hello "
.EE