@hichchi/utils 0.0.1-beta.0 → 0.0.1-beta.1
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.
- package/CHANGELOG.md +4 -0
- package/README.md +111 -115
- package/constants/constants.js.map +1 -0
- package/constants/english-inflection-rules.js.map +1 -0
- package/constants/index.js.map +1 -0
- package/enums/index.js.map +1 -0
- package/enums/template-tag.enum.js.map +1 -0
- package/index.js.map +1 -0
- package/interfaces/index.js.map +1 -0
- package/interfaces/infinite-object.interface.js.map +1 -0
- package/interfaces/inflection-rule.interfaces.js.map +1 -0
- package/interfaces/path-value-set.interface.js.map +1 -0
- package/package.json +4 -4
- package/readme-top.md +1 -1
- package/types/deep-partial.type.js.map +1 -0
- package/types/index.js.map +1 -0
- package/types/is-already-in-path.type.js.map +1 -0
- package/types/is-empty.type.js.map +1 -0
- package/types/is-primitive.type.js.map +1 -0
- package/types/literal-object.type.js.map +1 -0
- package/types/loose-autocomplete.type.js.map +1 -0
- package/types/partial-with-null.type.js.map +1 -0
- package/types/prettify.type.js.map +1 -0
- package/types/type.type.js.map +1 -0
- package/utils/assertions.utils.js.map +1 -0
- package/utils/file.utils.js.map +1 -0
- package/utils/index.js.map +1 -0
- package/utils/object.utils.js.map +1 -0
- package/utils/string-template.utils.js.map +1 -0
- package/utils/string.utils.js.map +1 -0
- package/{src/lib/utils → utils}/url.utils.d.ts +0 -2
- package/{src/lib/utils → utils}/url.utils.js +0 -2
- package/utils/url.utils.js.map +1 -0
- package/src/index.d.ts +0 -1
- package/src/index.js +0 -5
- package/src/index.js.map +0 -1
- package/src/lib/constants/constants.js.map +0 -1
- package/src/lib/constants/english-inflection-rules.js.map +0 -1
- package/src/lib/constants/index.js.map +0 -1
- package/src/lib/enums/index.js.map +0 -1
- package/src/lib/enums/template-tag.enum.js.map +0 -1
- package/src/lib/index.js.map +0 -1
- package/src/lib/interfaces/index.js.map +0 -1
- package/src/lib/interfaces/infinite-object.interface.js.map +0 -1
- package/src/lib/interfaces/inflection-rule.interfaces.js.map +0 -1
- package/src/lib/interfaces/path-value-set.interface.js.map +0 -1
- package/src/lib/types/deep-partial.type.js.map +0 -1
- package/src/lib/types/index.js.map +0 -1
- package/src/lib/types/is-already-in-path.type.js.map +0 -1
- package/src/lib/types/is-empty.type.js.map +0 -1
- package/src/lib/types/is-primitive.type.js.map +0 -1
- package/src/lib/types/literal-object.type.js.map +0 -1
- package/src/lib/types/loose-autocomplete.type.js.map +0 -1
- package/src/lib/types/partial-with-null.type.js.map +0 -1
- package/src/lib/types/prettify.type.js.map +0 -1
- package/src/lib/types/type.type.js.map +0 -1
- package/src/lib/utils/assertions.utils.js.map +0 -1
- package/src/lib/utils/file.utils.js.map +0 -1
- package/src/lib/utils/index.js.map +0 -1
- package/src/lib/utils/object.utils.js.map +0 -1
- package/src/lib/utils/string-template.utils.js.map +0 -1
- package/src/lib/utils/string.utils.js.map +0 -1
- package/src/lib/utils/url.utils.js.map +0 -1
- /package/{src/lib/constants → constants}/constants.d.ts +0 -0
- /package/{src/lib/constants → constants}/constants.js +0 -0
- /package/{src/lib/constants → constants}/english-inflection-rules.d.ts +0 -0
- /package/{src/lib/constants → constants}/english-inflection-rules.js +0 -0
- /package/{src/lib/constants → constants}/index.d.ts +0 -0
- /package/{src/lib/constants → constants}/index.js +0 -0
- /package/{src/lib/enums → enums}/index.d.ts +0 -0
- /package/{src/lib/enums → enums}/index.js +0 -0
- /package/{src/lib/enums → enums}/template-tag.enum.d.ts +0 -0
- /package/{src/lib/enums → enums}/template-tag.enum.js +0 -0
- /package/{src/lib/index.d.ts → index.d.ts} +0 -0
- /package/{src/lib/index.js → index.js} +0 -0
- /package/{src/lib/interfaces → interfaces}/index.d.ts +0 -0
- /package/{src/lib/interfaces → interfaces}/index.js +0 -0
- /package/{src/lib/interfaces → interfaces}/infinite-object.interface.d.ts +0 -0
- /package/{src/lib/interfaces → interfaces}/infinite-object.interface.js +0 -0
- /package/{src/lib/interfaces → interfaces}/inflection-rule.interfaces.d.ts +0 -0
- /package/{src/lib/interfaces → interfaces}/inflection-rule.interfaces.js +0 -0
- /package/{src/lib/interfaces → interfaces}/path-value-set.interface.d.ts +0 -0
- /package/{src/lib/interfaces → interfaces}/path-value-set.interface.js +0 -0
- /package/{src/lib/types → types}/deep-partial.type.d.ts +0 -0
- /package/{src/lib/types → types}/deep-partial.type.js +0 -0
- /package/{src/lib/types → types}/index.d.ts +0 -0
- /package/{src/lib/types → types}/index.js +0 -0
- /package/{src/lib/types → types}/is-already-in-path.type.d.ts +0 -0
- /package/{src/lib/types → types}/is-already-in-path.type.js +0 -0
- /package/{src/lib/types → types}/is-empty.type.d.ts +0 -0
- /package/{src/lib/types → types}/is-empty.type.js +0 -0
- /package/{src/lib/types → types}/is-primitive.type.d.ts +0 -0
- /package/{src/lib/types → types}/is-primitive.type.js +0 -0
- /package/{src/lib/types → types}/literal-object.type.d.ts +0 -0
- /package/{src/lib/types → types}/literal-object.type.js +0 -0
- /package/{src/lib/types → types}/loose-autocomplete.type.d.ts +0 -0
- /package/{src/lib/types → types}/loose-autocomplete.type.js +0 -0
- /package/{src/lib/types → types}/partial-with-null.type.d.ts +0 -0
- /package/{src/lib/types → types}/partial-with-null.type.js +0 -0
- /package/{src/lib/types → types}/prettify.type.d.ts +0 -0
- /package/{src/lib/types → types}/prettify.type.js +0 -0
- /package/{src/lib/types → types}/type.type.d.ts +0 -0
- /package/{src/lib/types → types}/type.type.js +0 -0
- /package/{src/lib/utils → utils}/assertions.utils.d.ts +0 -0
- /package/{src/lib/utils → utils}/assertions.utils.js +0 -0
- /package/{src/lib/utils → utils}/file.utils.d.ts +0 -0
- /package/{src/lib/utils → utils}/file.utils.js +0 -0
- /package/{src/lib/utils → utils}/index.d.ts +0 -0
- /package/{src/lib/utils → utils}/index.js +0 -0
- /package/{src/lib/utils → utils}/object.utils.d.ts +0 -0
- /package/{src/lib/utils → utils}/object.utils.js +0 -0
- /package/{src/lib/utils → utils}/string-template.utils.d.ts +0 -0
- /package/{src/lib/utils → utils}/string-template.utils.js +0 -0
- /package/{src/lib/utils → utils}/string.utils.d.ts +0 -0
- /package/{src/lib/utils → utils}/string.utils.js +0 -0
package/README.md
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
**@hichchi/utils**
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
1
|
<!--suppress ALL -->
|
|
6
2
|
|
|
7
3
|
<div align="center">
|
|
@@ -184,7 +180,7 @@ nx run utils:benchmark
|
|
|
184
180
|
[](https://github.com/hichchidev/hichchi/issues)
|
|
185
181
|
[](https://github.com/hichchidev/hichchi/issues)
|
|
186
182
|
|
|
187
|
-
_Building the future of
|
|
183
|
+
_Building the future of development utilities, one commit at a time_
|
|
188
184
|
|
|
189
185
|
</div>
|
|
190
186
|
|
|
@@ -293,7 +289,7 @@ Complete technical reference for all classes, interfaces, methods, and types in
|
|
|
293
289
|
|
|
294
290
|
### TemplateTag
|
|
295
291
|
|
|
296
|
-
Defined in: [enums/template-tag.enum.ts:15](https://github.com/hichchidev/hichchi/blob/
|
|
292
|
+
Defined in: [enums/template-tag.enum.ts:15](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L15)
|
|
297
293
|
|
|
298
294
|
Template tags for string transformations
|
|
299
295
|
|
|
@@ -334,7 +330,7 @@ corresponding transformation to the provided value.
|
|
|
334
330
|
</td>
|
|
335
331
|
<td>
|
|
336
332
|
|
|
337
|
-
[enums/template-tag.enum.ts:22](https://github.com/hichchidev/hichchi/blob/
|
|
333
|
+
[enums/template-tag.enum.ts:22](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L22)
|
|
338
334
|
|
|
339
335
|
</td>
|
|
340
336
|
</tr>
|
|
@@ -351,7 +347,7 @@ corresponding transformation to the provided value.
|
|
|
351
347
|
</td>
|
|
352
348
|
<td>
|
|
353
349
|
|
|
354
|
-
[enums/template-tag.enum.ts:21](https://github.com/hichchidev/hichchi/blob/
|
|
350
|
+
[enums/template-tag.enum.ts:21](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L21)
|
|
355
351
|
|
|
356
352
|
</td>
|
|
357
353
|
</tr>
|
|
@@ -368,7 +364,7 @@ corresponding transformation to the provided value.
|
|
|
368
364
|
</td>
|
|
369
365
|
<td>
|
|
370
366
|
|
|
371
|
-
[enums/template-tag.enum.ts:29](https://github.com/hichchidev/hichchi/blob/
|
|
367
|
+
[enums/template-tag.enum.ts:29](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L29)
|
|
372
368
|
|
|
373
369
|
</td>
|
|
374
370
|
</tr>
|
|
@@ -385,7 +381,7 @@ corresponding transformation to the provided value.
|
|
|
385
381
|
</td>
|
|
386
382
|
<td>
|
|
387
383
|
|
|
388
|
-
[enums/template-tag.enum.ts:32](https://github.com/hichchidev/hichchi/blob/
|
|
384
|
+
[enums/template-tag.enum.ts:32](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L32)
|
|
389
385
|
|
|
390
386
|
</td>
|
|
391
387
|
</tr>
|
|
@@ -402,7 +398,7 @@ corresponding transformation to the provided value.
|
|
|
402
398
|
</td>
|
|
403
399
|
<td>
|
|
404
400
|
|
|
405
|
-
[enums/template-tag.enum.ts:24](https://github.com/hichchidev/hichchi/blob/
|
|
401
|
+
[enums/template-tag.enum.ts:24](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L24)
|
|
406
402
|
|
|
407
403
|
</td>
|
|
408
404
|
</tr>
|
|
@@ -419,7 +415,7 @@ corresponding transformation to the provided value.
|
|
|
419
415
|
</td>
|
|
420
416
|
<td>
|
|
421
417
|
|
|
422
|
-
[enums/template-tag.enum.ts:19](https://github.com/hichchidev/hichchi/blob/
|
|
418
|
+
[enums/template-tag.enum.ts:19](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L19)
|
|
423
419
|
|
|
424
420
|
</td>
|
|
425
421
|
</tr>
|
|
@@ -436,7 +432,7 @@ corresponding transformation to the provided value.
|
|
|
436
432
|
</td>
|
|
437
433
|
<td>
|
|
438
434
|
|
|
439
|
-
[enums/template-tag.enum.ts:27](https://github.com/hichchidev/hichchi/blob/
|
|
435
|
+
[enums/template-tag.enum.ts:27](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L27)
|
|
440
436
|
|
|
441
437
|
</td>
|
|
442
438
|
</tr>
|
|
@@ -453,7 +449,7 @@ corresponding transformation to the provided value.
|
|
|
453
449
|
</td>
|
|
454
450
|
<td>
|
|
455
451
|
|
|
456
|
-
[enums/template-tag.enum.ts:31](https://github.com/hichchidev/hichchi/blob/
|
|
452
|
+
[enums/template-tag.enum.ts:31](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L31)
|
|
457
453
|
|
|
458
454
|
</td>
|
|
459
455
|
</tr>
|
|
@@ -470,7 +466,7 @@ corresponding transformation to the provided value.
|
|
|
470
466
|
</td>
|
|
471
467
|
<td>
|
|
472
468
|
|
|
473
|
-
[enums/template-tag.enum.ts:23](https://github.com/hichchidev/hichchi/blob/
|
|
469
|
+
[enums/template-tag.enum.ts:23](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L23)
|
|
474
470
|
|
|
475
471
|
</td>
|
|
476
472
|
</tr>
|
|
@@ -487,7 +483,7 @@ corresponding transformation to the provided value.
|
|
|
487
483
|
</td>
|
|
488
484
|
<td>
|
|
489
485
|
|
|
490
|
-
[enums/template-tag.enum.ts:20](https://github.com/hichchidev/hichchi/blob/
|
|
486
|
+
[enums/template-tag.enum.ts:20](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L20)
|
|
491
487
|
|
|
492
488
|
</td>
|
|
493
489
|
</tr>
|
|
@@ -504,7 +500,7 @@ corresponding transformation to the provided value.
|
|
|
504
500
|
</td>
|
|
505
501
|
<td>
|
|
506
502
|
|
|
507
|
-
[enums/template-tag.enum.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
503
|
+
[enums/template-tag.enum.ts:30](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L30)
|
|
508
504
|
|
|
509
505
|
</td>
|
|
510
506
|
</tr>
|
|
@@ -521,7 +517,7 @@ corresponding transformation to the provided value.
|
|
|
521
517
|
</td>
|
|
522
518
|
<td>
|
|
523
519
|
|
|
524
|
-
[enums/template-tag.enum.ts:17](https://github.com/hichchidev/hichchi/blob/
|
|
520
|
+
[enums/template-tag.enum.ts:17](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L17)
|
|
525
521
|
|
|
526
522
|
</td>
|
|
527
523
|
</tr>
|
|
@@ -538,7 +534,7 @@ corresponding transformation to the provided value.
|
|
|
538
534
|
</td>
|
|
539
535
|
<td>
|
|
540
536
|
|
|
541
|
-
[enums/template-tag.enum.ts:26](https://github.com/hichchidev/hichchi/blob/
|
|
537
|
+
[enums/template-tag.enum.ts:26](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L26)
|
|
542
538
|
|
|
543
539
|
</td>
|
|
544
540
|
</tr>
|
|
@@ -555,7 +551,7 @@ corresponding transformation to the provided value.
|
|
|
555
551
|
</td>
|
|
556
552
|
<td>
|
|
557
553
|
|
|
558
|
-
[enums/template-tag.enum.ts:16](https://github.com/hichchidev/hichchi/blob/
|
|
554
|
+
[enums/template-tag.enum.ts:16](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L16)
|
|
559
555
|
|
|
560
556
|
</td>
|
|
561
557
|
</tr>
|
|
@@ -572,7 +568,7 @@ corresponding transformation to the provided value.
|
|
|
572
568
|
</td>
|
|
573
569
|
<td>
|
|
574
570
|
|
|
575
|
-
[enums/template-tag.enum.ts:28](https://github.com/hichchidev/hichchi/blob/
|
|
571
|
+
[enums/template-tag.enum.ts:28](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L28)
|
|
576
572
|
|
|
577
573
|
</td>
|
|
578
574
|
</tr>
|
|
@@ -589,7 +585,7 @@ corresponding transformation to the provided value.
|
|
|
589
585
|
</td>
|
|
590
586
|
<td>
|
|
591
587
|
|
|
592
|
-
[enums/template-tag.enum.ts:25](https://github.com/hichchidev/hichchi/blob/
|
|
588
|
+
[enums/template-tag.enum.ts:25](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L25)
|
|
593
589
|
|
|
594
590
|
</td>
|
|
595
591
|
</tr>
|
|
@@ -606,7 +602,7 @@ corresponding transformation to the provided value.
|
|
|
606
602
|
</td>
|
|
607
603
|
<td>
|
|
608
604
|
|
|
609
|
-
[enums/template-tag.enum.ts:18](https://github.com/hichchidev/hichchi/blob/
|
|
605
|
+
[enums/template-tag.enum.ts:18](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/enums/template-tag.enum.ts#L18)
|
|
610
606
|
|
|
611
607
|
</td>
|
|
612
608
|
</tr>
|
|
@@ -621,7 +617,7 @@ corresponding transformation to the provided value.
|
|
|
621
617
|
function applyTemplate(str, prefix): string;
|
|
622
618
|
```
|
|
623
619
|
|
|
624
|
-
Defined in: [utils/string-template.utils.ts:83](https://github.com/hichchidev/hichchi/blob/
|
|
620
|
+
Defined in: [utils/string-template.utils.ts:83](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string-template.utils.ts#L83)
|
|
625
621
|
|
|
626
622
|
Applies a value to a template string containing transformation tags.
|
|
627
623
|
|
|
@@ -744,7 +740,7 @@ applyTemplate(
|
|
|
744
740
|
function applyTemplates(str, prefixes): string;
|
|
745
741
|
```
|
|
746
742
|
|
|
747
|
-
Defined in: [utils/string-template.utils.ts:211](https://github.com/hichchidev/hichchi/blob/
|
|
743
|
+
Defined in: [utils/string-template.utils.ts:211](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string-template.utils.ts#L211)
|
|
748
744
|
|
|
749
745
|
Applies multiple named template transformations to a string with different values for each prefix.
|
|
750
746
|
|
|
@@ -912,7 +908,7 @@ CREATE INDEX idx_#{table.snakeCase}_#{field.snakeCase} ON #{table.snakeCase}(#{f
|
|
|
912
908
|
function breakToWords(str): string[];
|
|
913
909
|
```
|
|
914
910
|
|
|
915
|
-
Defined in: [utils/string.utils.ts:47](https://github.com/hichchidev/hichchi/blob/
|
|
911
|
+
Defined in: [utils/string.utils.ts:47](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L47)
|
|
916
912
|
|
|
917
913
|
Breaks a string into an array of words based on common separator patterns.
|
|
918
914
|
|
|
@@ -987,7 +983,7 @@ breakToWords("123Test456"); // ['123', 'test', '456']
|
|
|
987
983
|
function breakToWords(str, format): string;
|
|
988
984
|
```
|
|
989
985
|
|
|
990
|
-
Defined in: [utils/string.utils.ts:76](https://github.com/hichchidev/hichchi/blob/
|
|
986
|
+
Defined in: [utils/string.utils.ts:76](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L76)
|
|
991
987
|
|
|
992
988
|
Breaks a string into words and formats them using a provided function.
|
|
993
989
|
|
|
@@ -1075,7 +1071,7 @@ breakToWords("SYSTEM_ERROR", (word) => word.toLowerCase()); // "system error"
|
|
|
1075
1071
|
function countOccurrences(str, searchValue, caseSensitive?): number;
|
|
1076
1072
|
```
|
|
1077
1073
|
|
|
1078
|
-
Defined in: [utils/string.utils.ts:1288](https://github.com/hichchidev/hichchi/blob/
|
|
1074
|
+
Defined in: [utils/string.utils.ts:1288](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1288)
|
|
1079
1075
|
|
|
1080
1076
|
Counts the occurrences of a substring within a string.
|
|
1081
1077
|
|
|
@@ -1182,7 +1178,7 @@ countOccurrences("Hello hello", "hello", true); // 1
|
|
|
1182
1178
|
function createExcerpt(text, searchTerm, contextLength?, ellipsis?): string;
|
|
1183
1179
|
```
|
|
1184
1180
|
|
|
1185
|
-
Defined in: [utils/string.utils.ts:721](https://github.com/hichchidev/hichchi/blob/
|
|
1181
|
+
Defined in: [utils/string.utils.ts:721](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L721)
|
|
1186
1182
|
|
|
1187
1183
|
Creates an excerpt from a longer text by extracting a portion around a search term.
|
|
1188
1184
|
Useful for search result highlighting or previews.
|
|
@@ -1317,7 +1313,7 @@ createExcerpt(article, "consectetur", 15, "[...]");
|
|
|
1317
1313
|
function deepCopy<T>(obj): T;
|
|
1318
1314
|
```
|
|
1319
1315
|
|
|
1320
|
-
Defined in: [utils/object.utils.ts:23](https://github.com/hichchidev/hichchi/blob/
|
|
1316
|
+
Defined in: [utils/object.utils.ts:23](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L23)
|
|
1321
1317
|
|
|
1322
1318
|
Deep copy an object.
|
|
1323
1319
|
|
|
@@ -1402,7 +1398,7 @@ const copiedObject = deepCopy(object);
|
|
|
1402
1398
|
function escapeRegExp(str): string;
|
|
1403
1399
|
```
|
|
1404
1400
|
|
|
1405
|
-
Defined in: [utils/string.utils.ts:1134](https://github.com/hichchidev/hichchi/blob/
|
|
1401
|
+
Defined in: [utils/string.utils.ts:1134](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1134)
|
|
1406
1402
|
|
|
1407
1403
|
Escapes special characters in a string for use in regular expressions.
|
|
1408
1404
|
|
|
@@ -1461,7 +1457,7 @@ const regex = new RegExp(escapeRegExp(userInput));
|
|
|
1461
1457
|
function extractEmails(str): string[];
|
|
1462
1458
|
```
|
|
1463
1459
|
|
|
1464
|
-
Defined in: [utils/string.utils.ts:456](https://github.com/hichchidev/hichchi/blob/
|
|
1460
|
+
Defined in: [utils/string.utils.ts:456](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L456)
|
|
1465
1461
|
|
|
1466
1462
|
Extracts all email addresses from a string.
|
|
1467
1463
|
|
|
@@ -1517,7 +1513,7 @@ extractEmails("Contact us at support@example.com or sales@example.com");
|
|
|
1517
1513
|
function extractUrls(str): string[];
|
|
1518
1514
|
```
|
|
1519
1515
|
|
|
1520
|
-
Defined in: [utils/string.utils.ts:475](https://github.com/hichchidev/hichchi/blob/
|
|
1516
|
+
Defined in: [utils/string.utils.ts:475](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L475)
|
|
1521
1517
|
|
|
1522
1518
|
Extracts all URLs from a string.
|
|
1523
1519
|
|
|
@@ -1577,7 +1573,7 @@ Implementation of the format function that handles both overloads.
|
|
|
1577
1573
|
function format(template, ...values): string;
|
|
1578
1574
|
```
|
|
1579
1575
|
|
|
1580
|
-
Defined in: [utils/string.utils.ts:1220](https://github.com/hichchidev/hichchi/blob/
|
|
1576
|
+
Defined in: [utils/string.utils.ts:1220](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1220)
|
|
1581
1577
|
|
|
1582
1578
|
Formats a string by replacing indexed placeholders with provided values.
|
|
1583
1579
|
|
|
@@ -1653,7 +1649,7 @@ format("User {0} has {1} points", "John", 100);
|
|
|
1653
1649
|
function format(template, values): string;
|
|
1654
1650
|
```
|
|
1655
1651
|
|
|
1656
|
-
Defined in: [utils/string.utils.ts:1239](https://github.com/hichchidev/hichchi/blob/
|
|
1652
|
+
Defined in: [utils/string.utils.ts:1239](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1239)
|
|
1657
1653
|
|
|
1658
1654
|
Formats a string by replacing named placeholders with values from an object.
|
|
1659
1655
|
|
|
@@ -1733,7 +1729,7 @@ format("Hello, {name}! You have {count} messages.", {
|
|
|
1733
1729
|
function getEnumValues<T>(e): T[keyof T][];
|
|
1734
1730
|
```
|
|
1735
1731
|
|
|
1736
|
-
Defined in: [utils/object.utils.ts:1070](https://github.com/hichchidev/hichchi/blob/
|
|
1732
|
+
Defined in: [utils/object.utils.ts:1070](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L1070)
|
|
1737
1733
|
|
|
1738
1734
|
Extracts all values from a TypeScript enum, handling both string and numeric enum types correctly.
|
|
1739
1735
|
|
|
@@ -1902,7 +1898,7 @@ Object.values The underlying method used to extract enum entries
|
|
|
1902
1898
|
function getMapKey(map, value): undefined | string;
|
|
1903
1899
|
```
|
|
1904
1900
|
|
|
1905
|
-
Defined in: [utils/object.utils.ts:53](https://github.com/hichchidev/hichchi/blob/
|
|
1901
|
+
Defined in: [utils/object.utils.ts:53](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L53)
|
|
1906
1902
|
|
|
1907
1903
|
Get the key of a map by value.
|
|
1908
1904
|
|
|
@@ -1984,7 +1980,7 @@ const key = getMapKey(user, "value2");
|
|
|
1984
1980
|
function getMapKeys(map, partialValue): string[];
|
|
1985
1981
|
```
|
|
1986
1982
|
|
|
1987
|
-
Defined in: [utils/object.utils.ts:122](https://github.com/hichchidev/hichchi/blob/
|
|
1983
|
+
Defined in: [utils/object.utils.ts:122](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L122)
|
|
1988
1984
|
|
|
1989
1985
|
Retrieves all keys from a Map where the corresponding values contain a specified substring.
|
|
1990
1986
|
|
|
@@ -2108,7 +2104,7 @@ const messageKeys = getMapKeys(translations, "message");
|
|
|
2108
2104
|
function getValueByPath<T>(obj, path): undefined | T;
|
|
2109
2105
|
```
|
|
2110
2106
|
|
|
2111
|
-
Defined in: [utils/object.utils.ts:379](https://github.com/hichchidev/hichchi/blob/
|
|
2107
|
+
Defined in: [utils/object.utils.ts:379](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L379)
|
|
2112
2108
|
|
|
2113
2109
|
Gets a value from a nested object using a dot-notation path string.
|
|
2114
2110
|
|
|
@@ -2234,7 +2230,7 @@ const name = getValueByPath<string>(data, "users[1].name");
|
|
|
2234
2230
|
function groupBy<K, V>(list, keyGetter): Map<null | K, V[]>;
|
|
2235
2231
|
```
|
|
2236
2232
|
|
|
2237
|
-
Defined in: [utils/object.utils.ts:237](https://github.com/hichchidev/hichchi/blob/
|
|
2233
|
+
Defined in: [utils/object.utils.ts:237](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L237)
|
|
2238
2234
|
|
|
2239
2235
|
Groups an array of objects into a Map based on a key extraction function.
|
|
2240
2236
|
|
|
@@ -2433,7 +2429,7 @@ const tasksByStatus = groupBy(tasks, (task) => task.completed);
|
|
|
2433
2429
|
function hashString(str): Promise<string>;
|
|
2434
2430
|
```
|
|
2435
2431
|
|
|
2436
|
-
Defined in: [utils/string.utils.ts:499](https://github.com/hichchidev/hichchi/blob/
|
|
2432
|
+
Defined in: [utils/string.utils.ts:499](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L499)
|
|
2437
2433
|
|
|
2438
2434
|
Converts a string to a secure hash using SHA-256.
|
|
2439
2435
|
|
|
@@ -2493,7 +2489,7 @@ await hashString("password123");
|
|
|
2493
2489
|
function hasOwnAll(obj, props): boolean;
|
|
2494
2490
|
```
|
|
2495
2491
|
|
|
2496
|
-
Defined in: [utils/object.utils.ts:965](https://github.com/hichchidev/hichchi/blob/
|
|
2492
|
+
Defined in: [utils/object.utils.ts:965](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L965)
|
|
2497
2493
|
|
|
2498
2494
|
Checks if an object has all specified properties as its own properties (not inherited).
|
|
2499
2495
|
|
|
@@ -2662,7 +2658,7 @@ Object.hasOwn The underlying method used for property checking
|
|
|
2662
2658
|
function htmlToText(str): string;
|
|
2663
2659
|
```
|
|
2664
2660
|
|
|
2665
|
-
Defined in: [utils/string.utils.ts:1001](https://github.com/hichchidev/hichchi/blob/
|
|
2661
|
+
Defined in: [utils/string.utils.ts:1001](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1001)
|
|
2666
2662
|
|
|
2667
2663
|
Remove HTML tags from a string and return plain text.
|
|
2668
2664
|
|
|
@@ -2717,7 +2713,7 @@ htmlToText("<h1>Hello World</h1>"); // "Hello World"
|
|
|
2717
2713
|
function isAlphanumeric(str): boolean;
|
|
2718
2714
|
```
|
|
2719
2715
|
|
|
2720
|
-
Defined in: [utils/string.utils.ts:1325](https://github.com/hichchidev/hichchi/blob/
|
|
2716
|
+
Defined in: [utils/string.utils.ts:1325](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1325)
|
|
2721
2717
|
|
|
2722
2718
|
Checks if a string contains only alphanumeric characters.
|
|
2723
2719
|
|
|
@@ -2773,7 +2769,7 @@ isAlphanumeric("abc-123"); // false
|
|
|
2773
2769
|
function isArray<T>(value): value is T[];
|
|
2774
2770
|
```
|
|
2775
2771
|
|
|
2776
|
-
Defined in: [utils/assertions.utils.ts:42](https://github.com/hichchidev/hichchi/blob/
|
|
2772
|
+
Defined in: [utils/assertions.utils.ts:42](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/assertions.utils.ts#L42)
|
|
2777
2773
|
|
|
2778
2774
|
Type-safe utility to check if a value is an array of a specific type.
|
|
2779
2775
|
|
|
@@ -2882,7 +2878,7 @@ async function createUser(
|
|
|
2882
2878
|
function isObject<T>(value?): value is T;
|
|
2883
2879
|
```
|
|
2884
2880
|
|
|
2885
|
-
Defined in: [utils/assertions.utils.ts:91](https://github.com/hichchidev/hichchi/blob/
|
|
2881
|
+
Defined in: [utils/assertions.utils.ts:91](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/assertions.utils.ts#L91)
|
|
2886
2882
|
|
|
2887
2883
|
Type-safe utility to check if a value is a non-array object of a specific type.
|
|
2888
2884
|
|
|
@@ -2999,7 +2995,7 @@ function formatUserName(user?: User | string): string {
|
|
|
2999
2995
|
function isObjectWith<T>(value, propertyName): value is T;
|
|
3000
2996
|
```
|
|
3001
2997
|
|
|
3002
|
-
Defined in: [utils/assertions.utils.ts:158](https://github.com/hichchidev/hichchi/blob/
|
|
2998
|
+
Defined in: [utils/assertions.utils.ts:158](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/assertions.utils.ts#L158)
|
|
3003
2999
|
|
|
3004
3000
|
Type-safe utility to check if a value is an object with a specific property.
|
|
3005
3001
|
|
|
@@ -3147,7 +3143,7 @@ async function handleResponse(response: unknown): Promise<void> {
|
|
|
3147
3143
|
function isValidRedirectUrl(url, allowedDomains): boolean;
|
|
3148
3144
|
```
|
|
3149
3145
|
|
|
3150
|
-
Defined in: [utils/url.utils.ts:102](https://github.com/hichchidev/hichchi/blob/
|
|
3146
|
+
Defined in: [utils/url.utils.ts:102](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/url.utils.ts#L102)
|
|
3151
3147
|
|
|
3152
3148
|
Validates if a redirect URL is allowed based on a whitelist of permitted domains.
|
|
3153
3149
|
|
|
@@ -3318,7 +3314,7 @@ URL The Web API used for URL parsing and validation
|
|
|
3318
3314
|
function maskString(str, visibleStart?, visibleEnd?, maskChar?): string;
|
|
3319
3315
|
```
|
|
3320
3316
|
|
|
3321
|
-
Defined in: [utils/string.utils.ts:584](https://github.com/hichchidev/hichchi/blob/
|
|
3317
|
+
Defined in: [utils/string.utils.ts:584](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L584)
|
|
3322
3318
|
|
|
3323
3319
|
Masks a portion of a string, useful for displaying sensitive information.
|
|
3324
3320
|
|
|
@@ -3455,7 +3451,7 @@ maskString("+1-555-123-4567", 0, 4);
|
|
|
3455
3451
|
function normalizeString(str): string;
|
|
3456
3452
|
```
|
|
3457
3453
|
|
|
3458
|
-
Defined in: [utils/string.utils.ts:767](https://github.com/hichchidev/hichchi/blob/
|
|
3454
|
+
Defined in: [utils/string.utils.ts:767](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L767)
|
|
3459
3455
|
|
|
3460
3456
|
Normalizes a string by removing accents, diacritics, and converting to lowercase.
|
|
3461
3457
|
|
|
@@ -3513,7 +3509,7 @@ normalizeString("ESPAÑA"); // "espana"
|
|
|
3513
3509
|
function objectToPathValueSet(obj): PathValueSet;
|
|
3514
3510
|
```
|
|
3515
3511
|
|
|
3516
|
-
Defined in: [utils/object.utils.ts:460](https://github.com/hichchidev/hichchi/blob/
|
|
3512
|
+
Defined in: [utils/object.utils.ts:460](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L460)
|
|
3517
3513
|
|
|
3518
3514
|
Converts a nested object into a flattened PathValueSet representation.
|
|
3519
3515
|
|
|
@@ -3612,7 +3608,7 @@ const flattened = objectToPathValueSet(user);
|
|
|
3612
3608
|
function omit<T>(obj, keys?): Partial<T>;
|
|
3613
3609
|
```
|
|
3614
3610
|
|
|
3615
|
-
Defined in: [utils/object.utils.ts:683](https://github.com/hichchidev/hichchi/blob/
|
|
3611
|
+
Defined in: [utils/object.utils.ts:683](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L683)
|
|
3616
3612
|
|
|
3617
3613
|
Creates a new object by omitting specified properties and undefined values from the original object.
|
|
3618
3614
|
|
|
@@ -3792,7 +3788,7 @@ const publicProfile = omit(userProfile, ["password", "internalNotes"]);
|
|
|
3792
3788
|
function padString(str, length, char?, padEnd?): string;
|
|
3793
3789
|
```
|
|
3794
3790
|
|
|
3795
|
-
Defined in: [utils/string.utils.ts:1111](https://github.com/hichchidev/hichchi/blob/
|
|
3791
|
+
Defined in: [utils/string.utils.ts:1111](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1111)
|
|
3796
3792
|
|
|
3797
3793
|
Pads a string to a specified length with a specified character.
|
|
3798
3794
|
|
|
@@ -3921,7 +3917,7 @@ padString("Hello", 10, "0", false); // "00000Hello"
|
|
|
3921
3917
|
function pathValueSetToObject<R>(pathValueSet): R;
|
|
3922
3918
|
```
|
|
3923
3919
|
|
|
3924
|
-
Defined in: [utils/object.utils.ts:549](https://github.com/hichchidev/hichchi/blob/
|
|
3920
|
+
Defined in: [utils/object.utils.ts:549](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L549)
|
|
3925
3921
|
|
|
3926
3922
|
Converts a flattened PathValueSet back into a nested object structure.
|
|
3927
3923
|
|
|
@@ -4065,7 +4061,7 @@ const userData = pathValueSetToObject<User>(flatData);
|
|
|
4065
4061
|
function plural(str): string;
|
|
4066
4062
|
```
|
|
4067
4063
|
|
|
4068
|
-
Defined in: [utils/string.utils.ts:1049](https://github.com/hichchidev/hichchi/blob/
|
|
4064
|
+
Defined in: [utils/string.utils.ts:1049](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1049)
|
|
4069
4065
|
|
|
4070
4066
|
Converts a singular English word to its plural form.
|
|
4071
4067
|
|
|
@@ -4154,7 +4150,7 @@ plural("analysis"); // "analyses"
|
|
|
4154
4150
|
function prune<T>(obj, omitPrototype?): T;
|
|
4155
4151
|
```
|
|
4156
4152
|
|
|
4157
|
-
Defined in: [utils/object.utils.ts:838](https://github.com/hichchidev/hichchi/blob/
|
|
4153
|
+
Defined in: [utils/object.utils.ts:838](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L838)
|
|
4158
4154
|
|
|
4159
4155
|
Creates a deep copy of an object with all empty, null, undefined, and optionally prototype properties removed.
|
|
4160
4156
|
|
|
@@ -4385,7 +4381,7 @@ const prunedOwnOnly = prune(user, true);
|
|
|
4385
4381
|
function randomString(length, charset?): string;
|
|
4386
4382
|
```
|
|
4387
4383
|
|
|
4388
|
-
Defined in: [utils/string.utils.ts:536](https://github.com/hichchidev/hichchi/blob/
|
|
4384
|
+
Defined in: [utils/string.utils.ts:536](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L536)
|
|
4389
4385
|
|
|
4390
4386
|
Generates a random string with specified length and character set.
|
|
4391
4387
|
|
|
@@ -4467,7 +4463,7 @@ randomString(4, "0123456789");
|
|
|
4467
4463
|
function removeWhitespace(str): string;
|
|
4468
4464
|
```
|
|
4469
4465
|
|
|
4470
|
-
Defined in: [utils/string.utils.ts:1342](https://github.com/hichchidev/hichchi/blob/
|
|
4466
|
+
Defined in: [utils/string.utils.ts:1342](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1342)
|
|
4471
4467
|
|
|
4472
4468
|
Removes all whitespace from a string.
|
|
4473
4469
|
|
|
@@ -4523,7 +4519,7 @@ removeWhitespace(" spaces tabs "); // "spacestabs"
|
|
|
4523
4519
|
function reverse(str): string;
|
|
4524
4520
|
```
|
|
4525
4521
|
|
|
4526
|
-
Defined in: [utils/string.utils.ts:1308](https://github.com/hichchidev/hichchi/blob/
|
|
4522
|
+
Defined in: [utils/string.utils.ts:1308](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1308)
|
|
4527
4523
|
|
|
4528
4524
|
Reverses a string.
|
|
4529
4525
|
|
|
@@ -4579,7 +4575,7 @@ reverse("12345"); // "54321"
|
|
|
4579
4575
|
function searchMapValues(map, partialValue): string[];
|
|
4580
4576
|
```
|
|
4581
4577
|
|
|
4582
|
-
Defined in: [utils/object.utils.ts:327](https://github.com/hichchidev/hichchi/blob/
|
|
4578
|
+
Defined in: [utils/object.utils.ts:327](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/object.utils.ts#L327)
|
|
4583
4579
|
|
|
4584
4580
|
Retrieves all values from a Map that contain a specified substring.
|
|
4585
4581
|
|
|
@@ -4716,7 +4712,7 @@ const productionValues = searchMapValues(config, "production");
|
|
|
4716
4712
|
function singular(str): string;
|
|
4717
4713
|
```
|
|
4718
4714
|
|
|
4719
|
-
Defined in: [utils/string.utils.ts:1387](https://github.com/hichchidev/hichchi/blob/
|
|
4715
|
+
Defined in: [utils/string.utils.ts:1387](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1387)
|
|
4720
4716
|
|
|
4721
4717
|
Converts plural English words to their singular form.
|
|
4722
4718
|
|
|
@@ -4801,7 +4797,7 @@ singular("phenomena"); // "phenomenon"
|
|
|
4801
4797
|
function slugify(str, separator?): string;
|
|
4802
4798
|
```
|
|
4803
4799
|
|
|
4804
|
-
Defined in: [utils/string.utils.ts:430](https://github.com/hichchidev/hichchi/blob/
|
|
4800
|
+
Defined in: [utils/string.utils.ts:430](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L430)
|
|
4805
4801
|
|
|
4806
4802
|
Generates a slug from a string, suitable for URLs or file names.
|
|
4807
4803
|
|
|
@@ -4888,7 +4884,7 @@ slugify("Blog Post", "_"); // "blog_post"
|
|
|
4888
4884
|
function stringSimilarity(str1, str2): number;
|
|
4889
4885
|
```
|
|
4890
4886
|
|
|
4891
|
-
Defined in: [utils/string.utils.ts:380](https://github.com/hichchidev/hichchi/blob/
|
|
4887
|
+
Defined in: [utils/string.utils.ts:380](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L380)
|
|
4892
4888
|
|
|
4893
4889
|
Compares two strings for similarity using Levenshtein distance algorithm.
|
|
4894
4890
|
|
|
@@ -4966,7 +4962,7 @@ stringSimilarity("same", "same"); // 1.0 (identical)
|
|
|
4966
4962
|
function toCamelCase(str?): string;
|
|
4967
4963
|
```
|
|
4968
4964
|
|
|
4969
|
-
Defined in: [utils/string.utils.ts:870](https://github.com/hichchidev/hichchi/blob/
|
|
4965
|
+
Defined in: [utils/string.utils.ts:870](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L870)
|
|
4970
4966
|
|
|
4971
4967
|
Convert a string to camel case.
|
|
4972
4968
|
|
|
@@ -5021,7 +5017,7 @@ toCamelCase("hello world"); // "helloWorld"
|
|
|
5021
5017
|
function toFirstCase(str?): string;
|
|
5022
5018
|
```
|
|
5023
5019
|
|
|
5024
|
-
Defined in: [utils/string.utils.ts:612](https://github.com/hichchidev/hichchi/blob/
|
|
5020
|
+
Defined in: [utils/string.utils.ts:612](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L612)
|
|
5025
5021
|
|
|
5026
5022
|
Convert a string to first case (Capitalize first letter of the string).
|
|
5027
5023
|
|
|
@@ -5076,7 +5072,7 @@ toFirstCase("hello world"); // "Hello world"
|
|
|
5076
5072
|
function toFirstCaseBreak(str?, join?): string;
|
|
5077
5073
|
```
|
|
5078
5074
|
|
|
5079
|
-
Defined in: [utils/string.utils.ts:832](https://github.com/hichchidev/hichchi/blob/
|
|
5075
|
+
Defined in: [utils/string.utils.ts:832](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L832)
|
|
5080
5076
|
|
|
5081
5077
|
Converts a string to Sentence case (first word capitalized, rest lowercase) with customizable word separators.
|
|
5082
5078
|
|
|
@@ -5170,7 +5166,7 @@ toFirstCaseBreak("GET_USER_DATA", "/"); // "Get/user/data"
|
|
|
5170
5166
|
function toKebabCase(str?, caps?): string;
|
|
5171
5167
|
```
|
|
5172
5168
|
|
|
5173
|
-
Defined in: [utils/string.utils.ts:969](https://github.com/hichchidev/hichchi/blob/
|
|
5169
|
+
Defined in: [utils/string.utils.ts:969](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L969)
|
|
5174
5170
|
|
|
5175
5171
|
Convert a string to kebab case.
|
|
5176
5172
|
|
|
@@ -5246,7 +5242,7 @@ toKebabCase("hello world", true); // "HELLO-WORLD"
|
|
|
5246
5242
|
function toLowerCase(str?): string;
|
|
5247
5243
|
```
|
|
5248
5244
|
|
|
5249
|
-
Defined in: [utils/string.utils.ts:163](https://github.com/hichchidev/hichchi/blob/
|
|
5245
|
+
Defined in: [utils/string.utils.ts:163](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L163)
|
|
5250
5246
|
|
|
5251
5247
|
Converts a string to lowercase with safe handling of undefined or null values.
|
|
5252
5248
|
|
|
@@ -5361,7 +5357,7 @@ function validateEmail(email?: string): boolean {
|
|
|
5361
5357
|
function toLowerCaseBreak(str?, join?): string;
|
|
5362
5358
|
```
|
|
5363
5359
|
|
|
5364
|
-
Defined in: [utils/string.utils.ts:262](https://github.com/hichchidev/hichchi/blob/
|
|
5360
|
+
Defined in: [utils/string.utils.ts:262](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L262)
|
|
5365
5361
|
|
|
5366
5362
|
Converts a string to lowercase and breaks it into words, joining them with a specified separator.
|
|
5367
5363
|
|
|
@@ -5512,7 +5508,7 @@ const result3 = toLowerCaseBreak("singleword");
|
|
|
5512
5508
|
function toNumber(str): undefined | number;
|
|
5513
5509
|
```
|
|
5514
5510
|
|
|
5515
|
-
Defined in: [utils/string.utils.ts:987](https://github.com/hichchidev/hichchi/blob/
|
|
5511
|
+
Defined in: [utils/string.utils.ts:987](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L987)
|
|
5516
5512
|
|
|
5517
5513
|
Converts a string to a number.
|
|
5518
5514
|
|
|
@@ -5567,7 +5563,7 @@ toNumber("123"); // 123
|
|
|
5567
5563
|
function toPascalCase(str?): string;
|
|
5568
5564
|
```
|
|
5569
5565
|
|
|
5570
|
-
Defined in: [utils/string.utils.ts:889](https://github.com/hichchidev/hichchi/blob/
|
|
5566
|
+
Defined in: [utils/string.utils.ts:889](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L889)
|
|
5571
5567
|
|
|
5572
5568
|
Convert a string to pascal case.
|
|
5573
5569
|
|
|
@@ -5622,7 +5618,7 @@ toPascalCase("hello world"); // "HelloWorld"
|
|
|
5622
5618
|
function toProperTitleCase(str): string;
|
|
5623
5619
|
```
|
|
5624
5620
|
|
|
5625
|
-
Defined in: [utils/string.utils.ts:1159](https://github.com/hichchidev/hichchi/blob/
|
|
5621
|
+
Defined in: [utils/string.utils.ts:1159](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1159)
|
|
5626
5622
|
|
|
5627
5623
|
Capitalizes each word in a string according to title case rules.
|
|
5628
5624
|
|
|
@@ -5688,7 +5684,7 @@ toProperTitleCase("a tale of two cities");
|
|
|
5688
5684
|
function toSentenceCase(str?): string;
|
|
5689
5685
|
```
|
|
5690
5686
|
|
|
5691
|
-
Defined in: [utils/string.utils.ts:908](https://github.com/hichchidev/hichchi/blob/
|
|
5687
|
+
Defined in: [utils/string.utils.ts:908](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L908)
|
|
5692
5688
|
|
|
5693
5689
|
Convert a string to sentence case. (Capitalize first letter of every sentence).
|
|
5694
5690
|
|
|
@@ -5743,7 +5739,7 @@ toSentenceCase("hello world. how are you?"); // "Hello world. How are you?"
|
|
|
5743
5739
|
function toSnakeCase(str?, caps?): string;
|
|
5744
5740
|
```
|
|
5745
5741
|
|
|
5746
|
-
Defined in: [utils/string.utils.ts:945](https://github.com/hichchidev/hichchi/blob/
|
|
5742
|
+
Defined in: [utils/string.utils.ts:945](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L945)
|
|
5747
5743
|
|
|
5748
5744
|
Converts a string to snake_case format.
|
|
5749
5745
|
|
|
@@ -5834,7 +5830,7 @@ then joins them with underscores, applying the requested case transformation.
|
|
|
5834
5830
|
function toTitleCase(str?): string;
|
|
5835
5831
|
```
|
|
5836
5832
|
|
|
5837
|
-
Defined in: [utils/string.utils.ts:851](https://github.com/hichchidev/hichchi/blob/
|
|
5833
|
+
Defined in: [utils/string.utils.ts:851](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L851)
|
|
5838
5834
|
|
|
5839
5835
|
Convert a string to title case (Capitalize first letter of each word).
|
|
5840
5836
|
|
|
@@ -5889,7 +5885,7 @@ toTitleCase("hello world"); // "Hello World"
|
|
|
5889
5885
|
function toUpperCase(str?): string;
|
|
5890
5886
|
```
|
|
5891
5887
|
|
|
5892
|
-
Defined in: [utils/string.utils.ts:355](https://github.com/hichchidev/hichchi/blob/
|
|
5888
|
+
Defined in: [utils/string.utils.ts:355](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L355)
|
|
5893
5889
|
|
|
5894
5890
|
Converts a string to uppercase with safe handling of undefined or null values.
|
|
5895
5891
|
|
|
@@ -6016,7 +6012,7 @@ compareIgnoreCase("Test", "test"); // true
|
|
|
6016
6012
|
function toUpperCaseBreak(str?, join?): string;
|
|
6017
6013
|
```
|
|
6018
6014
|
|
|
6019
|
-
Defined in: [utils/string.utils.ts:791](https://github.com/hichchidev/hichchi/blob/
|
|
6015
|
+
Defined in: [utils/string.utils.ts:791](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L791)
|
|
6020
6016
|
|
|
6021
6017
|
Convert a string to upper cases and break into words with optional join or space.
|
|
6022
6018
|
|
|
@@ -6091,7 +6087,7 @@ toUpperCaseBreak("HelloWorld", "! "); // "HELLO! WORLD"
|
|
|
6091
6087
|
function toVariableName(str, pascalCase?): string;
|
|
6092
6088
|
````
|
|
6093
6089
|
|
|
6094
|
-
Defined in: [utils/string.utils.ts:634](https://github.com/hichchidev/hichchi/blob/
|
|
6090
|
+
Defined in: [utils/string.utils.ts:634](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L634)
|
|
6095
6091
|
|
|
6096
6092
|
Converts a string to a camelCase or PascalCase variable name.
|
|
6097
6093
|
|
|
@@ -6177,7 +6173,7 @@ toVariableName("user_id", true); // "UserId"
|
|
|
6177
6173
|
function truncate(str, length, ellipsis?): string;
|
|
6178
6174
|
```
|
|
6179
6175
|
|
|
6180
|
-
Defined in: [utils/string.utils.ts:1089](https://github.com/hichchidev/hichchi/blob/
|
|
6176
|
+
Defined in: [utils/string.utils.ts:1089](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L1089)
|
|
6181
6177
|
|
|
6182
6178
|
Truncates a string to a specified length and adds an ellipsis if needed.
|
|
6183
6179
|
|
|
@@ -6284,7 +6280,7 @@ truncate("Custom ellipsis", 6, " [more]"); // "Custom [more]"
|
|
|
6284
6280
|
function wordWrap(str, lineLength?, breakChar?): string;
|
|
6285
6281
|
```
|
|
6286
6282
|
|
|
6287
|
-
Defined in: [utils/string.utils.ts:672](https://github.com/hichchidev/hichchi/blob/
|
|
6283
|
+
Defined in: [utils/string.utils.ts:672](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/utils/string.utils.ts#L672)
|
|
6288
6284
|
|
|
6289
6285
|
Wraps words in a string to ensure each line is no longer than a specified length.
|
|
6290
6286
|
|
|
@@ -6392,7 +6388,7 @@ wordWrap(text, 30, "<br>");
|
|
|
6392
6388
|
|
|
6393
6389
|
### InfiniteObject
|
|
6394
6390
|
|
|
6395
|
-
Defined in: [interfaces/infinite-object.interface.ts:43](https://github.com/hichchidev/hichchi/blob/
|
|
6391
|
+
Defined in: [interfaces/infinite-object.interface.ts:43](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/infinite-object.interface.ts#L43)
|
|
6396
6392
|
|
|
6397
6393
|
Represents an object with infinite nesting capability (recursive object type).
|
|
6398
6394
|
|
|
@@ -6450,7 +6446,7 @@ const nestedObj: InfiniteObject = {
|
|
|
6450
6446
|
|
|
6451
6447
|
### InflectionRule
|
|
6452
6448
|
|
|
6453
|
-
Defined in: [interfaces/inflection-rule.interfaces.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
6449
|
+
Defined in: [interfaces/inflection-rule.interfaces.ts:30](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L30)
|
|
6454
6450
|
|
|
6455
6451
|
Rule type for word inflection transformation
|
|
6456
6452
|
|
|
@@ -6514,7 +6510,7 @@ Regular expression pattern to match words this rule applies to
|
|
|
6514
6510
|
</td>
|
|
6515
6511
|
<td>
|
|
6516
6512
|
|
|
6517
|
-
[interfaces/inflection-rule.interfaces.ts:34](https://github.com/hichchidev/hichchi/blob/
|
|
6513
|
+
[interfaces/inflection-rule.interfaces.ts:34](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L34)
|
|
6518
6514
|
|
|
6519
6515
|
</td>
|
|
6520
6516
|
</tr>
|
|
@@ -6536,7 +6532,7 @@ Replacement string with capture group references or function to transform the ma
|
|
|
6536
6532
|
</td>
|
|
6537
6533
|
<td>
|
|
6538
6534
|
|
|
6539
|
-
[interfaces/inflection-rule.interfaces.ts:39](https://github.com/hichchidev/hichchi/blob/
|
|
6535
|
+
[interfaces/inflection-rule.interfaces.ts:39](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L39)
|
|
6540
6536
|
|
|
6541
6537
|
</td>
|
|
6542
6538
|
</tr>
|
|
@@ -6547,7 +6543,7 @@ Replacement string with capture group references or function to transform the ma
|
|
|
6547
6543
|
|
|
6548
6544
|
### InflectionRuleCategories
|
|
6549
6545
|
|
|
6550
|
-
Defined in: [interfaces/inflection-rule.interfaces.ts:125](https://github.com/hichchidev/hichchi/blob/
|
|
6546
|
+
Defined in: [interfaces/inflection-rule.interfaces.ts:125](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L125)
|
|
6551
6547
|
|
|
6552
6548
|
Categories of English inflection rules
|
|
6553
6549
|
|
|
@@ -6624,7 +6620,7 @@ Default rules for standard transformations
|
|
|
6624
6620
|
</td>
|
|
6625
6621
|
<td>
|
|
6626
6622
|
|
|
6627
|
-
[interfaces/inflection-rule.interfaces.ts:149](https://github.com/hichchidev/hichchi/blob/
|
|
6623
|
+
[interfaces/inflection-rule.interfaces.ts:149](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L149)
|
|
6628
6624
|
|
|
6629
6625
|
</td>
|
|
6630
6626
|
</tr>
|
|
@@ -6646,7 +6642,7 @@ Words that are the same in singular and plural form
|
|
|
6646
6642
|
</td>
|
|
6647
6643
|
<td>
|
|
6648
6644
|
|
|
6649
|
-
[interfaces/inflection-rule.interfaces.ts:129](https://github.com/hichchidev/hichchi/blob/
|
|
6645
|
+
[interfaces/inflection-rule.interfaces.ts:129](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L129)
|
|
6650
6646
|
|
|
6651
6647
|
</td>
|
|
6652
6648
|
</tr>
|
|
@@ -6668,7 +6664,7 @@ Words with irregular plural forms
|
|
|
6668
6664
|
</td>
|
|
6669
6665
|
<td>
|
|
6670
6666
|
|
|
6671
|
-
[interfaces/inflection-rule.interfaces.ts:134](https://github.com/hichchidev/hichchi/blob/
|
|
6667
|
+
[interfaces/inflection-rule.interfaces.ts:134](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L134)
|
|
6672
6668
|
|
|
6673
6669
|
</td>
|
|
6674
6670
|
</tr>
|
|
@@ -6690,7 +6686,7 @@ Words borrowed from Latin and Greek
|
|
|
6690
6686
|
</td>
|
|
6691
6687
|
<td>
|
|
6692
6688
|
|
|
6693
|
-
[interfaces/inflection-rule.interfaces.ts:139](https://github.com/hichchidev/hichchi/blob/
|
|
6689
|
+
[interfaces/inflection-rule.interfaces.ts:139](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L139)
|
|
6694
6690
|
|
|
6695
6691
|
</td>
|
|
6696
6692
|
</tr>
|
|
@@ -6712,7 +6708,7 @@ Words with specific ending patterns
|
|
|
6712
6708
|
</td>
|
|
6713
6709
|
<td>
|
|
6714
6710
|
|
|
6715
|
-
[interfaces/inflection-rule.interfaces.ts:144](https://github.com/hichchidev/hichchi/blob/
|
|
6711
|
+
[interfaces/inflection-rule.interfaces.ts:144](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L144)
|
|
6716
6712
|
|
|
6717
6713
|
</td>
|
|
6718
6714
|
</tr>
|
|
@@ -6723,7 +6719,7 @@ Words with specific ending patterns
|
|
|
6723
6719
|
|
|
6724
6720
|
### LiteralObject\<T>
|
|
6725
6721
|
|
|
6726
|
-
Defined in: [types/literal-object.type.ts:48](https://github.com/hichchidev/hichchi/blob/
|
|
6722
|
+
Defined in: [types/literal-object.type.ts:48](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/literal-object.type.ts#L48)
|
|
6727
6723
|
|
|
6728
6724
|
Generic interface for objects with string keys and values of a specified type.
|
|
6729
6725
|
|
|
@@ -6814,7 +6810,7 @@ The type of values in the object (defaults to `any`)
|
|
|
6814
6810
|
|
|
6815
6811
|
### PathValueSet
|
|
6816
6812
|
|
|
6817
|
-
Defined in: [interfaces/path-value-set.interface.ts:77](https://github.com/hichchidev/hichchi/blob/
|
|
6813
|
+
Defined in: [interfaces/path-value-set.interface.ts:77](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/path-value-set.interface.ts#L77)
|
|
6818
6814
|
|
|
6819
6815
|
Represents a flattened object where keys are dot-notation paths and values are primitive types.
|
|
6820
6816
|
|
|
@@ -6905,7 +6901,7 @@ userPathValues["profile.address.city"] = "Boston";
|
|
|
6905
6901
|
|
|
6906
6902
|
### PluralSingularRulePair
|
|
6907
6903
|
|
|
6908
|
-
Defined in: [interfaces/inflection-rule.interfaces.ts:70](https://github.com/hichchidev/hichchi/blob/
|
|
6904
|
+
Defined in: [interfaces/inflection-rule.interfaces.ts:70](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L70)
|
|
6909
6905
|
|
|
6910
6906
|
Pair of rule sets for bidirectional singular/plural transformations
|
|
6911
6907
|
|
|
@@ -6968,7 +6964,7 @@ Array of rules for converting singular words to plural form
|
|
|
6968
6964
|
</td>
|
|
6969
6965
|
<td>
|
|
6970
6966
|
|
|
6971
|
-
[interfaces/inflection-rule.interfaces.ts:74](https://github.com/hichchidev/hichchi/blob/
|
|
6967
|
+
[interfaces/inflection-rule.interfaces.ts:74](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L74)
|
|
6972
6968
|
|
|
6973
6969
|
</td>
|
|
6974
6970
|
</tr>
|
|
@@ -6990,7 +6986,7 @@ Array of rules for converting plural words to singular form
|
|
|
6990
6986
|
</td>
|
|
6991
6987
|
<td>
|
|
6992
6988
|
|
|
6993
|
-
[interfaces/inflection-rule.interfaces.ts:79](https://github.com/hichchidev/hichchi/blob/
|
|
6989
|
+
[interfaces/inflection-rule.interfaces.ts:79](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/interfaces/inflection-rule.interfaces.ts#L79)
|
|
6994
6990
|
|
|
6995
6991
|
</td>
|
|
6996
6992
|
</tr>
|
|
@@ -7007,7 +7003,7 @@ type DeepPartial<T> =
|
|
|
7007
7003
|
| T extends infer U[] ? DeepPartial<U>[] : T extends Map<infer K, infer V> ? Map<DeepPartial<K>, DeepPartial<V>> : T extends Set<infer M> ? Set<DeepPartial<M>> : T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T;
|
|
7008
7004
|
```
|
|
7009
7005
|
|
|
7010
|
-
Defined in: [types/deep-partial.type.ts:46](https://github.com/hichchidev/hichchi/blob/
|
|
7006
|
+
Defined in: [types/deep-partial.type.ts:46](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/deep-partial.type.ts#L46)
|
|
7011
7007
|
|
|
7012
7008
|
A utility type that recursively makes all properties of an object optional.
|
|
7013
7009
|
|
|
@@ -7092,7 +7088,7 @@ type IsAlreadyInPath<T, U> = U extends object
|
|
|
7092
7088
|
: false;
|
|
7093
7089
|
```
|
|
7094
7090
|
|
|
7095
|
-
Defined in: [types/is-already-in-path.type.ts:25](https://github.com/hichchidev/hichchi/blob/
|
|
7091
|
+
Defined in: [types/is-already-in-path.type.ts:25](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/is-already-in-path.type.ts#L25)
|
|
7096
7092
|
|
|
7097
7093
|
Type predicate that detects circular references in type paths.
|
|
7098
7094
|
|
|
@@ -7159,7 +7155,7 @@ type RecursivelyProcess<T, Path = never> =
|
|
|
7159
7155
|
type IsEmpty<T> = keyof T extends never ? true : false;
|
|
7160
7156
|
```
|
|
7161
7157
|
|
|
7162
|
-
Defined in: [types/is-empty.type.ts:26](https://github.com/hichchidev/hichchi/blob/
|
|
7158
|
+
Defined in: [types/is-empty.type.ts:26](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/is-empty.type.ts#L26)
|
|
7163
7159
|
|
|
7164
7160
|
Type predicate that determines if a type is an empty object type.
|
|
7165
7161
|
|
|
@@ -7217,7 +7213,7 @@ type ProcessedNonEmpty = ProcessObject<{ name: string }>; // { name: string }
|
|
|
7217
7213
|
type IsPrimitive<T> = T extends Primitive ? true : false;
|
|
7218
7214
|
```
|
|
7219
7215
|
|
|
7220
|
-
Defined in: [types/is-primitive.type.ts:31](https://github.com/hichchidev/hichchi/blob/
|
|
7216
|
+
Defined in: [types/is-primitive.type.ts:31](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/is-primitive.type.ts#L31)
|
|
7221
7217
|
|
|
7222
7218
|
Type predicate that determines if a type is a primitive JavaScript value.
|
|
7223
7219
|
|
|
@@ -7275,7 +7271,7 @@ type SerializedObject = SerializeValue<{ foo: string }>; // string
|
|
|
7275
7271
|
type LooseAutocomplete<T> = T | Omit<string, T>;
|
|
7276
7272
|
```
|
|
7277
7273
|
|
|
7278
|
-
Defined in: [types/loose-autocomplete.type.ts:32](https://github.com/hichchidev/hichchi/blob/
|
|
7274
|
+
Defined in: [types/loose-autocomplete.type.ts:32](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/loose-autocomplete.type.ts#L32)
|
|
7279
7275
|
|
|
7280
7276
|
Represents a type for autocompleting string values.
|
|
7281
7277
|
|
|
@@ -7341,7 +7337,7 @@ Matt Pocock (https://www.totaltypescript.com/tips/create-autocomplete-helper-whi
|
|
|
7341
7337
|
type NonNullPrimitive = string | number | boolean | symbol | bigint;
|
|
7342
7338
|
```
|
|
7343
7339
|
|
|
7344
|
-
Defined in: [types/is-primitive.type.ts:5](https://github.com/hichchidev/hichchi/blob/
|
|
7340
|
+
Defined in: [types/is-primitive.type.ts:5](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/is-primitive.type.ts#L5)
|
|
7345
7341
|
|
|
7346
7342
|
---
|
|
7347
7343
|
|
|
@@ -7351,7 +7347,7 @@ Defined in: [types/is-primitive.type.ts:5](https://github.com/hichchidev/hichchi
|
|
|
7351
7347
|
type PartialWithNull<T> = { [p in keyof T]?: T[p] | null };
|
|
7352
7348
|
```
|
|
7353
7349
|
|
|
7354
|
-
Defined in: [types/partial-with-null.type.ts:25](https://github.com/hichchidev/hichchi/blob/
|
|
7350
|
+
Defined in: [types/partial-with-null.type.ts:25](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/partial-with-null.type.ts#L25)
|
|
7355
7351
|
|
|
7356
7352
|
Makes all properties of type T optional and allows them to be null.
|
|
7357
7353
|
|
|
@@ -7408,7 +7404,7 @@ const partialUser: PartialWithNull<User> = {
|
|
|
7408
7404
|
type Prettify<T> = { [K in keyof T]: T[K] } & object;
|
|
7409
7405
|
```
|
|
7410
7406
|
|
|
7411
|
-
Defined in: [types/prettify.type.ts:22](https://github.com/hichchidev/hichchi/blob/
|
|
7407
|
+
Defined in: [types/prettify.type.ts:22](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/prettify.type.ts#L22)
|
|
7412
7408
|
|
|
7413
7409
|
Utility type for creating a clean object type from a complex type.
|
|
7414
7410
|
|
|
@@ -7463,7 +7459,7 @@ type SimpleType = Prettify<ComplexType>;
|
|
|
7463
7459
|
type Primitive = string | number | boolean | symbol | bigint | null | undefined;
|
|
7464
7460
|
```
|
|
7465
7461
|
|
|
7466
|
-
Defined in: [types/is-primitive.type.ts:3](https://github.com/hichchidev/hichchi/blob/
|
|
7462
|
+
Defined in: [types/is-primitive.type.ts:3](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/is-primitive.type.ts#L3)
|
|
7467
7463
|
|
|
7468
7464
|
---
|
|
7469
7465
|
|
|
@@ -7473,7 +7469,7 @@ Defined in: [types/is-primitive.type.ts:3](https://github.com/hichchidev/hichchi
|
|
|
7473
7469
|
type Type<T> = (...args) => T;
|
|
7474
7470
|
```
|
|
7475
7471
|
|
|
7476
|
-
Defined in: [types/type.type.ts:21](https://github.com/hichchidev/hichchi/blob/
|
|
7472
|
+
Defined in: [types/type.type.ts:21](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/types/type.type.ts#L21)
|
|
7477
7473
|
|
|
7478
7474
|
Generic constructor type for creating class instances.
|
|
7479
7475
|
|
|
@@ -7561,7 +7557,7 @@ const instance = createInstance(MyService);
|
|
|
7561
7557
|
const CHARACTERS_TO_REMOVE: 2 = 2;
|
|
7562
7558
|
```
|
|
7563
7559
|
|
|
7564
|
-
Defined in: [constants/constants.ts:93](https://github.com/hichchidev/hichchi/blob/
|
|
7560
|
+
Defined in: [constants/constants.ts:93](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L93)
|
|
7565
7561
|
|
|
7566
7562
|
Number of characters to remove in string truncation operations
|
|
7567
7563
|
|
|
@@ -7596,7 +7592,7 @@ if (result.length > 0) {
|
|
|
7596
7592
|
const CONTEXT_MULTIPLIER: 2 = 2;
|
|
7597
7593
|
```
|
|
7598
7594
|
|
|
7599
|
-
Defined in: [constants/constants.ts:231](https://github.com/hichchidev/hichchi/blob/
|
|
7595
|
+
Defined in: [constants/constants.ts:231](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L231)
|
|
7600
7596
|
|
|
7601
7597
|
Multiplier for adjusting context length in excerpts
|
|
7602
7598
|
|
|
@@ -7636,7 +7632,7 @@ function getFirstPart(text: string): string {
|
|
|
7636
7632
|
const DEFAULT_BREAK_CHAR: "\n" = "\n";
|
|
7637
7633
|
```
|
|
7638
7634
|
|
|
7639
|
-
Defined in: [constants/constants.ts:147](https://github.com/hichchidev/hichchi/blob/
|
|
7635
|
+
Defined in: [constants/constants.ts:147](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L147)
|
|
7640
7636
|
|
|
7641
7637
|
Default line break character for word wrapping
|
|
7642
7638
|
|
|
@@ -7666,7 +7662,7 @@ const wrappedText =
|
|
|
7666
7662
|
const DEFAULT_CONTEXT_LENGTH: 40 = 40;
|
|
7667
7663
|
```
|
|
7668
7664
|
|
|
7669
|
-
Defined in: [constants/constants.ts:177](https://github.com/hichchidev/hichchi/blob/
|
|
7665
|
+
Defined in: [constants/constants.ts:177](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L177)
|
|
7670
7666
|
|
|
7671
7667
|
Default context length for text excerpts
|
|
7672
7668
|
|
|
@@ -7710,7 +7706,7 @@ function generateExcerpt(text: string, searchTerm: string): string {
|
|
|
7710
7706
|
const DEFAULT_ELLIPSIS: "..." = "...";
|
|
7711
7707
|
```
|
|
7712
7708
|
|
|
7713
|
-
Defined in: [constants/constants.ts:201](https://github.com/hichchidev/hichchi/blob/
|
|
7709
|
+
Defined in: [constants/constants.ts:201](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L201)
|
|
7714
7710
|
|
|
7715
7711
|
Default ellipsis string for indicating truncated text
|
|
7716
7712
|
|
|
@@ -7746,7 +7742,7 @@ const truncated = truncate(longText, 20);
|
|
|
7746
7742
|
const DEFAULT_LINE_LENGTH: 80 = 80;
|
|
7747
7743
|
```
|
|
7748
7744
|
|
|
7749
|
-
Defined in: [constants/constants.ts:129](https://github.com/hichchidev/hichchi/blob/
|
|
7745
|
+
Defined in: [constants/constants.ts:129](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L129)
|
|
7750
7746
|
|
|
7751
7747
|
Default maximum line length for word wrapping
|
|
7752
7748
|
|
|
@@ -7796,7 +7792,7 @@ function wrapText(
|
|
|
7796
7792
|
const EnglishInflectionRules: InflectionRuleCategories;
|
|
7797
7793
|
```
|
|
7798
7794
|
|
|
7799
|
-
Defined in: [constants/english-inflection-rules.ts:55](https://github.com/hichchidev/hichchi/blob/
|
|
7795
|
+
Defined in: [constants/english-inflection-rules.ts:55](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/english-inflection-rules.ts#L55)
|
|
7800
7796
|
|
|
7801
7797
|
Comprehensive rules for English word inflection (singular/plural transformations)
|
|
7802
7798
|
|
|
@@ -7860,7 +7856,7 @@ function plural(word: string): string {
|
|
|
7860
7856
|
const HEX_PADDING_CHAR: "0" = "0";
|
|
7861
7857
|
```
|
|
7862
7858
|
|
|
7863
|
-
Defined in: [constants/constants.ts:66](https://github.com/hichchidev/hichchi/blob/
|
|
7859
|
+
Defined in: [constants/constants.ts:66](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L66)
|
|
7864
7860
|
|
|
7865
7861
|
Character used for padding hexadecimal strings
|
|
7866
7862
|
|
|
@@ -7893,7 +7889,7 @@ const paddedHex = hexValue.padStart(HEX_PADDING_LENGTH, HEX_PADDING_CHAR);
|
|
|
7893
7889
|
const HEX_PADDING_LENGTH: 2 = 2;
|
|
7894
7890
|
```
|
|
7895
7891
|
|
|
7896
|
-
Defined in: [constants/constants.ts:43](https://github.com/hichchidev/hichchi/blob/
|
|
7892
|
+
Defined in: [constants/constants.ts:43](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L43)
|
|
7897
7893
|
|
|
7898
7894
|
Minimum length for padded hexadecimal strings
|
|
7899
7895
|
|
|
@@ -7928,7 +7924,7 @@ const hexByte = byteValue
|
|
|
7928
7924
|
const HEX_RADIX: 16 = 16;
|
|
7929
7925
|
```
|
|
7930
7926
|
|
|
7931
|
-
Defined in: [constants/constants.ts:20](https://github.com/hichchidev/hichchi/blob/
|
|
7927
|
+
Defined in: [constants/constants.ts:20](https://github.com/hichchidev/hichchi/blob/70fdee7ca8f6cceb9fa71d5e5e1eadc76e3aba50/libs/utils/src/lib/constants/constants.ts#L20)
|
|
7932
7928
|
|
|
7933
7929
|
Base for hexadecimal number conversion
|
|
7934
7930
|
|