@zinaid/str 0.0.6 → 0.0.8

package/dist/ascii/index.d.ts

@@ -1,9 +1,25 @@
 /**
  * Transliterate a UTF-8 value to ASCII.
  *
+ * @param value The value to transliterate.
+ * @return The transliterated ASCII string.
+ *
+ * @requires {@link https://www.npmjs.com/package/transliteration transliteration package}
+ *
  * @example
  *
  * ascii('Héllo Wörld'); -> 'Hello World'
  */
 export declare function ascii(value: string): string;
+/**
+ * Generate a URL friendly "slug" from a given string.
+ *
+ * @param title - The string to convert to a slug
+ * @param separator - The word separator to use (default: "-")
+ * @param dictionary - An optional dictionary of replacements
+ * @returns The generated slug string
+ *
+ * @requires {@link https://www.npmjs.com/package/transliteration transliteration package}
+ */
+export declare function slug(title: string, separator?: string, dictionary?: Record<string, string>): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/ascii/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ascii/index.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ascii/index.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;GAWG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;;;;;GASG;AACH,wBAAgB,IAAI,CAChB,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,MAAY,EACvB,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAiB,GACnD,MAAM,CAwER"}

package/dist/ascii/index.js

@@ -1,7 +1,46 @@
-import { transliterate as t } from "transliteration";
-function e(r) {
-  return t(r);
+import { lower as m } from "@zinaid/str";
+import { transliterate as w } from "transliteration";
+function h(r) {
+  return w(r);
+}
+function A(r, i = "-", p = { "@": "at" }) {
+  const s = i, a = (t) => t.replace(/[-\\^$*+?.()|[\]{}]/g, "\\$&"), l = (t) => t.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), u = (t) => {
+    let e = t;
+    const $ = s === "-" ? "_" : "-";
+    {
+      const o = new RegExp(`[${a($)}]+`, "gu");
+      e = e.replace(o, s);
+    }
+    if (p && typeof p == "object") {
+      const o = {};
+      for (const [c, n] of Object.entries(p))
+        o[c] = (s ?? "") + n + (s ?? "");
+      for (const [c, n] of Object.entries(o))
+        c !== "" && (e = e.split(c).join(n));
+    }
+    if (e = m(e), s === "")
+      return e = e.replace(/[^\p{L}\p{N}\s]+/gu, ""), e = e.replace(/[\s]+/gu, ""), e;
+    {
+      const o = new RegExp(
+        `[^${a(s)}\\p{L}\\p{N}\\s]+`,
+        "gu"
+      );
+      e = e.replace(o, "");
+      const c = new RegExp(
+        `[${a(s)}\\s]+`,
+        "gu"
+      );
+      e = e.replace(c, s);
+      const n = new RegExp(
+        `^${l(s)}+|${l(s)}+$`,
+        "gu"
+      );
+      return e = e.replace(n, ""), e;
+    }
+  }, f = u(r), g = u(h(r));
+  return Object.keys(p || {}).some((t) => /[A-Za-z0-9]/.test(t)) ? g : f;
 }
 export {
-  e as ascii
+  h as ascii,
+  A as slug
 };

package/dist/base64/index.d.ts

@@ -1,7 +1,23 @@
+/**
+ * Convert the given string to Base64 encoding.
+ *
+ * @param value - The string to encode.
+ * @returns The Base64 encoded string.
+ */
 export declare function toBase64(value: string): string;
 /**
  * Convert raw bytes to a Base64 string using the same fallbacks as toBase64.
+ *
+ * @param bytes - The bytes to encode.
+ * @returns The Base64 encoded string.
  */
 export declare function bytesToBase64(bytes: Uint8Array): string;
+/**
+ * Decode the given Base64 encoded string.
+ *
+ * @param value - The Base64 encoded string to decode.
+ * @param strict - Whether to enforce strict Base64 validation.
+ * @returns The decoded string or false if decoding fails.
+ */
 export declare function fromBase64(value: string, strict?: boolean): string | false;
 //# sourceMappingURL=index.d.ts.map

