build(deps): add eslint

This commit is contained in:
2024-03-12 19:42:00 +02:00
parent 85f365c528
commit ed72704c2f
14 changed files with 1287 additions and 244 deletions

View File

@@ -6,7 +6,6 @@
### Functions
- [SplitIntoChunks](modules.md#splitintochunks)
- [capitalizeFirstChar](modules.md#capitalizefirstchar)
- [classNames](modules.md#classnames)
- [conditionalJoin](modules.md#conditionaljoin)
@@ -15,40 +14,10 @@
- [removeFromArrayByKeyValue](modules.md#removefromarraybykeyvalue)
- [removeObjectProperty](modules.md#removeobjectproperty)
- [replaceFromArrayByKeyValue](modules.md#replacefromarraybykeyvalue)
- [splitIntoChunks](modules.md#splitintochunks)
## Functions
### SplitIntoChunks
**SplitIntoChunks**\<`T`\>(`array`, `chunkSize`): `T`[][]
Splits an array into chunks
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `array` | `T`[] | array which shall be split into chunks |
| `chunkSize` | `number` | size of a single chunk |
#### Returns
`T`[][]
array of chunks
#### Defined in
functions/splitIntoChuks.ts:27
___
### capitalizeFirstChar
**capitalizeFirstChar**(`string`): `string`
@@ -209,35 +178,37 @@ modified array
**`Remarks`**
This method doesn't support deep comparements.
Vulnerable to generic object injection sink
#### Defined in
functions/removeFromArrayByKeyValue.ts:30
functions/removeFromArrayByKeyValue.ts:31
___
### removeObjectProperty
**removeObjectProperty**\<`T`\>(`object`, `key`): `T`
**removeObjectProperty**\<`T`, `K`\>(`object`, `key`): `Omit`\<`T`, `K`\>
Removes an object property by provided key
#### Type parameters
| Name |
| :------ |
| `T` |
| Name | Type |
| :------ | :------ |
| `T` | `T` |
| `K` | extends `string` \| `number` \| `symbol` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `object` | `T` | object which shall be manipulated |
| `key` | keyof `T` | key which should be used to remove a property from object |
| `key` | `K` | key which should be used to remove a property from object |
#### Returns
`T`
`Omit`\<`T`, `K`\>
new object
@@ -276,7 +247,39 @@ modified array
**`Remarks`**
This method doesn't support deep comparements.
Vulnerable to generic object injection sink
#### Defined in
functions/replaceFromArrayByKeyValue.ts:31
functions/replaceFromArrayByKeyValue.ts:32
___
### splitIntoChunks
**splitIntoChunks**\<`T`\>(`array`, `chunkSize`): `T`[][]
Splits an array into chunks
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `array` | `T`[] | array which shall be split into chunks |
| `chunkSize` | `number` | size of a single chunk |
#### Returns
`T`[][]
array of chunks
#### Defined in
functions/splitIntoChuks.ts:27