docs: add docs for invertString

Arcath · Mar 28, 2023 · 08836f0 · 08836f0
1 parent e9bd10f
commit 08836f0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/functions/strings.ts b/src/functions/strings.ts
@@ -15,6 +15,11 @@ export const rndFromString = (string: string, base: number = 1) => {
   return Math.round((n - Math.floor(n)) * base)
 }
 
+/**
+ * Inverts alphabetic characters, `abc` becomes `zyx`.
+ *
+ * @param string The string to invert
+ */
 export const invertString = (string: string) => {
   return string
     .split('')