package/dist/base64/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base64/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CA+B9C;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAsBvD;AAED,wBAAgB,UAAU,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,OAAe,GACxB,MAAM,GAAG,KAAK,CAqEhB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base64/index.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAgC9C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAsBvD;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACtB,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,OAAe,GACxB,MAAM,GAAG,KAAK,CAqEhB"}

package/dist/base64/index.js

@@ -1,29 +1,30 @@
-function m(n) {
-  const o = l();
-  if (o.Buffer && typeof o.Buffer.from == "function")
-    return o.Buffer.from(n, "utf8").toString("base64");
-  if (typeof o.btoa == "function")
+import { isFunction as l } from "@zinaid/utils";
+function S(r) {
+  const o = h();
+  if (o.Buffer && l(o.Buffer.from))
+    return o.Buffer.from(r, "utf8").toString("base64");
+  if (l(o.btoa))
     try {
-      const t = g(n);
+      const t = d(r);
       return o.btoa(t);
     } catch {
-      return o.btoa(n);
+      return o.btoa(r);
     }
-  const e = g(n);
-  return d(e);
+  const e = d(r);
+  return p(e);
 }
-function B(n) {
-  const o = l();
-  if (o.Buffer && typeof o.Buffer.from == "function")
-    return o.Buffer.from(n).toString("base64");
+function T(r) {
+  const o = h();
+  if (o.Buffer && l(o.Buffer.from))
+    return o.Buffer.from(r).toString("base64");
   let e = "";
-  for (let t = 0; t < n.length; t++)
-    e += String.fromCharCode(n[t]);
-  return typeof o.btoa == "function" ? o.btoa(e) : d(e);
+  for (let t = 0; t < r.length; t++)
+    e += String.fromCharCode(r[t]);
+  return l(o.btoa) ? o.btoa(e) : p(e);
 }
-function y(n, o = !1) {
-  const e = l();
-  let t = String(n);
+function y(r, o = !1) {
+  const e = h();
+  let t = String(r);
   if (o) {
     const c = t.replace(/\s+/g, "");
     if (!/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(c))
@@ -31,13 +32,13 @@ function y(n, o = !1) {
     t = c;
   } else
     t = t.replace(/[^A-Za-z0-9+/=]/g, "");
-  if (e.Buffer && typeof e.Buffer.from == "function")
+  if (e.Buffer && l(e.Buffer.from))
     try {
       return e.Buffer.from(t, "base64").toString("utf8");
     } catch {
       return !1;
     }
-  if (typeof e.atob == "function")
+  if (l(e.atob))
     try {
       const c = e.atob(t);
       if (typeof e.TextDecoder == "function") {
@@ -46,68 +47,68 @@ function y(n, o = !1) {
           f[a] = c.charCodeAt(a);
         return new e.TextDecoder("utf-8").decode(f);
       }
-      let r = "";
+      let n = "";
       for (let f = 0; f < c.length; f++)
-        r += "%" + c.charCodeAt(f).toString(16).padStart(2, "0");
-      return decodeURIComponent(r);
+        n += "%" + c.charCodeAt(f).toString(16).padStart(2, "0");
+      return decodeURIComponent(n);
     } catch {
       return !1;
     }
   try {
-    const c = A(t);
+    const c = m(t);
     return C(c);
   } catch {
     return !1;
   }
 }
-function l() {
+function h() {
   return globalThis;
 }
-function g(n) {
-  return encodeURIComponent(n).replace(
+function d(r) {
+  return encodeURIComponent(r).replace(
     /%([0-9A-F]{2})/g,
     (o, e) => String.fromCharCode(parseInt(e, 16))
   );
 }
-function d(n) {
+function p(r) {
   const o = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
   let e = "";
-  for (let t = 0; t < n.length; t += 3) {
-    const c = n.charCodeAt(t), r = n.charCodeAt(t + 1), f = n.charCodeAt(t + 2), a = (c ?? 0) << 16 | (r ?? 0) << 8 | (f ?? 0), i = a >> 18 & 63, s = a >> 12 & 63, u = a >> 6 & 63, h = a & 63;
-    isNaN(r) ? e += o.charAt(i) + o.charAt(s) + "==" : isNaN(f) ? e += o.charAt(i) + o.charAt(s) + o.charAt(u) + "=" : e += o.charAt(i) + o.charAt(s) + o.charAt(u) + o.charAt(h);
+  for (let t = 0; t < r.length; t += 3) {
+    const c = r.charCodeAt(t), n = r.charCodeAt(t + 1), f = r.charCodeAt(t + 2), a = (c ?? 0) << 16 | (n ?? 0) << 8 | (f ?? 0), i = a >> 18 & 63, s = a >> 12 & 63, u = a >> 6 & 63, g = a & 63;
+    isNaN(n) ? e += o.charAt(i) + o.charAt(s) + "==" : isNaN(f) ? e += o.charAt(i) + o.charAt(s) + o.charAt(u) + "=" : e += o.charAt(i) + o.charAt(s) + o.charAt(u) + o.charAt(g);
   }
   return e;
 }
-function A(n) {
+function m(r) {
   const o = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/", e = /* @__PURE__ */ new Map();
-  for (let r = 0; r < o.length; r++)
-    e.set(o[r], r);
-  const t = n.replace(/=+$/g, ""), c = [];
-  for (let r = 0; r < t.length; r += 4) {
-    const f = e.has(t[r]) ? e.get(t[r]) : 64, a = e.has(t[r + 1]) ? e.get(t[r + 1]) : 64, i = e.has(t[r + 2]) ? e.get(t[r + 2]) : 64, s = e.has(t[r + 3]) ? e.get(t[r + 3]) : 64, u = f << 18 | a << 12 | (i & 63) << 6 | s & 63, h = u >> 16 & 255, p = u >> 8 & 255, b = u & 255;
-    c.push(h), i !== 64 && c.push(p), s !== 64 && c.push(b);
+  for (let n = 0; n < o.length; n++)
+    e.set(o[n], n);
+  const t = r.replace(/=+$/g, ""), c = [];
+  for (let n = 0; n < t.length; n += 4) {
+    const f = e.has(t[n]) ? e.get(t[n]) : 64, a = e.has(t[n + 1]) ? e.get(t[n + 1]) : 64, i = e.has(t[n + 2]) ? e.get(t[n + 2]) : 64, s = e.has(t[n + 3]) ? e.get(t[n + 3]) : 64, u = f << 18 | a << 12 | (i & 63) << 6 | s & 63, g = u >> 16 & 255, b = u >> 8 & 255, A = u & 255;
+    c.push(g), i !== 64 && c.push(b), s !== 64 && c.push(A);
   }
   return c;
 }
-function C(n) {
-  const o = l();
+function C(r) {
+  const o = h();
   if (typeof o.TextDecoder == "function")
-    return new o.TextDecoder("utf-8").decode(new Uint8Array(n));
+    return new o.TextDecoder("utf-8").decode(new Uint8Array(r));
   let e = "";
-  for (let t = 0; t < n.length; ) {
-    const c = n[t++];
+  for (let t = 0; t < r.length; ) {
+    const c = r[t++];
     if (c < 128)
       e += String.fromCharCode(c);
     else if (c < 224) {
-      const r = n[t++];
-      e += String.fromCharCode((c & 31) << 6 | r & 63);
+      const n = r[t++];
+      e += String.fromCharCode((c & 31) << 6 | n & 63);
     } else if (c < 240) {
-      const r = n[t++], f = n[t++];
+      const n = r[t++], f = r[t++];
       e += String.fromCharCode(
-        (c & 15) << 12 | (r & 63) << 6 | f & 63
+        (c & 15) << 12 | (n & 63) << 6 | f & 63
       );
     } else {
-      const r = n[t++], f = n[t++], a = n[t++], s = ((c & 7) << 18 | (r & 63) << 12 | (f & 63) << 6 | a & 63) - 65536;
+      const n = r[t++], f = r[t++], a = r[t++], s = ((c & 7) << 18 | (n & 63) << 12 | (f & 63) << 6 | a & 63) - 65536;
       e += String.fromCharCode(
         55296 + (s >> 10 & 1023),
         56320 + (s & 1023)
@@ -117,7 +118,7 @@ function C(n) {
   return e;
 }
 export {
-  B as bytesToBase64,
+  T as bytesToBase64,
   y as fromBase64,
-  m as toBase64
+  S as toBase64
 };

package/dist/convertcase/index.d.ts

@@ -12,6 +12,10 @@ export type ConvertCaseMode = (typeof CaseTypes)[keyof typeof CaseTypes];
 /**
  * Convert the case of a string.
  *
+ * @param value - The string to convert.
+ * @param mode - The case conversion mode to apply. Defaults to 'fold'.
+ * @returns The converted string.
+ *
  * @example
  *
  * convertCase('hello', CaseTypes.upper); -> 'HELLO'
@@ -20,6 +24,9 @@ export declare function convertCase(value: string, mode?: ConvertCaseMode): stri
 /**
  * Convert the given string to upper-case.
  *
+ * @param value - The string to convert.
+ * @returns The upper-case string.
+ *
  * @example
  *
  * upper("foo bar baz"); -> "FOO BAR BAZ"
@@ -29,6 +36,9 @@ export declare function upper(value: string): string;
 /**
  * Convert the given string to proper case.
  *
+ * @param value - The string to convert.
+ * @returns The proper-case string.
+ *
  * @example
  *
  * title("foo bar baz"); -> "Foo Bar Baz"

package/dist/convertcase/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/convertcase/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS;;;;;;;;;CASZ,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEzE;;;;;;GAMG;AACH,wBAAgB,WAAW,CACvB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,eAAgC,GACvC,MAAM,CAER;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/convertcase/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS;;;;;;;;;CASZ,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACvB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,eAAgC,GACvC,MAAM,CAER;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3C"}

package/dist/index.js

@@ -1,95 +1,95 @@
-import { ascii as t } from "./ascii/index.js";
-import { bytesToBase64 as s, fromBase64 as i, toBase64 as o } from "./base64/index.js";
-import { CaseTypes as l, convertCase as c, title as p, upper as d } from "./convertcase/index.js";
-import { inlineMarkdown as m, markDownRenderer as f, markdown as h } from "./markdown/index.js";
-import { inflector as S, isPlural as U, isSingular as w, matchCase as x, plural as b, singular as C, uncountable as k } from "./pluralizer/index.js";
-import { randomInt as R, randomString as z } from "./random/index.js";
-import { substr as W, substrCount as q, substrReplace as B } from "./replacer/index.js";
-import { after as v, afterLast as E, apa as M, before as N, beforeLast as P, between as T, betweenFirst as F, camel as D, camelCacheSize as I, charAt as J, chopEnd as O, chopStart as j, contains as G, containsAll as H, createRandomStringsNormally as K, createRandomStringsUsing as Q, createRandomStringsUsingSequence as V, deduplicate as X, doesntContain as Y, doesntEndWith as Z, doesntStartWith as _, endsWith as $, excerpt as ee, finish as re, flushCache as te, headline as ae, is as se, isAscii as ie, isJson as oe, isMatch as ne, isUlid as le, isUrl as ce, kebab as pe, lcfirst as de, length as ue, limit as me, lower as fe, makePad as he, mask as ge, match as Se, matchAll as Ue, numbers as we, padBoth as xe, padLeft as be, padRight as Ce, pascal as ke, password as ye, pluralPascal as Re, pluralStudly as ze, position as Ae, random as We, remove as qe, repeat as Be, replace as Le, replaceArray as ve, replaceEnd as Ee, replaceFirst as Me, replaceLast as Ne, replaceMatches as Pe, replaceStart as Te, reverse as Fe, slug as De, snake as Ie, snakeCacheSize as Je, squish as Oe, start as je, startsWith as Ge, stripTags as He, studly as Ke, studlyCacheSize as Qe, swap as Ve, take as Xe, toStringOr as Ye, ucfirst as Ze, ucsplit as _e, ucwords as $e, unwrap as er, wordCount as rr, wordWrap as tr, words as ar, wrap as sr } from "./str.js";
-import { Stringable as or, of as nr } from "./stringable/index.js";
+import { ascii as t, slug as a } from "./ascii/index.js";
+import { bytesToBase64 as i, fromBase64 as o, toBase64 as n } from "./base64/index.js";
+import { CaseTypes as c, convertCase as p, title as d, upper as u } from "./convertcase/index.js";
+import { inlineMarkdown as f, markDownRenderer as h, markdown as g } from "./markdown/index.js";
+import { inflector as U, isPlural as w, isSingular as x, matchCase as b, plural as C, pluralPascal as k, pluralStudly as y, singular as R, uncountable as z } from "./pluralizer/index.js";
+import { randomInt as W, randomString as q } from "./random/index.js";
+import { substr as L, substrCount as v, substrReplace as E } from "./replacer/index.js";
+import { after as N, afterLast as P, apa as T, before as F, beforeLast as D, between as I, betweenFirst as J, camel as O, camelCacheSize as j, charAt as G, chopEnd as H, chopStart as K, contains as Q, containsAll as V, createRandomStringsNormally as X, createRandomStringsUsing as Y, createRandomStringsUsingSequence as Z, deduplicate as _, doesntContain as $, doesntEndWith as ee, doesntStartWith as re, endsWith as te, excerpt as ae, finish as se, flushCache as ie, headline as oe, is as ne, isAscii as le, isJson as ce, isMatch as pe, isUrl as de, kebab as ue, lcfirst as me, length as fe, limit as he, lower as ge, makePad as Se, mask as Ue, match as we, matchAll as xe, numbers as be, padBoth as Ce, padLeft as ke, padRight as ye, pascal as Re, password as ze, position as Ae, random as We, remove as qe, repeat as Be, replace as Le, replaceArray as ve, replaceEnd as Ee, replaceFirst as Me, replaceLast as Ne, replaceMatches as Pe, replaceStart as Te, reverse as Fe, snake as De, snakeCacheSize as Ie, squish as Je, start as Oe, startsWith as je, stripTags as Ge, studly as He, studlyCacheSize as Ke, swap as Qe, take as Ve, toStringOr as Xe, ucfirst as Ye, ucsplit as Ze, ucwords as _e, unwrap as $e, wordCount as er, wordWrap as rr, words as tr, wrap as ar } from "./str/index.js";
+import { Stringable as ir, of as or, str as nr } from "./stringable/index.js";
 import { transliterate as cr } from "./transliterate/index.js";
 import { ltrim as dr, rtrim as ur, trim as mr } from "./trimmer/index.js";
-import { createUlidsNormally as hr, createUlidsUsing as gr, createUlidsUsingSequence as Sr, freezeUlids as Ur, ulid as wr } from "./ulid/index.js";
-import { createUuidsNormally as br, createUuidsUsing as Cr, createUuidsUsingSequence as kr, freezeUuids as yr, isUuid as Rr, uuid as zr, uuid7 as Ar } from "./uuid/index.js";
+import { createUlidsNormally as hr, createUlidsUsing as gr, createUlidsUsingSequence as Sr, freezeUlids as Ur, isUlid as wr, ulid as xr } from "./ulid/index.js";
+import { createUuidsNormally as Cr, createUuidsUsing as kr, createUuidsUsingSequence as yr, freezeUuids as Rr, isUuid as zr, uuid as Ar, uuid7 as Wr } from "./uuid/index.js";
 export {
-  l as CaseTypes,
-  or as Stringable,
-  v as after,
-  E as afterLast,
-  M as apa,
+  c as CaseTypes,
+  ir as Stringable,
+  N as after,
+  P as afterLast,
+  T as apa,
   t as ascii,
-  N as before,
-  P as beforeLast,
-  T as between,
-  F as betweenFirst,
-  s as bytesToBase64,
-  D as camel,
-  I as camelCacheSize,
-  J as charAt,
-  O as chopEnd,
-  j as chopStart,
-  G as contains,
-  H as containsAll,
-  c as convertCase,
-  K as createRandomStringsNormally,
-  Q as createRandomStringsUsing,
-  V as createRandomStringsUsingSequence,
+  F as before,
+  D as beforeLast,
+  I as between,
+  J as betweenFirst,
+  i as bytesToBase64,
+  O as camel,
+  j as camelCacheSize,
+  G as charAt,
+  H as chopEnd,
+  K as chopStart,
+  Q as contains,
+  V as containsAll,
+  p as convertCase,
+  X as createRandomStringsNormally,
+  Y as createRandomStringsUsing,
+  Z as createRandomStringsUsingSequence,
   hr as createUlidsNormally,
   gr as createUlidsUsing,
   Sr as createUlidsUsingSequence,
-  br as createUuidsNormally,
-  Cr as createUuidsUsing,
-  kr as createUuidsUsingSequence,
-  X as deduplicate,
-  Y as doesntContain,
-  Z as doesntEndWith,
-  _ as doesntStartWith,
-  $ as endsWith,
-  ee as excerpt,
-  re as finish,
-  te as flushCache,
+  Cr as createUuidsNormally,
+  kr as createUuidsUsing,
+  yr as createUuidsUsingSequence,
+  _ as deduplicate,
+  $ as doesntContain,
+  ee as doesntEndWith,
+  re as doesntStartWith,
+  te as endsWith,
+  ae as excerpt,
+  se as finish,
+  ie as flushCache,
   Ur as freezeUlids,
-  yr as freezeUuids,
-  i as fromBase64,
-  ae as headline,
-  S as inflector,
-  m as inlineMarkdown,
-  se as is,
-  ie as isAscii,
-  oe as isJson,
-  ne as isMatch,
-  U as isPlural,
-  w as isSingular,
-  le as isUlid,
-  ce as isUrl,
-  Rr as isUuid,
-  pe as kebab,
-  de as lcfirst,
-  ue as length,
-  me as limit,
-  fe as lower,
+  Rr as freezeUuids,
+  o as fromBase64,
+  oe as headline,
+  U as inflector,
+  f as inlineMarkdown,
+  ne as is,
+  le as isAscii,
+  ce as isJson,
+  pe as isMatch,
+  w as isPlural,
+  x as isSingular,
+  wr as isUlid,
+  de as isUrl,
+  zr as isUuid,
+  ue as kebab,
+  me as lcfirst,
+  fe as length,
+  he as limit,
+  ge as lower,
   dr as ltrim,
-  he as makePad,
-  f as markDownRenderer,
-  h as markdown,
-  ge as mask,
-  Se as match,
-  Ue as matchAll,
-  x as matchCase,
-  we as numbers,
-  nr as of,
-  xe as padBoth,
-  be as padLeft,
-  Ce as padRight,
-  ke as pascal,
-  ye as password,
-  b as plural,
-  Re as pluralPascal,
-  ze as pluralStudly,
+  Se as makePad,
+  h as markDownRenderer,
+  g as markdown,
+  Ue as mask,
+  we as match,
+  xe as matchAll,
+  b as matchCase,
+  be as numbers,
+  or as of,
+  Ce as padBoth,
+  ke as padLeft,
+  ye as padRight,
+  Re as pascal,
+  ze as password,
+  C as plural,
+  k as pluralPascal,
+  y as pluralStudly,
   Ae as position,
   We as random,
-  R as randomInt,
-  z as randomString,
+  W as randomInt,
+  q as randomString,
   qe as remove,
   Be as repeat,
   Le as replace,
@@ -101,37 +101,38 @@ export {
   Te as replaceStart,
   Fe as reverse,
   ur as rtrim,
-  C as singular,
-  De as slug,
-  Ie as snake,
-  Je as snakeCacheSize,
-  Oe as squish,
-  je as start,
-  Ge as startsWith,
-  He as stripTags,
-  Ke as studly,
-  Qe as studlyCacheSize,
-  W as substr,
-  q as substrCount,
-  B as substrReplace,
-  Ve as swap,
-  Xe as take,
-  p as title,
-  o as toBase64,
-  Ye as toStringOr,
+  R as singular,
+  a as slug,
+  De as snake,
+  Ie as snakeCacheSize,
+  Je as squish,
+  Oe as start,
+  je as startsWith,
+  nr as str,
+  Ge as stripTags,
+  He as studly,
+  Ke as studlyCacheSize,
+  L as substr,
+  v as substrCount,
+  E as substrReplace,
+  Qe as swap,
+  Ve as take,
+  d as title,
+  n as toBase64,
+  Xe as toStringOr,
   cr as transliterate,
   mr as trim,
-  Ze as ucfirst,
-  _e as ucsplit,
-  $e as ucwords,
-  wr as ulid,
-  k as uncountable,
-  er as unwrap,
-  d as upper,
-  zr as uuid,
-  Ar as uuid7,
-  rr as wordCount,
-  tr as wordWrap,
-  ar as words,
-  sr as wrap
+  Ye as ucfirst,
+  Ze as ucsplit,
+  _e as ucwords,
+  xr as ulid,
+  z as uncountable,
+  $e as unwrap,
+  u as upper,
+  Ar as uuid,
+  Wr as uuid7,
+  er as wordCount,
+  rr as wordWrap,
+  tr as words,
+  ar as wrap
 };

package/dist/markdown/index.d.ts

@@ -9,6 +9,13 @@ export type MarkDownExtensions = MarkDownExtension[];
 /**
  * Converts GitHub flavored Markdown into HTML.
  *
+ * @param value - The markdown string to convert.
+ * @param options - Options to customize the markdown rendering. Defaults to GFM enabled and no anchors.
+ * @param extensions - An array of markdown-it extensions to apply during rendering.
+ * @returns The resulting HTML string.
+ *
+ * @requires {@link https://www.npmjs.com/package/markdown-it markdown-it package}
+ *
  * @example
  *
  * markdown('# Hello World'); -> '<h1>Hello World</h1>\n'
@@ -17,10 +24,26 @@ export declare function markdown(value: string, options?: MarkDownOptions, exten
 /**
  * Converts inline Markdown into HTML.
  *
+ * @param value - The inline markdown string to convert.
+ * @param options - Options to customize the markdown rendering. Defaults to GFM enabled.
+ * @param extensions - An array of markdown-it extensions to apply during rendering.
+ * @returns The resulting HTML string.
+ *
+ * @requires {@link https://www.npmjs.com/package/markdown-it markdown-it package}
+ *
  * @example
  *
  * inlineMarkdown("Hello *World*"); -> "<p>Hello <em>World</em></p>"
  */
 export declare function inlineMarkdown(value: string, options?: MarkDownOptions, extensions?: MarkDownExtensions): string;
+/**
+ * Creates and configures a MarkdownIt renderer with the specified options and extensions.
+ *
+ * @param options - Options to customize the markdown rendering. Defaults to GFM enabled and no anchors.
+ * @param extensions - An array of markdown-it extensions to apply during rendering.
+ * @returns A configured MarkdownIt instance.
+ *
+ * @requires {@link https://www.npmjs.com/package/markdown-it markdown-it package}
+ */
 export declare function markDownRenderer(options?: MarkDownOptions, extensions?: MarkDownExtensions): MarkdownIt;
 //# sourceMappingURL=index.d.ts.map

package/dist/markdown/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,EAAE,EACf,KAAK,OAAO,IAAI,iBAAiB,EACjC,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACzB,MAAM,aAAa,CAAC;AAIrB,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACtD,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,iBAAiB,GACvB,YAAY,GACZ,iBAAiB,CAAC,OAAO,CAAC,GAC1B,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AAE5C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,EAAE,CAAC;AAErD;;;;;;GAMG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAA+C,EACxD,UAAU,GAAE,kBAAuB,GACpC,MAAM,CAER;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAA+B,EACxC,UAAU,GAAE,kBAAuB,GACpC,MAAM,CAER;AAED,wBAAgB,gBAAgB,CAC5B,OAAO,GAAE,eAA+C,EACxD,UAAU,GAAE,kBAAuB,cAgCtC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,EAAE,EACf,KAAK,OAAO,IAAI,iBAAiB,EACjC,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACzB,MAAM,aAAa,CAAC;AAIrB,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACtD,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,iBAAiB,GACvB,YAAY,GACZ,iBAAiB,CAAC,OAAO,CAAC,GAC1B,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AAE5C,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,EAAE,CAAC;AAErD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAA+C,EACxD,UAAU,GAAE,kBAAuB,GACpC,MAAM,CAER;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAA+B,EACxC,UAAU,GAAE,kBAAuB,GACpC,MAAM,CAER;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,GAAE,eAA+C,EACxD,UAAU,GAAE,kBAAuB,cAgCtC"}