summaryrefslogtreecommitdiffhomepage
path: root/tests/custom/03_stdlib/26_rtrim
blob: 17b54f76ec19ea2de74b06215f79b48611740ae1 (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
42
43
44
45
46
The `rtrim()` function removes specific trailing characters from the given
input string. If the characters to trim are unspecified, the space, tab,
carriage return and newline characters will be used by default.

Returns a copy of the input string with the specified trailing characters
removed.

Returns `null` if the given input argment is not a valid string value.

-- Testcase --
{%
	printf("%.J\n", [
		// not specifying trim characters will trim whitespace
		rtrim("Hello World!	 \r \n"),

		// if trim characters are specified, only those are removed
		rtrim("|* Foo Bar +|", "+*|"),

		// rtrim does not affect characters in the middle or the beginning
		rtrim("  Foo  Bar  "),
		rtrim("|Foo|Bar|", "|")
	]);
%}
-- End --

-- Expect stdout --
[
	"Hello World!",
	"|* Foo Bar ",
	"  Foo  Bar",
	"|Foo|Bar"
]
-- End --


Supplying an invalid string will yield `null`.

-- Testcase --
{%
	printf("%.J\n", ltrim(true));
%}
-- End --

-- Expect stdout --
null
-- End --