StringUtil - Revision history

Redspark at 04:58, 5 April 2025

2025-04-05T04:58:53Z

Redspark: Added missing methods

2025-04-05T04:52:35Z

Added missing methods

Redspark at 00:50, 5 April 2025

2025-04-05T00:50:59Z

Redspark: Added to Sys Modules Category

2025-03-31T16:07:24Z

Added to Sys Modules Category

JoeStrout: /* Added string methods */

2021-08-26T21:36:09Z

Added string methods

JoeStrout: Created page with "In Mini Micro, stringUtil is an import module in the /sys/lib directory. It provides various additional string-related functions, directly extending..."

2021-08-26T21:30:29Z

Created page with "In Mini Micro, <c>stringUtil</c> is an import module in the <c>/sys/lib</c> directory. It provides various additional string-related functions, directly extending..."

New page

In [[Mini Micro]], <c>stringUtil</c> is an [[import]] module in the <c>/sys/lib</c> directory. It provides various additional [[string]]-related functions, directly extending the [[string]] datatype.

Like all the modules in <c>/sys/lib</c>, the best documentation for stringUtil is the source code (<c>/sys/lib/stringUtil.ms</c>) itself. But this page summarizes the content in more concise form.

== Constants ==

The following values should be normally be prefixed with <c>stringUtil</c>, e.g., <c>stringUtil.smallWords</c>.

{| class="wikitable"
|-
! Name !! Value / Purpose
|-
| smallWords || list of words that should not be capitalized in a title, except as the first word
|-
| TAB || <c>char(9)</c>; tab character (advances to the next multiple of 4 spaces)
|-
| CR || <c>char(13)</c>; carriage return (moves the cursor to the start of the next line)
|-
| LF || <c>char(10)</c>; line feed (alternate line ending used in some files)
|-
| whitespace || common whitespace characters: space, TAB, CR, and LF
|}

== Added string methods ==

The following methods are added to the [[string]] type, and so are accessed using dot syntax after any string, for example: <c>"hello world".titleCase</c>

Note that because [[string]]s are immutable, none of these methods change the string they are called on; instead they return a new string (where applicable).

{| class="wikitable"
|-
! Method !! Returns
|-
| capitalized || capitalizes the first letter of the string
|-
| titleCase || capitalizes each word, except for small words
|-
| startsWith(''s'') || returns true if this string begins with ''s''
|-
| endsWith(''s'') || returns true if this string ends with ''s''
|-
| contains(''s'') || returns true if this string contains ''s''
|-
| pad(''length'', ''padChar''=" ", ''cutIfTooLong''=true) || pads a string by appending the given pad char, optionally cutting it if too long
|-
| trim(''charsToRemove''=whitespace) || trims the given set of characters off both ends of the string
|-
| trimRight(''charsToRemove''=whitespace) || trims the given set of characters off the end of the string
|-
| trimLeft(''charsToRemove''=whitespace) || trims the given set of characters off the start of the string
|-
| ellideEnd(''maxLength''=10) || shortens a string and appends an ellipsis if the string is too long
|-
| ellideMiddle(''maxLength''=10) || shortens a string in the middle, inserting an ellipsis
|-
| reverse || reverses the string (e.g. Hello -> olleH)
|-
| splitLines || splits a string into lines by CR, LF, or CR+LF
|-
| wrap(''width''=67) || splits the string on spaces so that each line fits within the given width
|-
| cipher(charMap) || applies a substitution cipher, using the given character map
|-
| rot13 || applies the classic [https://en.wikipedia.org/wiki/ROT13 ROT-13] substitution cipher
|-
| editDistance = function(''s2'') || returns how many 1-character edits needed to transform this string into ''s2''
|}

[[Category:Mini Micro]]

@@ Line 70: / Line 70: @@
 | rot13 || applies the classic [https://en.wikipedia.org/wiki/ROT13 ROT-13] substitution cipher
 |-
-| urlEncode || Encode a string so it can be used as a URL query parameter.
+| urlEncode || Encode a string so it can be used as a URL query parameter.  '''MiniMicro Only!'''
 |-
-| urlDecode || convert a URL-encoded string back into plain text.
+| urlDecode || convert a URL-encoded string back into plain text.  '''MiniMicro Only!'''
 |-
 | between(''startTag'', ''endTag'', ''after''=null) || find a string between two substrings.  This can be used, for example, to find text between two HTML tags.

← Older revision		Revision as of 00:50, 5 April 2025
Line 73:		Line 73:


		+	[[Category:Sys Modules]]
	[[Category:Mini Micro]]		[[Category:Mini Micro]]
−	[[Category:~~Sys Modules~~]]	+	[[Category:Command-Line_MiniScript]]

← Older revision		Revision as of 16:07, 31 March 2025
Line 74:		Line 74:

	[[Category:Mini Micro]]		[[Category:Mini Micro]]
		+	[[Category:Sys Modules]]

@@ Line 41: / Line 41: @@
 |-
 | contains(''s'') || returns true if this string contains ''s''
 |-
 | pad(''length'', ''padChar''=" ", ''cutIfTooLong''=true) || pads a string by appending the given pad char, optionally cutting it if too long
@@ Line 49: / Line 53: @@
 |-
 | trimLeft(''charsToRemove''=whitespace) || trims the given set of characters off the start of the string
 |-
 | ellideEnd(''maxLength''=10) || shortens a string and appends an ellipsis if the string is too long
@@ Line 64: / Line 70: @@
 | rot13 || applies the classic [https://en.wikipedia.org/wiki/ROT13 ROT-13] substitution cipher
 |-
-| editDistance = function(''s2'') || returns how many 1-character edits needed to transform this string into ''s2''
+| urlEncode || Encode a string so it can be used as a URL query parameter.
 |}

@@ Line 66: / Line 66: @@
 | editDistance = function(''s2'') || returns how many 1-character edits needed to transform this string into ''s2''
 |}
 [[Category:Mini Micro]]