Skip to content

Commit 90e917d

Browse files
committed
update docs
1 parent 92c836b commit 90e917d

1 file changed

Lines changed: 25 additions & 5 deletions

File tree

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,11 @@ console.log(jsConvert.toUpperCase('param-case')); // PARAM-CASE
263263
#### lowerKeys
264264

265265
```ts
266-
const lowerKeys(obj: any, { recursive: boolean = false, recursiveInArray: boolean = false }): object | null
266+
const lowerKeys(obj: any, {
267+
recursive: boolean = false,
268+
recursiveInArray: boolean = false,
269+
keepTypesOnRecursion: any[] = [] // example: Date
270+
}): object | null
267271
```
268272
269273
Return a new object which keys is _lowercase_ format. Support lowerKeys **recursively**. Default is `false`.
@@ -300,7 +304,11 @@ console.log(jsConvert.lowerKeys([1, 2, 3]));
300304
#### upperKeys
301305

302306
```ts
303-
const upperKeys(obj: any, { recursive: boolean = false, recursiveInArray: boolean = false }): object | null
307+
const upperKeys(obj: any, {
308+
recursive: boolean = false,
309+
recursiveInArray: boolean = false,
310+
keepTypesOnRecursion: any[] = [] // example: Date
311+
}): object | null
304312
```
305313
306314
Return a new object which keys is _UPPERCASE_ format. Support upperKeys **recursively**. Default is `false`
@@ -337,7 +345,11 @@ console.log(jsConvert.upperKeys([1, 2, 3]));
337345
#### camelKeys
338346

339347
```ts
340-
const camelKeys(obj: any, { recursive: boolean = false, recursiveInArray: boolean = false }): object | null
348+
const camelKeys(obj: any, {
349+
recursive: boolean = false,
350+
recursiveInArray: boolean = false,
351+
keepTypesOnRecursion: any[] = [] // example: Date
352+
}): object | null
341353
```
342354
343355
Return a new object which keys is _camelCase_ format. Support camelKeys **recursively**. Default is `false`.
@@ -374,7 +386,11 @@ console.log(jsConvert.camelKeys([1, 2, 3]));
374386
#### snakeKeys
375387

376388
```ts
377-
const snakeKeys(obj: any, { recursive: boolean = false, recursiveInArray: boolean = false }): object | null
389+
const snakeKeys(obj: any, {
390+
recursive: boolean = false,
391+
recursiveInArray: boolean = false,
392+
keepTypesOnRecursion: any[] = [] // example: Date
393+
}): object | null
378394
```
379395
380396
Return a new object which keys is _snake_case_ format. Support snakeKeys **recursively**. Default is `false`.
@@ -411,7 +427,11 @@ console.log(jsConvert.snakeKeys([1, 2, 3]));
411427
#### pascalKeys
412428

413429
```ts
414-
const pascalKeys(obj: any, { recursive: boolean = false, recursiveInArray: boolean = false }): object | null
430+
const pascalKeys(obj: any, {
431+
recursive: boolean = false,
432+
recursiveInArray: boolean = false,
433+
keepTypesOnRecursion: any[] = [] // example: Date
434+
}): object | null
415435
```
416436
417437
Return a new object which keys is _PascalCase_ format. Support pascalKeys **recursively**. Default is `false`.

0 commit comments

Comments
 (0)