@tevari/helpers

Version:

Collection of various small helpers for javascript and typescript based projects

26 lines • 113 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Strings | tevari</title><meta name="description" content="Documentation for tevari"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">tevari</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">tevari</a></li><li><a href="Strings.html">Strings</a></li></ul><h1>Variable Strings<code class="tsd-tag ts-flagConst">Const</code> </h1></div><div class="tsd-signature">Strings: { comparator: { naturalAsc: ((a, b) => number); naturalDesc: ((a, b) => number); naturalValueAsc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.T">T</a>>(extractor) => ((a, b) => number)); naturalValueDesc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.T-1">T</a>>(extractor) => ((a, b) => number)); }; helper: { camelCaseToSnakeCase: ((text) => string); camelize: ((value) => string); capitalize: ((string) => string); capitalizeEachWord: ((string) => string); equals: ((value1, value2?) => boolean); extractEmailDomain: ((email) => undefined | string); humanize: ((value) => string); isAlpha: ((value) => boolean); isBlank: ((value?) => boolean); isEmpty: ((value) => boolean); isNumeric: ((value) => boolean); isString: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.helper.__type-14.isString.__type-37.__type-38.T-2">T</a>>(data) => data is string); kebabCaseToCamelCase: ((text) => string); pad: ((value, nbOfCharacters, paddingCharacter?) => string); plainify: ((value) => string); snakeCaseToCamelCase: ((text) => string); valueOrEmpty: ((value?) => string); }; parser: { parseBoolean: ((input?) => undefined | boolean); }; regex: { alpha: RegExp; numeric: RegExp; }; symbol: { COLON: string; COMMA: string; DOT: string; EMPTY: string; FORWARD_SLASH: string; HASHTAG: string; MINUS: string; PERCENTAGE: string; PLUS: string; QUESTION_MARK: string; SPACE: string; UNDERSCORE: string; UNIT_MASS: string; UNIT_NORMAL_METRIC: string; UNIT_WEIGHT: string; WILDCARD: string; }; } = ...</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>comparator: { naturalAsc: ((a, b) => number); naturalDesc: ((a, b) => number); naturalValueAsc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.T">T</a>>(extractor) => ((a, b) => number)); naturalValueDesc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.T-1">T</a>>(extractor) => ((a, b) => number)); }</h5><div class="tsd-comment tsd-typography">String comparators. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>naturalAsc: ((a, b) => number)</h5><div class="tsd-comment tsd-typography">An ascendent natural string comparator. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalAsc.__type-2.__type-3">(a, b): number</li><li class="tsd-description"><div class="tsd-comment tsd-typography">An ascendent natural string comparator. </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>a: string</h5></li><li><h5>b: string</h5></li></ul></div><h4 class="tsd-returns-title">Returns number</h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5>naturalDesc: ((a, b) => number)</h5><div class="tsd-comment tsd-typography">An descendent natural string comparator. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalDesc.__type-4.__type-5">(a, b): number</li><li class="tsd-description"><div class="tsd-comment tsd-typography">An descendent natural string comparator. </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>a: string</h5></li><li><h5>b: string</h5></li></ul></div><h4 class="tsd-returns-title">Returns number</h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5>naturalValueAsc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.T">T</a>>(extractor) => ((a, b) => number))</h5><div class="tsd-comment tsd-typography">An ascendent natural string comparator from extracted values. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7"><<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.T">T</a>>(extractor): ((a, b) => number)</li><li class="tsd-description"><div class="tsd-comment tsd-typography">An ascendent natural string comparator from extracted values. </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.T" class="tsd-anchor"></a>T</h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>extractor: <a href="../types/Function1.html" class="tsd-signature-type tsd-kind-type-alias">Function1</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_ASC.html#STRING_NATURAL_VALUE_COMPARATOR_ASC.T">T</a>, string></h5></li></ul></div><h4 class="tsd-returns-title">Returns ((a, b) => number)</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalValueAsc.__type-6.__type-7.__type-8.__type-9">(a, b): number</li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>a: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_ASC.html#STRING_NATURAL_VALUE_COMPARATOR_ASC.T">T</a></h5></li><li><h5>b: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_ASC.html#STRING_NATURAL_VALUE_COMPARATOR_ASC.T">T</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns number</h4></li></ul></li></ul><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5>naturalValueDesc: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.T-1">T</a>>(extractor) => ((a, b) => number))</h5><div class="tsd-comment tsd-typography">An descendent natural string comparator from extracted values. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11"><<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.T-1">T</a>>(extractor): ((a, b) => number)</li><li class="tsd-description"><div class="tsd-comment tsd-typography">An descendent natural string comparator from extracted values. </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.T-1" class="tsd-anchor"></a>T</h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>extractor: <a href="../types/Function1.html" class="tsd-signature-type tsd-kind-type-alias">Function1</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_DESC.html#STRING_NATURAL_VALUE_COMPARATOR_DESC.T">T</a>, string></h5></li></ul></div><h4 class="tsd-returns-title">Returns ((a, b) => number)</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.comparator.__type-1.naturalValueDesc.__type-10.__type-11.__type-12.__type-13">(a, b): number</li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>a: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_DESC.html#STRING_NATURAL_VALUE_COMPARATOR_DESC.T">T</a></h5></li><li><h5>b: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/STRING_NATURAL_VALUE_COMPARATOR_DESC.html#STRING_NATURAL_VALUE_COMPARATOR_DESC.T">T</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns number</h4></li></ul></li></ul><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li></ul></li><li class="tsd-parameter"><h5>helper: { camelCaseToSnakeCase: ((text) => string); camelize: ((value) => string); capitalize: ((string) => string); capitalizeEachWord: ((string) => string); equals: ((value1, value2?) => boolean); extractEmailDomain: ((email) => undefined | string); humanize: ((value) => string); isAlpha: ((value) => boolean); isBlank: ((value?) => boolean); isEmpty: ((value) => boolean); isNumeric: ((value) => boolean); isString: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="Strings.html#__type.helper.__type-14.isString.__type-37.__type-38.T-2">T</a>>(data) => data is string); kebabCaseToCamelCase: ((text) => string); pad: ((value, nbOfCharacters, paddingCharacter?) => string); plainify: ((value) => string); snakeCaseToCamelCase: ((text) => string); valueOrEmpty: ((value?) => string); }</h5><div class="tsd-comment tsd-typography">String helper methods. </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>camelCaseToSnakeCase: ((text) => string)</h5><div class="tsd-comment tsd-typography">Converts the given camel case formatted string into a snake case format. </div><div class="tsd-comment tsd-typography"><h4>Param: text</h4>The string to convert. <h4>Returns</h4>the converted string result. </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.helper.__type-14.camelCaseToSnakeCase.__type-15.__type-16">(text): string</li><li class="tsd-description"><div class="tsd-comment tsd-typography">Converts the given camel case formatted string into a snake case format. </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>text: string</h5><div class="tsd-comment tsd-typography">The string to convert. </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns string</h4>the converted string result. <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5>camelize: ((value) => string)</h5><div class="tsd-comment tsd-typography">Camelize the given string. </div><div class="tsd-comment tsd-typography"><h4>Param: value</h4>the string to camelize. <h4>Returns</h4>the formatted result. </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.helper.__type-14.camelize.__type-17.__type-18">(value): string</li><li class="tsd-description"><div class="tsd-comment tsd-typography">Camelize the given string. </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5>value: string</h5><div class="tsd-comment tsd-typography">the string to camelize. </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns string</h4>the formatted result. <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></li><li class="tsd-parameter"><h5>capitalize: ((string) => string)</h5><div class="tsd-comment tsd-typography">Capitalizes the first letter of the given string. </div><div class="tsd-comment tsd-typography"><h4>Param: string</h4>the string to compute. <h4>Returns</h4>the result string. </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type.helper.__type-14.capitalize.__type-19.__type-20">(string): string</spa