From 15cfa407d4fca03b94c1b59b7ee0026867c6d8eb Mon Sep 17 00:00:00 2001 From: haithium <128622475+haithium@users.noreply.github.com> Date: Mon, 9 Mar 2026 04:12:02 +0000 Subject: [PATCH] chore(docs): auto-generate docs --- docs/src/modules/is.md | 44 +++++++++--------- docs/src/modules/keyword.md | 6 +-- docs/src/modules/list.md | 38 ++++++++-------- docs/src/modules/ntpath.md | 8 ++-- docs/src/modules/operator.md | 6 +-- docs/src/modules/posixpath.md | 4 +- docs/src/modules/set.md | 20 ++++---- docs/src/modules/str.md | 83 ++++++++++++++++++---------------- docs/src/modules/stringcase.md | 32 ++++++------- docs/src/modules/tbl.md | 10 ++-- docs/src/modules/utils.md | 2 +- docs/src/modules/validate.md | 44 +++++++++--------- 12 files changed, 150 insertions(+), 147 deletions(-) diff --git a/docs/src/modules/is.md b/docs/src/modules/is.md index abcb908..8a3fa47 100644 --- a/docs/src/modules/is.md +++ b/docs/src/modules/is.md @@ -90,7 +90,7 @@ Returns `true` when `v` is a boolean. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isBoolean` (`boolean`): Whether the check succeeds. **Example**: @@ -110,7 +110,7 @@ Returns `true` when `v` is a function. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isFunction` (`boolean`): Whether the check succeeds. **Example**: @@ -130,7 +130,7 @@ Returns `true` when `v` is `nil`. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isNil` (`boolean`): Whether the check succeeds. **Example**: @@ -150,7 +150,7 @@ Returns `true` when `v` is a number. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isNumber` (`boolean`): Whether the check succeeds. **Example**: @@ -170,7 +170,7 @@ Returns `true` when `v` is a string. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isString` (`boolean`): Whether the check succeeds. **Example**: @@ -190,7 +190,7 @@ Returns `true` when `v` is a table. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isTable` (`boolean`): Whether the check succeeds. **Example**: @@ -210,7 +210,7 @@ Returns `true` when `v` is a thread. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isThread` (`boolean`): Whether the check succeeds. **Example**: @@ -230,7 +230,7 @@ Returns `true` when `v` is userdata. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isUserdata` (`boolean`): Whether the check succeeds. **Example**: @@ -252,7 +252,7 @@ Returns `true` when `v` is exactly `false`. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isFalse` (`boolean`): Whether the check succeeds. **Example**: @@ -272,7 +272,7 @@ Returns `true` when `v` is exactly `true`. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isTrue` (`boolean`): Whether the check succeeds. **Example**: @@ -292,7 +292,7 @@ Returns `true` when `v` is falsy. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isFalsy` (`boolean`): Whether the check succeeds. **Example**: @@ -312,7 +312,7 @@ Returns `true` when `v` is callable. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isCallable` (`boolean`): Whether the check succeeds. **Example**: @@ -332,7 +332,7 @@ Returns `true` when `v` is an integer. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isInteger` (`boolean`): Whether the check succeeds. **Example**: @@ -352,7 +352,7 @@ Returns `true` when `v` is truthy. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isTruthy` (`boolean`): Whether the check succeeds. **Example**: @@ -380,7 +380,7 @@ Returns `true` when `v` is a block device path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isBlock` (`boolean`): Whether the check succeeds. **Example**: @@ -400,7 +400,7 @@ Returns `true` when `v` is a character device path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isChar` (`boolean`): Whether the check succeeds. **Example**: @@ -420,7 +420,7 @@ Returns `true` when `v` is a block or character device path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isDevice` (`boolean`): Whether the check succeeds. **Example**: @@ -440,7 +440,7 @@ Returns `true` when `v` is a directory path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isDir` (`boolean`): Whether the check succeeds. **Example**: @@ -460,7 +460,7 @@ Returns `true` when `v` is a FIFO path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isFifo` (`boolean`): Whether the check succeeds. **Example**: @@ -480,7 +480,7 @@ Returns `true` when `v` is a file path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isFile` (`boolean`): Whether the check succeeds. **Example**: @@ -500,7 +500,7 @@ Returns `true` when `v` is a symlink path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isLink` (`boolean`): Whether the check succeeds. **Example**: @@ -520,7 +520,7 @@ Returns `true` when `v` is a socket path. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isSocket` (`boolean`): Whether the check succeeds. **Example**: diff --git a/docs/src/modules/keyword.md b/docs/src/modules/keyword.md index 502eee8..94b5a11 100644 --- a/docs/src/modules/keyword.md +++ b/docs/src/modules/keyword.md @@ -37,7 +37,7 @@ Return `true` when `v` is a reserved Lua keyword. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isKeyword` (`boolean`): Whether the check succeeds. **Example**: @@ -58,7 +58,7 @@ Return `true` when `v` is a valid non-keyword Lua identifier. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isIdentifier` (`boolean`): Whether the check succeeds. **Example**: @@ -111,7 +111,7 @@ Normalize an input into a safe Lua identifier. **Return**: -- `ident` (`string`): Normalized Lua identifier. +- `identifier` (`string`): Normalized Lua identifier. **Example**: diff --git a/docs/src/modules/list.md b/docs/src/modules/list.md index 3e0f300..1ec6f76 100644 --- a/docs/src/modules/list.md +++ b/docs/src/modules/list.md @@ -128,7 +128,7 @@ Return true if all values match the predicate. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `allMatch` (`boolean`): Whether the condition is met. **Example**: @@ -153,7 +153,7 @@ Return true if any value matches the predicate. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `anyMatch` (`boolean`): Whether the condition is met. **Example**: @@ -174,7 +174,7 @@ Compare two lists using shallow element equality. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isEqual` (`boolean`): Whether the condition is met. **Example**: @@ -225,7 +225,7 @@ Compare two lists lexicographically. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isLess` (`boolean`): Whether the condition is met. **Example**: @@ -250,7 +250,7 @@ Compare two lists lexicographically. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isLessOrEqual` (`boolean`): Whether the condition is met. **Example**: @@ -392,7 +392,7 @@ Remove and return the last element. **Return**: -- `value` (`any`): Removed value. +- `removedValue` (`any`): Removed value. **Example**: @@ -413,7 +413,7 @@ Remove and return the element at the given position. **Return**: -- `value` (`any`): Removed value. +- `removedValue` (`any`): Removed value. **Example**: @@ -518,7 +518,7 @@ Return true if the list contains the value. **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isPresent` (`boolean`): True when `v` is present in the list. **Example**: @@ -617,7 +617,7 @@ Return the first element or `nil` if empty. **Return**: -- `value` (`any`): First value, or `nil` if empty. +- `firstValue` (`any`): First value, or `nil` if empty. **Example**: @@ -633,7 +633,7 @@ Return the last element or `nil` if empty. **Return**: -- `value` (`any`): Last value, or `nil` if empty. +- `lastValue` (`any`): Last value, or `nil` if empty. **Example**: @@ -823,7 +823,7 @@ Concatenate list values using Lua's native `table.concat` behavior. **Return**: -- `s` (`string`): Concatenated string. +- `concatenated` (`string`): Concatenated string. **Example**: @@ -849,7 +849,7 @@ Join list values into a string. **Return**: -- `s` (`string`): Joined string. +- `joined` (`string`): Joined string. **Example**: @@ -871,7 +871,7 @@ Render the list to a string via the regular method form. **Return**: -- `s` (`string`): Rendered list string. +- `renderedList` (`string`): Rendered list string. **Example**: @@ -891,7 +891,7 @@ Render list items as a table-access key path. **Return**: -- `s` (`string`): Key-path string. +- `keyPath` (`string`): Key-path string. **Example**: @@ -958,7 +958,7 @@ Reduce the list to a single value using an accumulator. **Return**: -- `res` (`any`): Reduced value. +- `reducedValue` (`any`): Reduced value. **Example**: @@ -1107,7 +1107,7 @@ Compare two lists using shallow element equality (`==`). **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isEqual` (`boolean`): Whether the condition is met. **Example**: @@ -1156,7 +1156,7 @@ Compare two lists lexicographically (`<`). **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isLess` (`boolean`): Whether the condition is met. **Example**: @@ -1180,7 +1180,7 @@ Compare two lists lexicographically (`<=`). **Return**: -- `ok` (`boolean`): Whether the condition is met. +- `isLessOrEqual` (`boolean`): Whether the condition is met. **Example**: @@ -1278,7 +1278,7 @@ Render the list to a string like `{ "a", "b", 1 }`. **Return**: -- `s` (`string`): Rendered list string. +- `renderedList` (`string`): Rendered list string. **Example**: diff --git a/docs/src/modules/ntpath.md b/docs/src/modules/ntpath.md index 2684ed4..a7c59d2 100644 --- a/docs/src/modules/ntpath.md +++ b/docs/src/modules/ntpath.md @@ -1,10 +1,10 @@ --- -description: "Lexical path operations for Windows/NT-style paths." +description: "Path operations for Windows/NT-style paths." --- # `ntpath` -Lexical path operations for Windows/NT-style paths. +Path operations for Windows/NT-style paths. > 💡Python `ntpath`-style behavior, ported to Lua. @@ -36,7 +36,7 @@ Return `true` when `path` points to a mount root. **Return**: -- `value` (`boolean`): `true` if the path resolves to a mount root. +- `isMount` (`boolean`): `true` if the path resolves to a mount root. **Example**: @@ -56,7 +56,7 @@ Return `true` when `path` contains a reserved NT filename. **Return**: -- `value` (`boolean`): `true` if any component is NT-reserved. +- `isReserved` (`boolean`): `true` if any component is NT-reserved. **Example**: diff --git a/docs/src/modules/operator.md b/docs/src/modules/operator.md index ae780ac..3e8aa8a 100644 --- a/docs/src/modules/operator.md +++ b/docs/src/modules/operator.md @@ -482,7 +482,7 @@ Return the value at key/index `k` in table `t`. **Return**: -- `value` (`T`): Value stored at `t[k]`. +- `indexedValue` (`T`): Value stored at `t[k]`. **Example**: @@ -504,7 +504,7 @@ Set `t[k] = v` and return the assigned value. **Return**: -- `value` (`T`): Assigned value `v`. +- `assignedValue` (`T`): Assigned value `v`. **Example**: @@ -525,7 +525,7 @@ Call a function with variadic arguments and return its result. **Return**: -- `result` (`T2`): Return value(s) from `f(...)`. +- `callResult` (`T2`): Return value(s) from `f(...)`. **Example**: diff --git a/docs/src/modules/posixpath.md b/docs/src/modules/posixpath.md index cba1d1b..c0db09c 100644 --- a/docs/src/modules/posixpath.md +++ b/docs/src/modules/posixpath.md @@ -1,10 +1,10 @@ --- -description: "Lexical path operations for POSIX-style paths." +description: "Path operations for POSIX-style paths." --- # `posixpath` -Lexical path operations for POSIX-style paths. +Path operations for POSIX-style paths. > 💡 Python `posixpath`-style behavior, ported to Lua. diff --git a/docs/src/modules/set.md b/docs/src/modules/set.md index ad774bf..ee20a2b 100644 --- a/docs/src/modules/set.md +++ b/docs/src/modules/set.md @@ -167,7 +167,7 @@ Remove and return an arbitrary element. **Return**: -- `value` (`any`): Removed value, or `nil` when the set is empty. +- `removedValue` (`any`): Removed value, or `nil` when the set is empty. **Example**: @@ -367,7 +367,7 @@ Return true if sets have no elements in common. **Return**: -- `ok` (`boolean`): True when sets have no elements in common. +- `isDisjoint` (`boolean`): True when sets have no elements in common. **Example**: @@ -387,7 +387,7 @@ Return true when both sets contain exactly the same members. **Return**: -- `ok` (`boolean`): True when both sets contain the same members. +- `isEqual` (`boolean`): True when both sets contain the same members. **Example**: @@ -410,7 +410,7 @@ Return true if the set has no elements. **Return**: -- `ok` (`boolean`): True when the set has no elements. +- `isEmpty` (`boolean`): True when the set has no elements. **Example**: @@ -430,7 +430,7 @@ Return true if all elements of this set are also in another set. **Return**: -- `ok` (`boolean`): True when every element of `self` exists in `set`. +- `isSubset` (`boolean`): True when every element of `self` exists in `set`. **Example**: @@ -455,7 +455,7 @@ Return true if this set contains all elements of another set. **Return**: -- `ok` (`boolean`): True when `self` contains every element of `set`. +- `isSuperset` (`boolean`): True when `self` contains every element of `set`. **Example**: @@ -477,7 +477,7 @@ Return true if the set contains `v`. **Return**: -- `ok` (`boolean`): True when `v` is present in the set. +- `isPresent` (`boolean`): True when `v` is present in the set. **Example**: @@ -658,7 +658,7 @@ Return true if both sets contain exactly the same members using `==`. **Return**: -- `ok` (`boolean`): True when both sets contain the same members. +- `isEqual` (`boolean`): True when both sets contain the same members. **Example**: @@ -682,7 +682,7 @@ Return true if the left set is a subset of the right set using `<=`. **Return**: -- `ok` (`boolean`): True when `self` is a subset of `set`. +- `isSubset` (`boolean`): True when `self` is a subset of `set`. **Example**: @@ -708,7 +708,7 @@ Return true if the left set is a proper subset of the right set using `<`. **Return**: -- `ok` (`boolean`): True when `self` is a proper subset of `set`. +- `isProperSubset` (`boolean`): True when `self` is a proper subset of `set`. **Example**: diff --git a/docs/src/modules/str.md b/docs/src/modules/str.md index 6ed0bc6..f449cb1 100644 --- a/docs/src/modules/str.md +++ b/docs/src/modules/str.md @@ -97,7 +97,7 @@ Return copy with first character capitalized and the rest lowercased. **Return**: -- `s` (`string`): Computed string value. +- `capitalized` (`string`): Capitalized string. **Example**: @@ -119,7 +119,7 @@ Center string within width, padded with fill characters. **Return**: -- `s` (`string`): Computed string value. +- `centered` (`string`): Centered string. **Example**: @@ -142,7 +142,7 @@ Count non-overlapping occurrences of a substring. **Return**: -- `n` (`integer`): Computed numeric value. +- `count` (`integer`): Number of non-overlapping matches. **Example**: @@ -167,7 +167,7 @@ Return true if string ends with suffix. **Return**: -- `ok` (`boolean`): True when `s` ends with `suffix`. +- `hasSuffix` (`boolean`): True when `s` ends with `suffix`. **Example**: @@ -192,7 +192,7 @@ Expand tabs to spaces using given tabsize. **Return**: -- `s` (`string`): Computed string value. +- `expanded` (`string`): String with tabs expanded. **Example**: @@ -236,7 +236,7 @@ Format string with mapping (key-based) replacement. **Return**: -- `s` (`string`): Formatted string with placeholders replaced. +- `formatted` (`string`): Formatted string with placeholders replaced. **Example**: @@ -263,7 +263,7 @@ Return true if all characters are alphanumeric and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are +- `isAlnum` (`boolean`): True when `s` is non-empty and all characters are alphanumeric. **Example**: @@ -292,7 +292,7 @@ Return true if all characters are alphabetic and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are +- `isAlpha` (`boolean`): True when `s` is non-empty and all characters are alphabetic. **Example**: @@ -321,7 +321,7 @@ Return true if all characters are ASCII. **Return**: -- `ok` (`boolean`): True when all bytes in `s` are ASCII. +- `isAscii` (`boolean`): True when all bytes in `s` are ASCII. **Example**: @@ -345,8 +345,8 @@ Return true if all characters are decimal characters and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are decimal - digits. +- `isDecimal` (`boolean`): True when `s` is non-empty and all characters are + decimal digits. **Example**: @@ -366,7 +366,8 @@ Return true if all characters are digits and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are digits. +- `isDigit` (`boolean`): True when `s` is non-empty and all characters are + digits. **Example**: @@ -386,7 +387,8 @@ Return true if string is a valid identifier and not a reserved keyword. **Return**: -- `ok` (`boolean`): True when `s` is a valid identifier and not a keyword. +- `isIdentifier` (`boolean`): True when `s` is a valid identifier and not a + keyword. **Example**: @@ -409,8 +411,8 @@ cased character. **Return**: -- `ok` (`boolean`): True when `s` has at least one cased character and all are - lowercase. +- `isLower` (`boolean`): True when `s` has at least one cased character and all + are lowercase. **Example**: @@ -430,7 +432,8 @@ Return true if all characters are numeric and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are numeric. +- `isNumeric` (`boolean`): True when `s` is non-empty and all characters are + numeric. **Example**: @@ -450,7 +453,7 @@ Return true if all characters are printable. **Return**: -- `ok` (`boolean`): True when all bytes in `s` are printable ASCII. +- `isPrintable` (`boolean`): True when all bytes in `s` are printable ASCII. **Example**: @@ -474,7 +477,7 @@ Return true if all characters are whitespace and string is non-empty. **Return**: -- `ok` (`boolean`): True when `s` is non-empty and all characters are +- `isSpace` (`boolean`): True when `s` is non-empty and all characters are whitespace. **Example**: @@ -495,7 +498,7 @@ Return true if string is titlecased. **Return**: -- `ok` (`boolean`): True when `s` is titlecased. +- `isTitle` (`boolean`): True when `s` is titlecased. **Example**: @@ -516,8 +519,8 @@ cased character. **Return**: -- `ok` (`boolean`): True when `s` has at least one cased character and all are - uppercase. +- `isUpper` (`boolean`): True when `s` has at least one cased character and all + are uppercase. **Example**: @@ -540,7 +543,7 @@ Join an array-like table of strings using this string as separator. **Return**: -- `s` (`string`): Computed string value. +- `joined` (`string`): Joined string. **Example**: @@ -562,7 +565,7 @@ Left-justify string in a field of given width. **Return**: -- `s` (`string`): Computed string value. +- `leftJustified` (`string`): Left-justified string. **Example**: @@ -582,7 +585,7 @@ Return lowercased copy. **Return**: -- `s` (`string`): Computed string value. +- `lowercased` (`string`): Lowercased string. **Example**: @@ -603,7 +606,7 @@ Remove leading characters (default: whitespace). **Return**: -- `s` (`string`): Computed string value. +- `leadingStripped` (`string`): String with leading characters removed. **Example**: @@ -624,7 +627,7 @@ Remove trailing characters (default: whitespace). **Return**: -- `s` (`string`): Computed string value. +- `trailingStripped` (`string`): String with trailing characters removed. **Example**: @@ -645,7 +648,7 @@ Remove leading and trailing characters (default: whitespace). **Return**: -- `s` (`string`): Computed string value. +- `stripped` (`string`): String with leading and trailing characters removed. **Example**: @@ -669,7 +672,7 @@ Partition string into head, sep, tail from left. **Return**: - `head` (`string`): Part before the separator. -- `sep_found` (`string`): Matched separator, or empty string when not found. +- `separator` (`string`): Matched separator, or empty string when not found. - `tail` (`string`): Part after the separator. **Example**: @@ -691,7 +694,7 @@ Remove prefix if present. **Return**: -- `s` (`string`): Computed string value. +- `prefixRemoved` (`string`): String with prefix removed when present. **Example**: @@ -712,7 +715,7 @@ Remove suffix if present. **Return**: -- `s` (`string`): Computed string value. +- `suffixRemoved` (`string`): String with suffix removed when present. **Example**: @@ -735,7 +738,7 @@ Return a copy of the string with all occurrences of a substring replaced. **Return**: -- `s` (`string`): Computed string value. +- `replaced` (`string`): String with replacements applied. **Example**: @@ -781,7 +784,7 @@ Like `rfind` but raises an error when the substring is not found. **Return**: -- `index` (`integer`): Computed numeric value. +- `index` (`integer`): Last match index. **Example**: @@ -803,7 +806,7 @@ Right-justify string in a field of given width. **Return**: -- `s` (`string`): Computed string value. +- `rightJustified` (`string`): Right-justified string. **Example**: @@ -825,7 +828,7 @@ Partition string into head, sep, tail from right. **Return**: - `head` (`string`): Part before the separator. -- `sep_found` (`string`): Matched separator, or empty string when not found. +- `separator` (`string`): Matched separator, or empty string when not found. - `tail` (`string`): Part after the separator. **Example**: @@ -913,7 +916,7 @@ Return a copy with case of alphabetic characters swapped. **Return**: -- `s` (`string`): Computed string value. +- `swappedCase` (`string`): String with alphabetic case swapped. **Example**: @@ -936,7 +939,7 @@ Return true if string starts with prefix. **Return**: -- `ok` (`boolean`): True when `s` starts with `prefix`. +- `hasPrefix` (`boolean`): True when `s` starts with `prefix`. **Example**: @@ -960,7 +963,7 @@ Return titlecased copy. **Return**: -- `s` (`string`): Computed string value. +- `titlecased` (`string`): Titlecased string. **Example**: @@ -981,7 +984,7 @@ Translate characters using a mapping table. **Return**: -- `s` (`string`): Computed string value. +- `translated` (`string`): Translated string. **Example**: @@ -1002,7 +1005,7 @@ Return uppercased copy. **Return**: -- `s` (`string`): Computed string value. +- `uppercased` (`string`): Uppercased string. **Example**: @@ -1023,7 +1026,7 @@ Pad numeric string on the left with zeros. **Return**: -- `s` (`string`): Computed string value. +- `zeroFilled` (`string`): Zero-padded string. **Example**: diff --git a/docs/src/modules/stringcase.md b/docs/src/modules/stringcase.md index d073e0f..a0a2036 100644 --- a/docs/src/modules/stringcase.md +++ b/docs/src/modules/stringcase.md @@ -61,7 +61,7 @@ Convert string to all lowercase. **Return**: -- `s` (`string`): Lowercased string. +- `lowercased` (`string`): Lowercased string. **Example**: @@ -82,7 +82,7 @@ Convert string to all uppercase. **Return**: -- `s` (`string`): Uppercased string. +- `uppercased` (`string`): Uppercased string. **Example**: @@ -105,7 +105,7 @@ Convert string to snake_case. **Return**: -- `s` (`string`): Snake-cased string. +- `snakeCased` (`string`): Snake-cased string. **Example**: @@ -126,7 +126,7 @@ Convert string to camelCase. **Return**: -- `s` (`string`): Camel-cased string. +- `camelCased` (`string`): Camel-cased string. **Example**: @@ -148,7 +148,7 @@ Normalize to snake_case, then replace underscores with a separator. **Return**: -- `s` (`string`): String with underscores replaced by `sep`. +- `replaced` (`string`): String with underscores replaced by `sep`. **Example**: @@ -169,7 +169,7 @@ Get acronym of words in string (first letters only). **Return**: -- `s` (`string`): Acronym string. +- `acronym` (`string`): Acronym string. **Example**: @@ -190,7 +190,7 @@ Convert string to Title Case (first letter of each word capitalized). **Return**: -- `s` (`string`): Title-cased string. +- `titleCased` (`string`): Title-cased string. **Example**: @@ -211,7 +211,7 @@ Convert string to CONSTANT_CASE (uppercase snake_case). **Return**: -- `s` (`string`): Constant-cased string. +- `constantCased` (`string`): Constant-cased string. **Example**: @@ -232,7 +232,7 @@ Convert string to PascalCase. **Return**: -- `s` (`string`): Pascal-cased string. +- `pascalCased` (`string`): Pascal-cased string. **Example**: @@ -253,7 +253,7 @@ Convert string to kebab-case. **Return**: -- `s` (`string`): Kebab-cased string. +- `kebabCased` (`string`): Kebab-cased string. **Example**: @@ -274,7 +274,7 @@ Convert string to dot.case. **Return**: -- `s` (`string`): Dot-cased string. +- `dotCased` (`string`): Dot-cased string. **Example**: @@ -295,7 +295,7 @@ Convert string to space case (spaces between words). **Return**: -- `s` (`string`): Space-cased string. +- `spaceCased` (`string`): Space-cased string. **Example**: @@ -316,7 +316,7 @@ Convert string to path/case (slashes between words). **Return**: -- `s` (`string`): Path-cased string. +- `pathCased` (`string`): Path-cased string. **Example**: @@ -339,7 +339,7 @@ Swap case of each letter. **Return**: -- `s` (`string`): Swap-cased string. +- `swapCased` (`string`): Swap-cased string. **Example**: @@ -360,7 +360,7 @@ Capitalize the first letter and lowercase the rest. **Return**: -- `s` (`string`): Capitalized string. +- `capitalized` (`string`): Capitalized string. **Example**: @@ -381,7 +381,7 @@ Convert string to sentence case (first letter uppercase, rest unchanged). **Return**: -- `s` (`string`): Sentence-cased string. +- `sentenceCased` (`string`): Sentence-cased string. **Example**: diff --git a/docs/src/modules/tbl.md b/docs/src/modules/tbl.md index 17590a0..f089a1d 100644 --- a/docs/src/modules/tbl.md +++ b/docs/src/modules/tbl.md @@ -129,7 +129,7 @@ Create a deep copy of a value. **Return**: -- `copy` (`T`): Deep-copied value. +- `copiedValue` (`T`): Deep-copied value. **Example**: @@ -202,7 +202,7 @@ Return `true` if two tables have the same keys and equal values. **Return**: -- `ok` (`boolean`): True when both tables have the same keys and values. +- `isSame` (`boolean`): True when both tables have the same keys and values. **Example**: @@ -224,7 +224,7 @@ Find first value and key matching predicate. **Return**: -- `v` (`T1?`): First matching value, or `nil` when not found. +- `matchedValue` (`T1?`): First matching value, or `nil` when not found. - `k` (`T2?`): Key for the first matching value, or `nil` when not found. **Example**: @@ -248,7 +248,7 @@ Safely get nested value by keys. **Return**: -- `value` (`any`): Nested value, or `nil` when any key is missing. +- `nestedValue` (`any`): Nested value, or `nil` when any key is missing. **Example**: @@ -296,7 +296,7 @@ Return true if table has no entries. **Return**: -- `ok` (`boolean`): True when `t` has no entries. +- `isEmpty` (`boolean`): True when `t` has no entries. **Example**: diff --git a/docs/src/modules/utils.md b/docs/src/modules/utils.md index 9bdd03c..d3a40a8 100644 --- a/docs/src/modules/utils.md +++ b/docs/src/modules/utils.md @@ -78,7 +78,7 @@ error on failure. **Return**: -- `v` (`T`): Same input value on success. +- `validatedValue` (`T`): Same input value on success. **Example**: diff --git a/docs/src/modules/validate.md b/docs/src/modules/validate.md index 53e3d36..4605e2d 100644 --- a/docs/src/modules/validate.md +++ b/docs/src/modules/validate.md @@ -102,7 +102,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -125,7 +125,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -149,7 +149,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -172,7 +172,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -195,7 +195,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -218,7 +218,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -241,7 +241,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -265,7 +265,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -291,7 +291,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -314,7 +314,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -337,7 +337,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -360,7 +360,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -383,7 +383,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -406,7 +406,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -437,7 +437,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -459,7 +459,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -481,7 +481,7 @@ Returns `true` when `v` is a block or char device path. Otherwise returns **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -503,7 +503,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -525,7 +525,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -547,7 +547,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -569,7 +569,7 @@ error message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: @@ -591,7 +591,7 @@ message. **Return**: -- `ok` (`boolean`): Whether the check succeeds. +- `isValid` (`boolean`): Whether the check succeeds. - `err` (`string?`): Error message when the check fails. **Example**: