tomo-Text.trim.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.trim 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.trim \- trim characters
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.trim\ :\ func(text:\ Text,\ to_trim:\ Text\ =\ "\ $\[rs]t\[rs]r\[rs]n",\ left:\ Bool\ =\ yes,\ right:\ Bool\ =\ yes\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Trims the given characters (grapheme clusters) from the left and/or right side of the text.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 text	Text	The text to be trimmed. 	-
  26 to_trim	Text	The characters to remove from the left/right of the text. 	"\ $\[rs]t\[rs]r\[rs]n"
  27 left	Bool	Whether or not to trim from the front of the text. 	yes
  28 right	Bool	Whether or not to trim from the back of the text. 	yes
  29 .TE
  30 .SH RETURN
  31 The text without the trim characters at either end.
  32 
  33 .SH EXAMPLES
  34 .EX
  35 assert "   x y z    \[rs]n".trim() == "x y z"
  36 assert "one,".trim(",") == "one"
  37 assert "   xyz   ".trim(right=no) == "xyz   "
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)