public/utils
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(typedoc): update docs

Browse Source
This commit is contained in:
Olivers Vītiņš
2024-03-12 21:38:38 +02:00
parent ea3cb13c85
commit cafaad76aa
4 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -1,3 +1,7 @@
# @resultium/utils
Utility package collecting various reusable functions used within Resultium projects
## Documentation
Available [here](https://git.resultium.net/public/utils/src/branch/main/docs/modules.md)

4
docs/README.md
View File

@@ -3,3 +3,7 @@
# @resultium/utils
Utility package collecting various reusable functions used within Resultium projects
## Documentation
Available [here](https://git.resultium.net/public/utils/src/branch/main/docs/modules.md)

20
docs/modules.md
View File

@@ -45,7 +45,7 @@ console.log(capitalizeFirstChar("lorem ipsum"))
#### Defined in
[functions/capitalizeFirstChar.ts:32](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/capitalizeFirstChar.ts#L32)
[functions/capitalizeFirstChar.ts:32](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/capitalizeFirstChar.ts#L32)
___
@@ -78,7 +78,7 @@ console.log(classNames("bg-blue-300", isVisible ? "block" : "hidden"))
#### Defined in
[functions/classNames.ts:34](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/classNames.ts#L34)
[functions/classNames.ts:34](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/classNames.ts#L34)
___
@@ -107,12 +107,12 @@ new string
let isAdmin = true
// prints "Hello, Administrator!"
console.log(conditionalJoin(["Hello,", isAdmin ? "Administrator" : "User", "!"], " "))
console.log(conditionalJoin(["Hello,", isAdmin ? "Administrator!" : "User!"], " "))
```
#### Defined in
[functions/conditionalJoin.ts:35](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/conditionalJoin.ts#L35)
[functions/conditionalJoin.ts:35](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/conditionalJoin.ts#L35)
___
@@ -160,7 +160,7 @@ console.log(
#### Defined in
[functions/isDeepWeakEqual.ts:47](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/isDeepWeakEqual.ts#L47)
[functions/isDeepWeakEqual.ts:47](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/isDeepWeakEqual.ts#L47)
___
@@ -197,7 +197,7 @@ console.log(randomInRange(1, 100))
#### Defined in
[functions/randomInRange.ts:37](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/randomInRange.ts#L37)
[functions/randomInRange.ts:37](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/randomInRange.ts#L37)
___
@@ -243,7 +243,7 @@ console.log(removeFromArrayByKeyValue([{ a: "1", b: "0" }, { a: "2", b: "0" }, {
#### Defined in
[functions/removeFromArrayByKeyValue.ts:40](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/removeFromArrayByKeyValue.ts#L40)
[functions/removeFromArrayByKeyValue.ts:40](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/removeFromArrayByKeyValue.ts#L40)
___
@@ -282,7 +282,7 @@ console.log(removeObjectProperty({ a: "1", b: "2", c: "3" }, "c"))
#### Defined in
[functions/removeObjectProperty.ts:33](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/removeObjectProperty.ts#L33)
[functions/removeObjectProperty.ts:33](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/removeObjectProperty.ts#L33)
___
@@ -330,7 +330,7 @@ console.log(replaceFromArrayByKeyValue([{ a: "1", b: "0" }, { a: "2", b: "0" },
#### Defined in
[functions/replaceFromArrayByKeyValue.ts:42](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/replaceFromArrayByKeyValue.ts#L42)
[functions/replaceFromArrayByKeyValue.ts:42](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/replaceFromArrayByKeyValue.ts#L42)
___
@@ -368,4 +368,4 @@ console.log(splitIntoChunks(["a", "b", "c", "d", "e", "f"], 3));
#### Defined in
[functions/splitIntoChuks.ts:33](https://git.resultium.net/public/utils/src/commit/fdb28fa/src/functions/splitIntoChuks.ts#L33)
[functions/splitIntoChunks.ts:33](https://git.resultium.net/public/utils/src/commit/ea3cb13/src/functions/splitIntoChunks.ts#L33)

7
tsconfig.json
View File

@@ -22,7 +22,7 @@
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "module": "commonjs", /* Specify what module code is generated. */
"rootDir": "./src/", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
@@ -97,5 +97,8 @@
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
},
"exclude": [
"tests"
]
}