@blackbyte/sugar 1.0.0-beta.1

package/dist/shared/perf/loopsCount.js

@@ -0,0 +1,38 @@
+/**
+ * @name                loopsCount
+ * @namespace           shared.perf
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function calculate how mane loops are executed in a certain timeframe (ms).
+ * This is usefull to estimate the computer speed on which this code is running...
+ *
+ * @param       {Number}        [timeframe=100]         The timeframe to use for calculation
+ * @return      {Number}                                 The count of loops executed in the passed timeframe
+ *
+ * @todo      tests
+ *
+ * @snippet         loopsCount($1)
+ *
+ * @example       js
+ * import { loopsCount } from '@blackbyte/sugar/perf';
+ * loopsCount(); // 122003
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function loopsCount(timeframe = 100) {
+    let sysm = 0, start = new Date().getTime(), end = start;
+    while (end - start === 0) {
+        end = new Date().getTime();
+    }
+    start = end;
+    while (end - start < timeframe) {
+        sysm++;
+        end = new Date().getTime();
+    }
+    return sysm;
+}
+//# sourceMappingURL=loopsCount.js.map

package/dist/shared/perf/loopsCount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loopsCount.js","sourceRoot":"","sources":["../../../src/shared/perf/loopsCount.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,YAAoB,GAAG;IACxD,IAAI,IAAI,GAAG,CAAC,EACV,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC5B,GAAG,GAAG,KAAK,CAAC;IACd,OAAO,GAAG,GAAG,KAAK,KAAK,CAAC,EAAE,CAAC;QACzB,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IACD,KAAK,GAAG,GAAG,CAAC;IACZ,OAAO,GAAG,GAAG,KAAK,GAAG,SAAS,EAAE,CAAC;QAC/B,IAAI,EAAE,CAAC;QACP,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/shared/perf/speedIndex.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @name                speedIndex
+ * @namespace           shared.perf
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function gives you back an index usually between 0 and 100 that represent
+ * the speed estimation of the computer on which this code runs.
+ * This index is calculated by estimating the loops (for) count that the computer
+ * can make in 100ms and make use of the "slow" and "fast" parameters that represent
+ * an average of how many loops a "slow" computer can do in this timeframe, vs how many loops a "fast"
+ * computer can make in this timeframe.
+ * You can totally update these parameters as you prefer.
+ * Note that these parameters can/will be updated during time to reflect the most
+ * average cases possible.
+ *
+ * @param       {Number}        [slow=100000]           How many loops a "slow" computer can make in 100ms
+ * @param       {Number}        [fast=1400000]          How many loops a "fast" computer can make in 100ms
+ * @return      {Number}                                 The speed index calculated from the passed params and the loops the computer can make in 100ms
+ *
+ * @todo      tests
+ *
+ * @snippet         speedIndex($1, $2)
+ *
+ * @example       js
+ * import { speedIndex } from '@blackbyte/sugar/perf';
+ * speedIndex(); // 78
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function speedIndex(slow?: number, fast?: number): number;

package/dist/shared/perf/speedIndex.js

@@ -0,0 +1,40 @@
+import __loopsCount from './loopsCount.js';
+/**
+ * @name                speedIndex
+ * @namespace           shared.perf
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * This function gives you back an index usually between 0 and 100 that represent
+ * the speed estimation of the computer on which this code runs.
+ * This index is calculated by estimating the loops (for) count that the computer
+ * can make in 100ms and make use of the "slow" and "fast" parameters that represent
+ * an average of how many loops a "slow" computer can do in this timeframe, vs how many loops a "fast"
+ * computer can make in this timeframe.
+ * You can totally update these parameters as you prefer.
+ * Note that these parameters can/will be updated during time to reflect the most
+ * average cases possible.
+ *
+ * @param       {Number}        [slow=100000]           How many loops a "slow" computer can make in 100ms
+ * @param       {Number}        [fast=1400000]          How many loops a "fast" computer can make in 100ms
+ * @return      {Number}                                 The speed index calculated from the passed params and the loops the computer can make in 100ms
+ *
+ * @todo      tests
+ *
+ * @snippet         speedIndex($1, $2)
+ *
+ * @example       js
+ * import { speedIndex } from '@blackbyte/sugar/perf';
+ * speedIndex(); // 78
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function speedIndex(slow = 100000, fast = 1500000) {
+    const loopsCount = __loopsCount(100), // on 100ms
+    index = (100 / (fast - slow)) * loopsCount;
+    return Math.round(index);
+}
+//# sourceMappingURL=speedIndex.js.map

package/dist/shared/perf/speedIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"speedIndex.js","sourceRoot":"","sources":["../../../src/shared/perf/speedIndex.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,OAAe,MAAM,EACrB,OAAe,OAAO;IAEtB,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,WAAW;IAC/C,KAAK,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC;IAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC"}

package/dist/shared/string/_exports.d.ts

@@ -0,0 +1,45 @@
+import camelCase from './camelCase.js';
+import camelize from './camelize.js';
+import capitalCase from './capitalCase.js';
+import constantCase from './constantCase.js';
+import countLineChars from './countLineChars.js';
+import crop from './crop.js';
+import dashCase from './dashCase.js';
+import dotCase from './dotCase.js';
+import escapeRegexChars from './escapeRegexChars.js';
+import extractSame from './extractSame.js';
+import format from './format.js';
+import highlightText from './highlightText.js';
+import idCompliant from './idCompliant.js';
+import kebabCase from './kebabCase.js';
+import lowerFirst from './lowerFirst.js';
+import ltrim from './ltrim.js';
+import namespaceCompliant from './namespaceCompliant.js';
+import noCase from './noCase.js';
+import paramCase from './paramCase.js';
+import parse from './parse.js';
+import pascalCase from './pascalCase.js';
+import pascalSnakeCase from './pascalSnakeCase.js';
+import pathCase from './pathCase.js';
+import printf from './printf.js';
+import replaceChunks from './replaceChunks.js';
+import replaceTokens from './replaceTokens.js';
+import rtrim from './rtrim.js';
+import sentenceCase from './sentenceCase.js';
+import simplify from './simplify.js';
+import simplifySpecialChars from './simplifySpecialChars.js';
+import snakeCase from './snakeCase.js';
+import splitEvery from './splitEvery.js';
+import sprintf from './sprintf.js';
+import stripAnsi from './stripAnsi.js';
+import stripDocblocks from './stripDocblocks.js';
+import stripSourcemap from './stripSourcemap.js';
+import toString from './toString.js';
+import trainCase from './trainCase.js';
+import trimLines from './trimLines.js';
+import truncate from './truncate.js';
+import uncamelize from './uncamelize.js';
+import unquote from './unquote.js';
+import upperFirst from './upperFirst.js';
+import urlCompliant from './urlCompliant.js';
+export { camelCase as __camelCase, camelize as __camelize, capitalCase as __capitalCase, constantCase as __constantCase, countLineChars as __countLineChars, crop as __crop, dashCase as __dashCase, dotCase as __dotCase, escapeRegexChars as __escapeRegexChars, extractSame as __extractSame, format as __format, highlightText as __highlightText, idCompliant as __idCompliant, kebabCase as __kebabCase, lowerFirst as __lowerFirst, ltrim as __ltrim, namespaceCompliant as __namespaceCompliant, noCase as __noCase, paramCase as __paramCase, parse as __parse, pascalCase as __pascalCase, pascalSnakeCase as __pascalSnakeCase, pathCase as __pathCase, printf as __printf, replaceChunks as __replaceChunks, replaceTokens as __replaceTokens, rtrim as __rtrim, sentenceCase as __sentenceCase, simplify as __simplify, simplifySpecialChars as __simplifySpecialChars, snakeCase as __snakeCase, splitEvery as __splitEvery, sprintf as __sprintf, stripAnsi as __stripAnsi, stripDocblocks as __stripDocblocks, stripSourcemap as __stripSourcemap, toString as __toString, trainCase as __trainCase, trimLines as __trimLines, truncate as __truncate, uncamelize as __uncamelize, unquote as __unquote, upperFirst as __upperFirst, urlCompliant as __urlCompliant, camelCase, camelize, capitalCase, constantCase, countLineChars, crop, dashCase, dotCase, escapeRegexChars, extractSame, format, highlightText, idCompliant, kebabCase, lowerFirst, ltrim, namespaceCompliant, noCase, paramCase, parse, pascalCase, pascalSnakeCase, pathCase, printf, replaceChunks, replaceTokens, rtrim, sentenceCase, simplify, simplifySpecialChars, snakeCase, splitEvery, sprintf, stripAnsi, stripDocblocks, stripSourcemap, toString, trainCase, trimLines, truncate, uncamelize, unquote, upperFirst, urlCompliant, };

package/dist/shared/string/_exports.js

@@ -0,0 +1,46 @@
+import camelCase from './camelCase.js';
+import camelize from './camelize.js';
+import capitalCase from './capitalCase.js';
+import constantCase from './constantCase.js';
+import countLineChars from './countLineChars.js';
+import crop from './crop.js';
+import dashCase from './dashCase.js';
+import dotCase from './dotCase.js';
+import escapeRegexChars from './escapeRegexChars.js';
+import extractSame from './extractSame.js';
+import format from './format.js';
+import highlightText from './highlightText.js';
+import idCompliant from './idCompliant.js';
+import kebabCase from './kebabCase.js';
+import lowerFirst from './lowerFirst.js';
+import ltrim from './ltrim.js';
+import namespaceCompliant from './namespaceCompliant.js';
+import noCase from './noCase.js';
+import paramCase from './paramCase.js';
+import parse from './parse.js';
+import pascalCase from './pascalCase.js';
+import pascalSnakeCase from './pascalSnakeCase.js';
+import pathCase from './pathCase.js';
+import printf from './printf.js';
+import replaceChunks from './replaceChunks.js';
+import replaceTokens from './replaceTokens.js';
+import rtrim from './rtrim.js';
+import sentenceCase from './sentenceCase.js';
+import simplify from './simplify.js';
+import simplifySpecialChars from './simplifySpecialChars.js';
+import snakeCase from './snakeCase.js';
+import splitEvery from './splitEvery.js';
+import sprintf from './sprintf.js';
+import stripAnsi from './stripAnsi.js';
+import stripDocblocks from './stripDocblocks.js';
+import stripSourcemap from './stripSourcemap.js';
+import toString from './toString.js';
+import trainCase from './trainCase.js';
+import trimLines from './trimLines.js';
+import truncate from './truncate.js';
+import uncamelize from './uncamelize.js';
+import unquote from './unquote.js';
+import upperFirst from './upperFirst.js';
+import urlCompliant from './urlCompliant.js';
+export { camelCase as __camelCase, camelize as __camelize, capitalCase as __capitalCase, constantCase as __constantCase, countLineChars as __countLineChars, crop as __crop, dashCase as __dashCase, dotCase as __dotCase, escapeRegexChars as __escapeRegexChars, extractSame as __extractSame, format as __format, highlightText as __highlightText, idCompliant as __idCompliant, kebabCase as __kebabCase, lowerFirst as __lowerFirst, ltrim as __ltrim, namespaceCompliant as __namespaceCompliant, noCase as __noCase, paramCase as __paramCase, parse as __parse, pascalCase as __pascalCase, pascalSnakeCase as __pascalSnakeCase, pathCase as __pathCase, printf as __printf, replaceChunks as __replaceChunks, replaceTokens as __replaceTokens, rtrim as __rtrim, sentenceCase as __sentenceCase, simplify as __simplify, simplifySpecialChars as __simplifySpecialChars, snakeCase as __snakeCase, splitEvery as __splitEvery, sprintf as __sprintf, stripAnsi as __stripAnsi, stripDocblocks as __stripDocblocks, stripSourcemap as __stripSourcemap, toString as __toString, trainCase as __trainCase, trimLines as __trimLines, truncate as __truncate, uncamelize as __uncamelize, unquote as __unquote, upperFirst as __upperFirst, urlCompliant as __urlCompliant, camelCase, camelize, capitalCase, constantCase, countLineChars, crop, dashCase, dotCase, escapeRegexChars, extractSame, format, highlightText, idCompliant, kebabCase, lowerFirst, ltrim, namespaceCompliant, noCase, paramCase, parse, pascalCase, pascalSnakeCase, pathCase, printf, replaceChunks, replaceTokens, rtrim, sentenceCase, simplify, simplifySpecialChars, snakeCase, splitEvery, sprintf, stripAnsi, stripDocblocks, stripSourcemap, toString, trainCase, trimLines, truncate, uncamelize, unquote, upperFirst, urlCompliant, };
+//# sourceMappingURL=_exports.js.map

package/dist/shared/string/_exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/shared/string/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,gBAAgB,MAAM,uBAAuB,CAAC;AACrD,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,eAAe,MAAM,sBAAsB,CAAC;AACnD,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EACL,SAAS,IAAI,WAAW,EACxB,QAAQ,IAAI,UAAU,EACtB,WAAW,IAAI,aAAa,EAC5B,YAAY,IAAI,cAAc,EAC9B,cAAc,IAAI,gBAAgB,EAClC,IAAI,IAAI,MAAM,EACd,QAAQ,IAAI,UAAU,EACtB,OAAO,IAAI,SAAS,EACpB,gBAAgB,IAAI,kBAAkB,EACtC,WAAW,IAAI,aAAa,EAC5B,MAAM,IAAI,QAAQ,EAClB,aAAa,IAAI,eAAe,EAChC,WAAW,IAAI,aAAa,EAC5B,SAAS,IAAI,WAAW,EACxB,UAAU,IAAI,YAAY,EAC1B,KAAK,IAAI,OAAO,EAChB,kBAAkB,IAAI,oBAAoB,EAC1C,MAAM,IAAI,QAAQ,EAClB,SAAS,IAAI,WAAW,EACxB,KAAK,IAAI,OAAO,EAChB,UAAU,IAAI,YAAY,EAC1B,eAAe,IAAI,iBAAiB,EACpC,QAAQ,IAAI,UAAU,EACtB,MAAM,IAAI,QAAQ,EAClB,aAAa,IAAI,eAAe,EAChC,aAAa,IAAI,eAAe,EAChC,KAAK,IAAI,OAAO,EAChB,YAAY,IAAI,cAAc,EAC9B,QAAQ,IAAI,UAAU,EACtB,oBAAoB,IAAI,sBAAsB,EAC9C,SAAS,IAAI,WAAW,EACxB,UAAU,IAAI,YAAY,EAC1B,OAAO,IAAI,SAAS,EACpB,SAAS,IAAI,WAAW,EACxB,cAAc,IAAI,gBAAgB,EAClC,cAAc,IAAI,gBAAgB,EAClC,QAAQ,IAAI,UAAU,EACtB,SAAS,IAAI,WAAW,EACxB,SAAS,IAAI,WAAW,EACxB,QAAQ,IAAI,UAAU,EACtB,UAAU,IAAI,YAAY,EAC1B,OAAO,IAAI,SAAS,EACpB,UAAU,IAAI,YAAY,EAC1B,YAAY,IAAI,cAAc,EAC9B,SAAS,EACT,QAAQ,EACR,WAAW,EACX,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,gBAAgB,EAChB,WAAW,EACX,MAAM,EACN,aAAa,EACb,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,EACL,kBAAkB,EAClB,MAAM,EACN,SAAS,EACT,KAAK,EACL,UAAU,EACV,eAAe,EACf,QAAQ,EACR,MAAM,EACN,aAAa,EACb,aAAa,EACb,KAAK,EACL,YAAY,EACZ,QAAQ,EACR,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,OAAO,EACP,SAAS,EACT,cAAc,EACd,cAAc,EACd,QAAQ,EACR,SAAS,EACT,SAAS,EACT,QAAQ,EACR,UAAU,EACV,OAAO,EACP,UAAU,EACV,YAAY,GACb,CAAC"}

package/dist/shared/string/camelCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                camelCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to camelCase
+ * @return        {String}                      The camelCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         camelCase($1)
+ *
+ * @example     js
+ * import { camelCase } from '@blackbyte/sugar/string';
+ * camelCase('hello world'); // => helloWorld
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __camelCase(text: string): string;

package/dist/shared/string/camelCase.js

@@ -0,0 +1,30 @@
+import { camelCase } from 'change-case';
+/**
+ * @name                camelCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to camelCase
+ * @return        {String}                      The camelCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         camelCase($1)
+ *
+ * @example     js
+ * import { camelCase } from '@blackbyte/sugar/string';
+ * camelCase('hello world'); // => helloWorld
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __camelCase(text) {
+    return camelCase(text);
+}
+//# sourceMappingURL=camelCase.js.map

package/dist/shared/string/camelCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"camelCase.js","sourceRoot":"","sources":["../../../src/shared/string/camelCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,IAAY;IAC9C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/string/camelize.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                camelCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to camelCase
+ * @return        {String}                      The camelCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         camelize($1)
+ *
+ * @example     js
+ * import { camelize } from '@blackbyte/sugar/string';
+ * camelize('hello world'); // => helloWorld
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function camelize(text: string): string;

package/dist/shared/string/camelize.js

@@ -0,0 +1,30 @@
+import { camelCase } from 'change-case';
+/**
+ * @name                camelCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to camelCase
+ * @return        {String}                      The camelCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         camelize($1)
+ *
+ * @example     js
+ * import { camelize } from '@blackbyte/sugar/string';
+ * camelize('hello world'); // => helloWorld
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function camelize(text) {
+    return camelCase(text);
+}
+//# sourceMappingURL=camelize.js.map

package/dist/shared/string/camelize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"camelize.js","sourceRoot":"","sources":["../../../src/shared/string/camelize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,IAAY;IAC3C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}

package/dist/shared/string/capitalCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                capitalCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         capitalCase($1)
+ *
+ * @example     js
+ * import { capitalCase } from '@blackbyte/sugar/string';
+ * capitalCase('hello world'); // => HELLO WORLD
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __capitalCase(text: string): string;

package/dist/shared/string/capitalCase.js

@@ -0,0 +1,30 @@
+import { capitalCase } from 'change-case';
+/**
+ * @name                capitalCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Capital case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         capitalCase($1)
+ *
+ * @example     js
+ * import { capitalCase } from '@blackbyte/sugar/string';
+ * capitalCase('hello world'); // => HELLO WORLD
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __capitalCase(text) {
+    return capitalCase(text);
+}
+//# sourceMappingURL=capitalCase.js.map

package/dist/shared/string/capitalCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capitalCase.js","sourceRoot":"","sources":["../../../src/shared/string/capitalCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,IAAY;IAChD,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC"}

package/dist/shared/string/constantCase.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name                constantCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Constant case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         constantCase($1)
+ *
+ * @example     js
+ * import { constantCase } from '@blackbyte/sugar/string';
+ * constantCase('hello world'); // => HELLO_WORLD
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __constantCase(text: string): string;

package/dist/shared/string/constantCase.js

@@ -0,0 +1,30 @@
+import { constantCase } from 'change-case';
+/**
+ * @name                constantCase
+ * @namespace           shared.string
+ * @type                Function
+ * @platform            js
+ * @platform            node
+ * @status              stable
+ *
+ * Constant case a string
+ *
+ * @param         {String}          text        The string to snakeCase
+ * @return        {String}                      The snakeCased string
+ *
+ * @todo      tests
+ *
+ * @snippet         constantCase($1)
+ *
+ * @example     js
+ * import { constantCase } from '@blackbyte/sugar/string';
+ * constantCase('hello world'); // => HELLO_WORLD
+ *
+ * @see             https://www.npmjs.com/package/change-case
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function __constantCase(text) {
+    return constantCase(text);
+}
+//# sourceMappingURL=constantCase.js.map

package/dist/shared/string/constantCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constantCase.js","sourceRoot":"","sources":["../../../src/shared/string/constantCase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,IAAY;IACjD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC"}

package/dist/shared/string/countLineChars.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @name                            countLineChars
+ * @namespace                       shared.string
+ * @type                            Function
+ * @platform                        js
+ * @platform                        node
+ * @status                          stable
+ *
+ * Count how many characters their is in the passed line.
+ * This function will exclude the characters like the html tags like <red>, etc...
+ *
+ * @param           {String}              line              The line to count
+ * @param           {Object}              [count={}]        Specify what you want to count outside of the normal characters of yourse. Here's the list of available options:
+ * - htmlTags (false) {Boolean}: Specify if you want to count the html tags or not
+ * - terminalSpecialChars (false) {Boolean}: Specify if you want to count the terminal specials chars like "\u001b[30m", etc...
+ * - newLineChars (false) {Boolean}: Specify if you want to count the new line special char "\n" or not
+ * @return          {Number}                                How many characters their is in the line
+ *
+ * @setting         {Boolean}          [htmlTags=false]         Specify if you want to count the html tags or not
+ * @setting         {Boolean}          [terminalSpecialChars=false]         Specify if you want to count the terminal specials chars like "\u001b[30m", etc...
+ * @setting         {Boolean}          [newLineChars=false]         Specify if you want to count the new line special char "\n" or not
+ *
+ * @todo      tests
+ *
+ * @snippet         countLineChars($1)
+ *
+ * @example         js
+ * import { countLineChars } from '@blackbyte/sugar/string';
+ *  countLineChars('Hello <red>World</red>'); // 11
+ *
+ * @since     1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TCountLineCharsSettings = {
+    htmlTags?: boolean;
+    terminalSpecialChars?: boolean;
+    newLineChars?: boolean;
+};
+export default function countLineChars(line: string, count?: TCountLineCharsSettings): number;

package/dist/shared/string/countLineChars.js

@@ -0,0 +1,16 @@
+import stripAnsi from 'strip-ansi';
+export default function countLineChars(line, count = {}) {
+    count = Object.assign({ htmlTags: false, terminalSpecialChars: false, newLineChars: false }, count);
+    let newLine = line;
+    if (count.terminalSpecialChars === false) {
+        newLine = stripAnsi(newLine);
+    }
+    if (count.htmlTags === false) {
+        newLine = newLine.replace(/<\/?[a-zA-Z0-9]+\s?\/?>/g, '');
+    }
+    if (count.newLineChars === false) {
+        newLine = newLine.replace('\n', '');
+    }
+    return newLine.length;
+}
+//# sourceMappingURL=countLineChars.js.map

package/dist/shared/string/countLineChars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countLineChars.js","sourceRoot":"","sources":["../../../src/shared/string/countLineChars.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,YAAY,CAAC;AA0CnC,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,IAAY,EACZ,QAAiC,EAAE;IAEnC,KAAK,mBACH,QAAQ,EAAE,KAAK,EACf,oBAAoB,EAAE,KAAK,EAC3B,YAAY,EAAE,KAAK,IAChB,KAAK,CACT,CAAC;IAEF,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,KAAK,CAAC,oBAAoB,KAAK,KAAK,EAAE,CAAC;QACzC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC7B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,KAAK,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;QACjC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,CAAC;AACxB,CAAC"}

package/dist/shared/string/crop.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @name                    crop
+ * @namespace               shared.string
+ * @type                    Function
+ * @platform                js
+ * @platform                node
+ * @status                  stable
+ *
+ * Allows you to crop a string at a certain length (this length take care of the croping characters like "...")
+ *
+ * @param               {String}                  text                      The text to crop
+ * @param               {Number}                  length                    The text length to have after the croping process
+ * @param               {Object}                  [settings={}]             An object of settings described bellow:
+ * - chars (...) {String}: The characters to use to signal the crop
+ * - splitWords (false) {Boolean}: Specify if you want to split words or not. If not, the function will make sure the final text does not exceeds the wanted length
+ * @return              {String}                                            The cropped text
+ *
+ * @setting        {String}          [chars=...]         The characters to use to signal the crop
+ * @setting        {Boolean}         [splitWords=false]         Specify if you want to split words or not. If not, the function will make sure the final text does not exceeds the wanted length
+ *
+ * @todo      tests
+ *
+ * @snippet         crop($1, $2)
+ *
+ * @example         js
+ * import { crop } from '@blackbyte/sugar/string';
+ * crop('Hello World', 10); // => Hello w...
+ *
+ * @since       1.0.0
+ * @author 	Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TCropSettings = {
+    chars?: string;
+    splitWords?: boolean;
+};
+export default function crop(text: string, length: number, settings?: TCropSettings): string;