@decaf-ts/utils 0.3.7 → 0.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,70 +0,0 @@
1
- import { EnvironmentFactory } from "./types";
2
- import { ObjectAccumulator } from "typed-object-accumulator";
3
- /**
4
- * @class Environment
5
- * @extends {ObjectAccumulator<T>}
6
- * @template T
7
- * @description A class representing an environment with accumulation capabilities.
8
- * @summary Manages environment-related data and provides methods for accumulation and key retrieval.
9
- * @param {T} [initialData] - The initial data to populate the environment with.
10
- */
11
- export declare class Environment<T extends object> extends ObjectAccumulator<T> {
12
- /**
13
- * @static
14
- * @protected
15
- * @description A factory function for creating Environment instances.
16
- * @summary Defines how new instances of the Environment class should be created.
17
- * @return {Environment<any>} A new instance of the Environment class.
18
- */
19
- protected static factory: EnvironmentFactory<any, any>;
20
- /**
21
- * @static
22
- * @private
23
- * @description The singleton instance of the Environment class.
24
- * @type {Environment<any>}
25
- */
26
- private static _instance;
27
- protected constructor();
28
- /**
29
- * @description Retrieves a value from the environment
30
- * @summary Gets a value from the environment variables, handling browser and Node.js environments differently
31
- * @param {string} k - The key to retrieve from the environment
32
- * @return {unknown} The value from the environment, or undefined if not found
33
- */
34
- protected fromEnv(k: string): unknown;
35
- /**
36
- * @description Expands an object into the environment
37
- * @summary Defines properties on the environment object that can be accessed as getters and setters
38
- * @template V - Type of the object being expanded
39
- * @param {V} value - The object to expand into the environment
40
- * @return {void}
41
- */
42
- protected expand<V extends object>(value: V): void;
43
- /**
44
- * @protected
45
- * @static
46
- * @description Retrieves or creates the singleton instance of the Environment class.
47
- * @summary Ensures only one instance of the Environment class exists.
48
- * @template E
49
- * @param {...unknown[]} args - Arguments to pass to the factory function if a new instance is created.
50
- * @return {E} The singleton instance of the Environment class.
51
- */
52
- protected static instance<E extends Environment<any>>(...args: unknown[]): E;
53
- /**
54
- * @static
55
- * @description Accumulates the given value into the environment.
56
- * @summary Adds new properties to the environment from the provided object.
57
- * @template V
58
- * @param {V} value - The object to accumulate into the environment.
59
- * @return {V} The updated environment instance.
60
- */
61
- static accumulate<V extends object>(value: V): typeof Environment._instance & V & ObjectAccumulator<typeof Environment._instance & V>;
62
- /**
63
- * @static
64
- * @description Retrieves the keys of the environment, optionally converting them to ENV format.
65
- * @summary Gets all keys in the environment, with an option to format them for environment variables.
66
- * @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.
67
- * @return {string[]} An array of keys from the environment.
68
- */
69
- static keys(toEnv?: boolean): string[];
70
- }
@@ -1,178 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.padEnd = padEnd;
4
- exports.patchPlaceholders = patchPlaceholders;
5
- exports.patchString = patchString;
6
- exports.toCamelCase = toCamelCase;
7
- exports.toENVFormat = toENVFormat;
8
- exports.toSnakeCase = toSnakeCase;
9
- exports.toKebabCase = toKebabCase;
10
- exports.toPascalCase = toPascalCase;
11
- exports.escapeRegExp = escapeRegExp;
12
- /**
13
- * @description Pads the end of a string with a specified character.
14
- * @summary Extends the input string to a specified length by adding a padding character to the end.
15
- * If the input string is already longer than the specified length, it is returned unchanged.
16
- *
17
- * @param {string} str - The input string to be padded.
18
- * @param {number} length - The desired total length of the resulting string.
19
- * @param {string} [char=" "] - The character to use for padding. Defaults to a space.
20
- * @return {string} The padded string.
21
- * @throws {Error} If the padding character is not exactly one character long.
22
- *
23
- * @function padEnd
24
- *
25
- * @memberOf module:utils
26
- */
27
- function padEnd(str, length, char = " ") {
28
- if (char.length !== 1)
29
- throw new Error("Invalid character length for padding. must be one!");
30
- return str.padEnd(length, char);
31
- }
32
- /**
33
- * @description Replaces placeholders in a string with provided values.
34
- * @summary Interpolates a string by replacing placeholders of the form ${variableName}
35
- * with corresponding values from the provided object. If a placeholder doesn't have
36
- * a corresponding value, it is left unchanged in the string.
37
- *
38
- * @param {string} input - The input string containing placeholders to be replaced.
39
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
40
- * @return {string} The interpolated string with placeholders replaced by their corresponding values.
41
- *
42
- * @function patchPlaceholders
43
- *
44
- * @mermaid
45
- * sequenceDiagram
46
- * participant Caller
47
- * participant patchString
48
- * participant String.replace
49
- * Caller->>patchString: Call with input and values
50
- * patchString->>String.replace: Call with regex and replacement function
51
- * String.replace->>patchString: Return replaced string
52
- * patchString-->>Caller: Return patched string
53
- *
54
- * @memberOf module:utils
55
- */
56
- function patchPlaceholders(input, values) {
57
- return input.replace(/\$\{([a-zA-Z0-9_]+)\}/g, (match, variable) => values[variable] || match);
58
- }
59
- /**
60
- * @description Replaces occurrences of keys with their corresponding values in a string.
61
- * @summary Iterates through a set of key-value pairs and replaces all occurrences of each key
62
- * in the input string with its corresponding value. Supports regular expression flags for customized replacement.
63
- *
64
- * @param {string} input - The input string in which replacements will be made.
65
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
66
- * @param {string} [flags="g"] - Regular expression flags to control the replacement behavior.
67
- * @return {string} The string with all specified replacements applied.
68
- *
69
- * @function patchString
70
- *
71
- * @memberOf module:utils
72
- */
73
- function patchString(input, values, flags = "g") {
74
- Object.entries(values).forEach(([key, val]) => {
75
- const regexp = new RegExp(escapeRegExp(key), flags);
76
- input = input.replace(regexp, val);
77
- });
78
- return input;
79
- }
80
- /**
81
- * @description Converts a string to camelCase.
82
- * @summary Transforms the input string into camelCase format, where words are joined without spaces
83
- * and each word after the first starts with a capital letter.
84
- *
85
- * @param {string} text - The input string to be converted.
86
- * @return {string} The input string converted to camelCase.
87
- *
88
- * @function toCamelCase
89
- *
90
- * @memberOf module:utils
91
- */
92
- function toCamelCase(text) {
93
- return text
94
- .replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => index === 0 ? word.toLowerCase() : word.toUpperCase())
95
- .replace(/\s+/g, "");
96
- }
97
- /**
98
- * @description Converts a string to ENVIRONMENT_VARIABLE format.
99
- * @summary Transforms the input string into uppercase with words separated by underscores,
100
- * typically used for environment variable names.
101
- *
102
- * @param {string} text - The input string to be converted.
103
- * @return {string} The input string converted to ENVIRONMENT_VARIABLE format.
104
- *
105
- * @function toENVFormat
106
- *
107
- * @memberOf module:utils
108
- */
109
- function toENVFormat(text) {
110
- return toSnakeCase(text).toUpperCase();
111
- }
112
- /**
113
- * @description Converts a string to snake_case.
114
- * @summary Transforms the input string into lowercase with words separated by underscores.
115
- *
116
- * @param {string} text - The input string to be converted.
117
- * @return {string} The input string converted to snake_case.
118
- *
119
- * @function toSnakeCase
120
- *
121
- * @memberOf module:utils
122
- */
123
- function toSnakeCase(text) {
124
- return text
125
- .replace(/([a-z])([A-Z])/g, "$1_$2")
126
- .replace(/[\s-]+/g, "_")
127
- .toLowerCase();
128
- }
129
- /**
130
- * @description Converts a string to kebab-case.
131
- * @summary Transforms the input string into lowercase with words separated by hyphens.
132
- *
133
- * @param {string} text - The input string to be converted.
134
- * @return {string} The input string converted to kebab-case.
135
- *
136
- * @function toKebabCase
137
- *
138
- * @memberOf module:utils
139
- */
140
- function toKebabCase(text) {
141
- return text
142
- .replace(/([a-z])([A-Z])/g, "$1-$2")
143
- .replace(/[\s_]+/g, "-")
144
- .toLowerCase();
145
- }
146
- /**
147
- * @description Converts a string to PascalCase.
148
- * @summary Transforms the input string into PascalCase format, where words are joined without spaces
149
- * and each word starts with a capital letter.
150
- *
151
- * @param {string} text - The input string to be converted.
152
- * @return {string} The input string converted to PascalCase.
153
- *
154
- * @function toPascalCase
155
- *
156
- * @memberOf module:utils
157
- */
158
- function toPascalCase(text) {
159
- return text
160
- .replace(/(?:^\w|[A-Z]|\b\w)/g, (word) => word.toUpperCase())
161
- .replace(/\s+/g, "");
162
- }
163
- /**
164
- * @description Escapes special characters in a string for use in a regular expression.
165
- * @summary Adds backslashes before characters that have special meaning in regular expressions,
166
- * allowing the string to be used as a literal match in a RegExp.
167
- *
168
- * @param {string} string - The string to escape for regular expression use.
169
- * @return {string} The escaped string safe for use in regular expressions.
170
- *
171
- * @function escapeRegExp
172
- *
173
- * @memberOf module:utils
174
- */
175
- function escapeRegExp(string) {
176
- return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
177
- }
178
- //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/utils/text.ts"],"names":[],"mappings":";;AAeA,wBAQC;AA0BD,8CAQC;AAgBD,kCAUC;AAcD,kCAMC;AAcD,kCAEC;AAaD,kCAKC;AAaD,kCAKC;AAcD,oCAIC;AAcD,oCAEC;AA7LD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,MAAc,EACd,OAAe,GAAG;IAElB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,iBAAiB,CAC/B,KAAa,EACb,MAAuC;IAEvC,OAAO,KAAK,CAAC,OAAO,CAClB,wBAAwB,EACxB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAE,MAAM,CAAC,QAAkB,CAAY,IAAI,KAAK,CACrE,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,WAAW,CACzB,KAAa,EACb,MAAuC,EACvC,QAAgB,GAAG;IAEnB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;QAC5C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QACpD,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,GAAa,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI;SACR,OAAO,CAAC,qBAAqB,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAC9C,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CACtD;SACA,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AACzC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI;SACR,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI;SACR,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;SACnC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAAC,IAAY;IACvC,OAAO,IAAI;SACR,OAAO,CAAC,qBAAqB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;SAC5D,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAAC,MAAc;IACzC,OAAO,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,oCAAoC;AAC5F,CAAC","sourcesContent":["/**\n * @description Pads the end of a string with a specified character.\n * @summary Extends the input string to a specified length by adding a padding character to the end.\n * If the input string is already longer than the specified length, it is returned unchanged.\n *\n * @param {string} str - The input string to be padded.\n * @param {number} length - The desired total length of the resulting string.\n * @param {string} [char=\" \"] - The character to use for padding. Defaults to a space.\n * @return {string} The padded string.\n * @throws {Error} If the padding character is not exactly one character long.\n *\n * @function padEnd\n *\n * @memberOf module:utils\n */\nexport function padEnd(\n  str: string,\n  length: number,\n  char: string = \" \"\n): string {\n  if (char.length !== 1)\n    throw new Error(\"Invalid character length for padding. must be one!\");\n  return str.padEnd(length, char);\n}\n\n/**\n * @description Replaces placeholders in a string with provided values.\n * @summary Interpolates a string by replacing placeholders of the form ${variableName}\n * with corresponding values from the provided object. If a placeholder doesn't have\n * a corresponding value, it is left unchanged in the string.\n *\n * @param {string} input - The input string containing placeholders to be replaced.\n * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.\n * @return {string} The interpolated string with placeholders replaced by their corresponding values.\n *\n * @function patchPlaceholders\n *\n * @mermaid\n * sequenceDiagram\n *   participant Caller\n *   participant patchString\n *   participant String.replace\n *   Caller->>patchString: Call with input and values\n *   patchString->>String.replace: Call with regex and replacement function\n *   String.replace->>patchString: Return replaced string\n *   patchString-->>Caller: Return patched string\n *\n * @memberOf module:utils\n */\nexport function patchPlaceholders(\n  input: string,\n  values: Record<string, number | string>\n): string {\n  return input.replace(\n    /\\$\\{([a-zA-Z0-9_]+)\\}/g,\n    (match, variable) => (values[variable as string] as string) || match\n  );\n}\n\n/**\n * @description Replaces occurrences of keys with their corresponding values in a string.\n * @summary Iterates through a set of key-value pairs and replaces all occurrences of each key\n * in the input string with its corresponding value. Supports regular expression flags for customized replacement.\n *\n * @param {string} input - The input string in which replacements will be made.\n * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.\n * @param {string} [flags=\"g\"] - Regular expression flags to control the replacement behavior.\n * @return {string} The string with all specified replacements applied.\n *\n * @function patchString\n *\n * @memberOf module:utils\n */\nexport function patchString(\n  input: string,\n  values: Record<string, number | string>,\n  flags: string = \"g\"\n): string {\n  Object.entries(values).forEach(([key, val]) => {\n    const regexp = new RegExp(escapeRegExp(key), flags);\n    input = input.replace(regexp, val as string);\n  });\n  return input;\n}\n\n/**\n * @description Converts a string to camelCase.\n * @summary Transforms the input string into camelCase format, where words are joined without spaces\n * and each word after the first starts with a capital letter.\n *\n * @param {string} text - The input string to be converted.\n * @return {string} The input string converted to camelCase.\n *\n * @function toCamelCase\n *\n * @memberOf module:utils\n */\nexport function toCamelCase(text: string): string {\n  return text\n    .replace(/(?:^\\w|[A-Z]|\\b\\w)/g, (word, index) =>\n      index === 0 ? word.toLowerCase() : word.toUpperCase()\n    )\n    .replace(/\\s+/g, \"\");\n}\n\n/**\n * @description Converts a string to ENVIRONMENT_VARIABLE format.\n * @summary Transforms the input string into uppercase with words separated by underscores,\n * typically used for environment variable names.\n *\n * @param {string} text - The input string to be converted.\n * @return {string} The input string converted to ENVIRONMENT_VARIABLE format.\n *\n * @function toENVFormat\n *\n * @memberOf module:utils\n */\nexport function toENVFormat(text: string): string {\n  return toSnakeCase(text).toUpperCase();\n}\n\n/**\n * @description Converts a string to snake_case.\n * @summary Transforms the input string into lowercase with words separated by underscores.\n *\n * @param {string} text - The input string to be converted.\n * @return {string} The input string converted to snake_case.\n *\n * @function toSnakeCase\n *\n * @memberOf module:utils\n */\nexport function toSnakeCase(text: string): string {\n  return text\n    .replace(/([a-z])([A-Z])/g, \"$1_$2\")\n    .replace(/[\\s-]+/g, \"_\")\n    .toLowerCase();\n}\n\n/**\n * @description Converts a string to kebab-case.\n * @summary Transforms the input string into lowercase with words separated by hyphens.\n *\n * @param {string} text - The input string to be converted.\n * @return {string} The input string converted to kebab-case.\n *\n * @function toKebabCase\n *\n * @memberOf module:utils\n */\nexport function toKebabCase(text: string): string {\n  return text\n    .replace(/([a-z])([A-Z])/g, \"$1-$2\")\n    .replace(/[\\s_]+/g, \"-\")\n    .toLowerCase();\n}\n\n/**\n * @description Converts a string to PascalCase.\n * @summary Transforms the input string into PascalCase format, where words are joined without spaces\n * and each word starts with a capital letter.\n *\n * @param {string} text - The input string to be converted.\n * @return {string} The input string converted to PascalCase.\n *\n * @function toPascalCase\n *\n * @memberOf module:utils\n */\nexport function toPascalCase(text: string): string {\n  return text\n    .replace(/(?:^\\w|[A-Z]|\\b\\w)/g, (word) => word.toUpperCase())\n    .replace(/\\s+/g, \"\");\n}\n\n/**\n * @description Escapes special characters in a string for use in a regular expression.\n * @summary Adds backslashes before characters that have special meaning in regular expressions,\n * allowing the string to be used as a literal match in a RegExp.\n *\n * @param {string} string - The string to escape for regular expression use.\n * @return {string} The escaped string safe for use in regular expressions.\n *\n * @function escapeRegExp\n *\n * @memberOf module:utils\n */\nexport function escapeRegExp(string: string) {\n  return string.replace(/[.*+?^${}()|[\\]\\\\]/g, \"\\\\$&\"); // $& means the whole matched string\n}\n"]}
@@ -1,132 +0,0 @@
1
- /**
2
- * @description Pads the end of a string with a specified character.
3
- * @summary Extends the input string to a specified length by adding a padding character to the end.
4
- * If the input string is already longer than the specified length, it is returned unchanged.
5
- *
6
- * @param {string} str - The input string to be padded.
7
- * @param {number} length - The desired total length of the resulting string.
8
- * @param {string} [char=" "] - The character to use for padding. Defaults to a space.
9
- * @return {string} The padded string.
10
- * @throws {Error} If the padding character is not exactly one character long.
11
- *
12
- * @function padEnd
13
- *
14
- * @memberOf module:utils
15
- */
16
- export declare function padEnd(str: string, length: number, char?: string): string;
17
- /**
18
- * @description Replaces placeholders in a string with provided values.
19
- * @summary Interpolates a string by replacing placeholders of the form ${variableName}
20
- * with corresponding values from the provided object. If a placeholder doesn't have
21
- * a corresponding value, it is left unchanged in the string.
22
- *
23
- * @param {string} input - The input string containing placeholders to be replaced.
24
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
25
- * @return {string} The interpolated string with placeholders replaced by their corresponding values.
26
- *
27
- * @function patchPlaceholders
28
- *
29
- * @mermaid
30
- * sequenceDiagram
31
- * participant Caller
32
- * participant patchString
33
- * participant String.replace
34
- * Caller->>patchString: Call with input and values
35
- * patchString->>String.replace: Call with regex and replacement function
36
- * String.replace->>patchString: Return replaced string
37
- * patchString-->>Caller: Return patched string
38
- *
39
- * @memberOf module:utils
40
- */
41
- export declare function patchPlaceholders(input: string, values: Record<string, number | string>): string;
42
- /**
43
- * @description Replaces occurrences of keys with their corresponding values in a string.
44
- * @summary Iterates through a set of key-value pairs and replaces all occurrences of each key
45
- * in the input string with its corresponding value. Supports regular expression flags for customized replacement.
46
- *
47
- * @param {string} input - The input string in which replacements will be made.
48
- * @param {Record<string, number | string>} values - An object containing key-value pairs for replacement.
49
- * @param {string} [flags="g"] - Regular expression flags to control the replacement behavior.
50
- * @return {string} The string with all specified replacements applied.
51
- *
52
- * @function patchString
53
- *
54
- * @memberOf module:utils
55
- */
56
- export declare function patchString(input: string, values: Record<string, number | string>, flags?: string): string;
57
- /**
58
- * @description Converts a string to camelCase.
59
- * @summary Transforms the input string into camelCase format, where words are joined without spaces
60
- * and each word after the first starts with a capital letter.
61
- *
62
- * @param {string} text - The input string to be converted.
63
- * @return {string} The input string converted to camelCase.
64
- *
65
- * @function toCamelCase
66
- *
67
- * @memberOf module:utils
68
- */
69
- export declare function toCamelCase(text: string): string;
70
- /**
71
- * @description Converts a string to ENVIRONMENT_VARIABLE format.
72
- * @summary Transforms the input string into uppercase with words separated by underscores,
73
- * typically used for environment variable names.
74
- *
75
- * @param {string} text - The input string to be converted.
76
- * @return {string} The input string converted to ENVIRONMENT_VARIABLE format.
77
- *
78
- * @function toENVFormat
79
- *
80
- * @memberOf module:utils
81
- */
82
- export declare function toENVFormat(text: string): string;
83
- /**
84
- * @description Converts a string to snake_case.
85
- * @summary Transforms the input string into lowercase with words separated by underscores.
86
- *
87
- * @param {string} text - The input string to be converted.
88
- * @return {string} The input string converted to snake_case.
89
- *
90
- * @function toSnakeCase
91
- *
92
- * @memberOf module:utils
93
- */
94
- export declare function toSnakeCase(text: string): string;
95
- /**
96
- * @description Converts a string to kebab-case.
97
- * @summary Transforms the input string into lowercase with words separated by hyphens.
98
- *
99
- * @param {string} text - The input string to be converted.
100
- * @return {string} The input string converted to kebab-case.
101
- *
102
- * @function toKebabCase
103
- *
104
- * @memberOf module:utils
105
- */
106
- export declare function toKebabCase(text: string): string;
107
- /**
108
- * @description Converts a string to PascalCase.
109
- * @summary Transforms the input string into PascalCase format, where words are joined without spaces
110
- * and each word starts with a capital letter.
111
- *
112
- * @param {string} text - The input string to be converted.
113
- * @return {string} The input string converted to PascalCase.
114
- *
115
- * @function toPascalCase
116
- *
117
- * @memberOf module:utils
118
- */
119
- export declare function toPascalCase(text: string): string;
120
- /**
121
- * @description Escapes special characters in a string for use in a regular expression.
122
- * @summary Adds backslashes before characters that have special meaning in regular expressions,
123
- * allowing the string to be used as a literal match in a RegExp.
124
- *
125
- * @param {string} string - The string to escape for regular expression use.
126
- * @return {string} The escaped string safe for use in regular expressions.
127
- *
128
- * @function escapeRegExp
129
- *
130
- * @memberOf module:utils
131
- */
132
- export declare function escapeRegExp(string: string): string;
package/lib/utils/web.cjs DELETED
@@ -1,15 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isBrowser = isBrowser;
4
- /**
5
- * @description Determines if the current environment is a browser by checking the prototype chain of the global object.
6
- * @summary Checks if the code is running in a browser environment.
7
- * @return {boolean} True if the environment is a browser, false otherwise.
8
- * @function isBrowser
9
- * @memberOf module:utils
10
- */
11
- function isBrowser() {
12
- return (Object.getPrototypeOf(Object.getPrototypeOf(globalThis)) !==
13
- Object.prototype);
14
- }
15
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2ViLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL3dlYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQU9BLDhCQUtDO0FBWkQ7Ozs7OztHQU1HO0FBQ0gsU0FBZ0IsU0FBUztJQUN2QixPQUFPLENBQ0wsTUFBTSxDQUFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3hELE1BQU0sQ0FBQyxTQUFTLENBQ2pCLENBQUM7QUFDSixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gRGV0ZXJtaW5lcyBpZiB0aGUgY3VycmVudCBlbnZpcm9ubWVudCBpcyBhIGJyb3dzZXIgYnkgY2hlY2tpbmcgdGhlIHByb3RvdHlwZSBjaGFpbiBvZiB0aGUgZ2xvYmFsIG9iamVjdC5cbiAqIEBzdW1tYXJ5IENoZWNrcyBpZiB0aGUgY29kZSBpcyBydW5uaW5nIGluIGEgYnJvd3NlciBlbnZpcm9ubWVudC5cbiAqIEByZXR1cm4ge2Jvb2xlYW59IFRydWUgaWYgdGhlIGVudmlyb25tZW50IGlzIGEgYnJvd3NlciwgZmFsc2Ugb3RoZXJ3aXNlLlxuICogQGZ1bmN0aW9uIGlzQnJvd3NlclxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgZnVuY3Rpb24gaXNCcm93c2VyKCk6IGJvb2xlYW4ge1xuICByZXR1cm4gKFxuICAgIE9iamVjdC5nZXRQcm90b3R5cGVPZihPYmplY3QuZ2V0UHJvdG90eXBlT2YoZ2xvYmFsVGhpcykpICE9PVxuICAgIE9iamVjdC5wcm90b3R5cGVcbiAgKTtcbn1cbiJdfQ==
@@ -1,8 +0,0 @@
1
- /**
2
- * @description Determines if the current environment is a browser by checking the prototype chain of the global object.
3
- * @summary Checks if the code is running in a browser environment.
4
- * @return {boolean} True if the environment is a browser, false otherwise.
5
- * @function isBrowser
6
- * @memberOf module:utils
7
- */
8
- export declare function isBrowser(): boolean;