typia 5.2.0 → 5.2.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/src/misc.ts CHANGED
@@ -1,651 +1,651 @@
1
- /* ===========================================================
2
- MISCELLAENOUS
3
- - LITERALS
4
- - CLONE
5
- - PRUNE
6
- - FACTORY FUNCTIONS
7
- ==============================================================
8
- LITERALS
9
- ----------------------------------------------------------- */
10
- import { Namespace } from "./functional/Namespace";
11
-
12
- import { Atomic } from "./typings/Atomic";
13
-
14
- import { IValidation } from "./IValidation";
15
- import { Resolved } from "./Resolved";
16
-
17
- /**
18
- * > You must configure the generic argument `T`.
19
- *
20
- * Union literal type to array.
21
- *
22
- * Converts a union literal type to an array of its members.
23
- *
24
- * ```typescript
25
- * literals<"A" | "B" | 1>; // ["A", "B", 1]
26
- * ```
27
- *
28
- * @template T Union literal type
29
- * @return Array of union literal type's members
30
- *
31
- * @author Jeongho Nam - https://github.com/samchon
32
- */
33
- export function literals(): never;
34
-
35
- /**
36
- * Union literal type to array.
37
- *
38
- * Converts a union literal type to an array of its members.
39
- *
40
- * ```typescript
41
- * literals<"A" | "B" | 1>; // ["A", "B", 1]
42
- * ```
43
- *
44
- * @template T Union literal type
45
- * @return Array of union literal type's members
46
- *
47
- * @author Jeongho Nam - https://github.com/samchon
48
- */
49
- export function literals<T extends Atomic.Type | null>(): T[];
50
-
51
- /**
52
- * @internal
53
- */
54
- export function literals(): never {
55
- halt("literals");
56
- }
57
-
58
- /* -----------------------------------------------------------
59
- CLONE
60
- ----------------------------------------------------------- */
61
- /**
62
- * Clone a data.
63
- *
64
- * Clones an instance following type `T`. If the target *input* value or its member
65
- * variable contains a class instance having methods, those methods would not be
66
- * cloned.
67
- *
68
- * For reference, this `typia.misc.clone()` function does not validate the input value
69
- * type. It just believes that the input value is following the type `T`. Therefore,
70
- * if you can't ensure the input value type, it would be better to call
71
- * {@link assertClone} function instead.
72
- *
73
- * @template T Type of the input value
74
- * @param input A value to be cloned
75
- * @return Cloned data
76
- *
77
- * @author Jeongho Nam - https://github.com/samchon
78
- */
79
- export function clone<T>(input: T): Resolved<T>;
80
-
81
- /**
82
- * @internal
83
- */
84
- export function clone(): never {
85
- halt("clone");
86
- }
87
- Object.assign(clone, Namespace.misc.clone("clone"));
88
-
89
- /**
90
- * Clone a data with type assertion.
91
- *
92
- * Clones an instance following type `T`, with type assertion. If the target `input`
93
- * value or its member variable contains a class instance having methods, those
94
- * methods would not be cloned.
95
- *
96
- * In such reason, when `input` value is not matched with the type `T`, it throws an
97
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, cloned
98
- * data would be returned.
99
- *
100
- * @template T Type of the input value
101
- * @param input A value to be cloned
102
- * @return Cloned data
103
- *
104
- * @author Jeongho Nam - https://github.com/samchon
105
- */
106
- export function assertClone<T>(input: T): Resolved<T>;
107
-
108
- /**
109
- * Clone a data with type assertion.
110
- *
111
- * Clones an instance following type `T`, with type assertion. If the target `input`
112
- * value or its member variable contains a class instance having methods, those
113
- * methods would not be cloned.
114
- *
115
- * In such reason, when `input` value is not matched with the type `T`, it throws an
116
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, cloned
117
- * data would be returned.
118
- *
119
- * @template T Type of the input value
120
- * @param input A value to be cloned
121
- * @return Cloned data
122
- *
123
- * @author Jeongho Nam - https://github.com/samchon
124
- */
125
- export function assertClone<T>(input: unknown): Resolved<T>;
126
-
127
- /**
128
- * @internal
129
- */
130
- export function assertClone(): never {
131
- halt("assertClone");
132
- }
133
- Object.assign(assertClone, Namespace.assert("misc.assertClone"));
134
- Object.assign(assertClone, Namespace.misc.clone("assertClone"));
135
-
136
- /**
137
- * Clone a data with type checking.
138
- *
139
- * Clones an instance following type `T`, with type checking. If the target `input`
140
- * value or its member variable contains a class instance having methods, those
141
- * methods would not be cloned.
142
- *
143
- * In such reason, when `input` value is not matched with the type `T`, it returns
144
- * `null` value instead. Otherwise, there's no problem on the `input` value, cloned
145
- * data would be returned.
146
- *
147
- * @template T Type of the input value
148
- * @param input A value to be cloned
149
- * @return Cloned data when exact type, otherwise null
150
- *
151
- * @author Jeongho Nam - https://github.com/samchon
152
- */
153
- export function isClone<T>(input: T): Resolved<T> | null;
154
-
155
- /**
156
- * Clone a data with type checking.
157
- *
158
- * Clones an instance following type `T`, with type checking. If the target `input`
159
- * value or its member variable contains a class instance having methods, those
160
- * methods would not be cloned.
161
- *
162
- * In such reason, when `input` value is not matched with the type `T`, it returns
163
- * `null` value instead. Otherwise, there's no problem on the `input` value, cloned
164
- * data would be returned.
165
- *
166
- * @template T Type of the input value
167
- * @param input A value to be cloned
168
- * @return Cloned data when exact type, otherwise null
169
- *
170
- * @author Jeongho Nam - https://github.com/samchon
171
- */
172
- export function isClone<T>(input: unknown): Resolved<T> | null;
173
-
174
- /**
175
- * @internal
176
- */
177
- export function isClone(): never {
178
- halt("isClone");
179
- }
180
- Object.assign(isClone, Namespace.is());
181
- Object.assign(isClone, Namespace.misc.clone("isClone"));
182
-
183
- /**
184
- * Clone a data with detailed type validation.
185
- *
186
- * Clones an instance following type `T`, with detailed type validation. If the target
187
- * `input` value or its member variable contains a class instance having methods,
188
- * those methods would not be cloned.
189
- *
190
- * In such reason, when `input` value is not matched with the type `T`, it returns
191
- * {@link IValidation.Failure} value. Otherwise, there's no problem on the `input`
192
- * value, cloned data would be stored in `data` property of the output
193
- * {@link IValidation.Success} instance.
194
- *
195
- * @template T Type of the input value
196
- * @param input A value to be cloned
197
- * @returns Validation result with cloned value
198
- */
199
- export function validateClone<T>(input: T): IValidation<Resolved<T>>;
200
-
201
- /**
202
- * Clone a data with detailed type validation.
203
- *
204
- * Clones an instance following type `T`, with detailed type validation. If the target
205
- * `input` value or its member variable contains a class instance having methods,
206
- * those methods would not be cloned.
207
- *
208
- * In such reason, when `input` value is not matched with the type `T`, it returns
209
- * {@link IValidation.Failure} value. Otherwise, there's no problem on the `input`
210
- * value, cloned data would be stored in `data` property of the output
211
- * {@link IValidation.Success} instance.
212
- *
213
- * @template T Type of the input value
214
- * @param input A value to be cloned
215
- * @returns Validation result with cloned value
216
- */
217
- export function validateClone<T>(input: unknown): IValidation<Resolved<T>>;
218
-
219
- /**
220
- * @internal
221
- */
222
- export function validateClone(): never {
223
- halt("validateClone");
224
- }
225
- Object.assign(validateClone, Namespace.validate());
226
- Object.assign(validateClone, Namespace.misc.clone("validateClone"));
227
-
228
- /* -----------------------------------------------------------
229
- PRUNE
230
- ----------------------------------------------------------- */
231
- /**
232
- * Prune, erase superfluous properties.
233
- *
234
- * Remove every superfluous properties from the `input` object, even including nested
235
- * objects. Note that, as every superfluous properties would be deleted, you never can
236
- * read those superfluous properties after calling this `prune()` function.
237
- *
238
- * For reference, this `typia.misc.prune()` function does not validate the input value
239
- * type. It just believes that the input value is following the type `T`. Therefore,
240
- * if you can't ensure the input value type, it would better to call one of below
241
- * functions instead.
242
- *
243
- * - {@link assertPrune}
244
- * - {@link isPrune}
245
- * - {@link validatePrune}
246
- *
247
- * @template T Type of the input value
248
- * @param input Target instance to prune
249
- *
250
- * @author Jeongho Nam - https://github.com/samchon
251
- */
252
- export function prune<T extends object>(input: T): void;
253
-
254
- /**
255
- * @internal
256
- */
257
- export function prune(): never {
258
- halt("prune");
259
- }
260
- Object.assign(prune, Namespace.misc.prune("prune"));
261
-
262
- /**
263
- * Prune, erase superfluous properties, with type assertion.
264
- *
265
- * `typia.misc.assertPrune()` is a combination function of {@link assert} and
266
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
267
- * object including nested objects, with type assertion.
268
- *
269
- * In such reason, when `input` value is not matched with the type `T`, it throws an
270
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, its
271
- * every superfluous properties would be removed, including nested objects.
272
- *
273
- * @template T Type of the input value
274
- * @param input Target instance to assert and prune
275
- *
276
- * @author Jeongho Nam - https://github.com/samchon
277
- */
278
- export function assertPrune<T>(input: T): T;
279
-
280
- /**
281
- * Prune, erase superfluous properties, with type assertion.
282
- *
283
- * `typia.misc.assertPrune()` is a combination function of {@link assert} and
284
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
285
- * object including nested objects, with type assertion.
286
- *
287
- * In such reason, when `input` value is not matched with the type `T`, it throws an
288
- * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, its
289
- * every superfluous properties would be removed, including nested objects.
290
- *
291
- * @template T Type of the input value
292
- * @param input Target instance to assert and prune
293
- *
294
- * @author Jeongho Nam - https://github.com/samchon
295
- */
296
- export function assertPrune<T>(input: unknown): T;
297
-
298
- /**
299
- * @internal
300
- */
301
- export function assertPrune(): unknown {
302
- halt("assertPrune");
303
- }
304
- Object.assign(assertPrune, Namespace.assert("misc.assertPrune"));
305
- Object.assign(assertPrune, Namespace.misc.prune("assertPrune"));
306
-
307
- /**
308
- * Prune, erase superfluous properties, with type checking.
309
- *
310
- * `typia.misc.assertPrune()` is a combination function of {@link is} and
311
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
312
- * object including nested objects, with type checking.
313
- *
314
- * In such reason, when `input` value is not matched with the type `T`, it returns
315
- * `false` value. Otherwise, there's no problem on the `input` value, it returns
316
- * `true` after removing every superfluous properties, including nested objects.
317
- *
318
- * @template T Type of the input value
319
- * @param input Target instance to check and prune
320
- * @returns Whether the parametric value is following the type `T` or not
321
- *
322
- * @author Jeongho Nam - https://github.com/samchon
323
- */
324
- export function isPrune<T>(input: T): input is T;
325
-
326
- /**
327
- * Prune, erase superfluous properties, with type checking.
328
- *
329
- * `typia.misc.assertPrune()` is a combination function of {@link is} and
330
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
331
- * object including nested objects, with type checking.
332
- *
333
- * In such reason, when `input` value is not matched with the type `T`, it returns
334
- * `false` value. Otherwise, there's no problem on the `input` value, it returns
335
- * `true` after removing every superfluous properties, including nested objects.
336
- *
337
- * @template T Type of the input value
338
- * @param input Target instance to check and prune
339
- * @returns Whether the parametric value is following the type `T` or not
340
- *
341
- * @author Jeongho Nam - https://github.com/samchon
342
- */
343
- export function isPrune<T>(input: unknown): input is T;
344
-
345
- /**
346
- * @internal
347
- */
348
- export function isPrune(): never {
349
- halt("isPrune");
350
- }
351
- Object.assign(isPrune, Namespace.is());
352
- Object.assign(isPrune, Namespace.misc.prune("isPrune"));
353
-
354
- /**
355
- * Prune, erase superfluous properties, with type validation.
356
- *
357
- * `typia.misc.validatePrune()` is a combination function of {@link validate} and
358
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
359
- * object including nested objects, with type validation.
360
- *
361
- * In such reason, when `input` value is not matched with the type `T`, it returns
362
- * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
363
- * no problem on the `input` value, it returns {@link IValidation.ISucess} value after
364
- * removing every superfluous properties, including nested objects.
365
- *
366
- * @template T Type of the input value
367
- * @param input Target instance to validate and prune
368
- * @returns Validation result
369
- *
370
- * @author Jeongho Nam - https://github.com/samchon
371
- */
372
- export function validatePrune<T>(input: T): IValidation<T>;
373
-
374
- /**
375
- * Prune, erase superfluous properties, with type validation.
376
- *
377
- * `typia.misc.validatePrune()` is a combination function of {@link validate} and
378
- * {@link prune}. Therefore, it removes every superfluous properties from the `input`
379
- * object including nested objects, with type validation.
380
- *
381
- * In such reason, when `input` value is not matched with the type `T`, it returns
382
- * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
383
- * no problem on the `input` value, it returns {@link IValidation.ISucess} value after
384
- * removing every superfluous properties, including nested objects.
385
- *
386
- * @template T Type of the input value
387
- * @param input Target instance to validate and prune
388
- * @returns Validation result
389
- *
390
- * @author Jeongho Nam - https://github.com/samchon
391
- */
392
- export function validatePrune<T>(input: unknown): IValidation<T>;
393
-
394
- /**
395
- * @internal
396
- */
397
- export function validatePrune<T>(): IValidation<T> {
398
- halt("validatePrune");
399
- }
400
- Object.assign(validatePrune, Namespace.misc.prune("validatePrune"));
401
- Object.assign(validatePrune, Namespace.validate());
402
-
403
- /* -----------------------------------------------------------
404
- FACTORY FUNCTIONS
405
- ----------------------------------------------------------- */
406
- /**
407
- * Creates a reusable {@link clone} function.
408
- *
409
- * @danger You must configure the generic argument `T`
410
- * @returns Nothing until you configure the generic argument `T`
411
- * @throws compile error
412
- *
413
- * @author Jeongho Nam - https://github.com/samchon
414
- */
415
- export function createClone(): never;
416
-
417
- /**
418
- * Creates a resuable {@link clone} function.
419
- *
420
- * @template T Type of the input value
421
- * @returns A reusable `clone` function
422
- *
423
- * @author Jeongho Nam - https://github.com/samchon
424
- */
425
- export function createClone<T>(): (input: T) => Resolved<T>;
426
-
427
- /**
428
- * @internal
429
- */
430
- export function createClone(): never {
431
- halt("createClone");
432
- }
433
- Object.assign(createClone, clone);
434
-
435
- /**
436
- * Creates a reusable {@link assertClone} function.
437
- *
438
- * @danger You must configure the generic argument `T`
439
- * @returns Nothing until you configure the generic argument `T`
440
- * @throws compile error
441
- *
442
- * @author Jeongho Nam - https://github.com/samchon
443
- */
444
- export function createAssertClone(): never;
445
-
446
- /**
447
- * Creates a resuable {@link assertClone} function.
448
- *
449
- * @template T Type of the input value
450
- * @returns A reusable `clone` function
451
- *
452
- * @author Jeongho Nam - https://github.com/samchon
453
- */
454
- export function createAssertClone<T>(): (input: unknown) => Resolved<T>;
455
-
456
- /**
457
- * @internal
458
- */
459
- export function createAssertClone(): never {
460
- halt("createAssertClone");
461
- }
462
- Object.assign(createAssertClone, assertClone);
463
-
464
- /**
465
- * Creates a reusable {@link isClone} function.
466
- *
467
- * @danger You must configure the generic argument `T`
468
- * @returns Nothing until you configure the generic argument `T`
469
- * @throws compile error
470
- *
471
- * @author Jeongho Nam - https://github.com/samchon
472
- */
473
- export function createIsClone(): never;
474
-
475
- /**
476
- * Creates a resuable {@link isClone} function.
477
- *
478
- * @template T Type of the input value
479
- * @returns A reusable `clone` function
480
- *
481
- * @author Jeongho Nam - https://github.com/samchon
482
- */
483
- export function createIsClone<T>(): (input: unknown) => Resolved<T> | null;
484
-
485
- /**
486
- * @internal
487
- */
488
- export function createIsClone(): never {
489
- halt("createIsClone");
490
- }
491
- Object.assign(createIsClone, isClone);
492
-
493
- /**
494
- * Creates a reusable {@link validateClone} function.
495
- *
496
- * @danger You must configure the generic argument `T`
497
- * @returns Nothing until you configure the generic argument `T`
498
- * @throws compile error
499
- *
500
- * @author Jeongho Nam - https://github.com/samchon
501
- */
502
- export function createValidateClone(): never;
503
-
504
- /**
505
- * Creates a resuable {@link validateClone} function.
506
- *
507
- * @template T Type of the input value
508
- * @returns A reusable `clone` function
509
- *
510
- * @author Jeongho Nam - https://github.com/samchon
511
- */
512
- export function createValidateClone<T>(): (
513
- input: unknown,
514
- ) => IValidation<Resolved<T>>;
515
-
516
- /**
517
- * @internal
518
- */
519
- export function createValidateClone(): never {
520
- halt("createValidateClone");
521
- }
522
- Object.assign(createValidateClone, validateClone);
523
-
524
- /**
525
- * Creates a reusable {@link prune} function.
526
- *
527
- * @danger You must configure the generic argument `T`
528
- * @returns Nothing until you configure the generic argument `T`
529
- * @throws compile error
530
- *
531
- * @author Jeongho Nam - https://github.com/samchon
532
- */
533
- export function createPrune(): never;
534
-
535
- /**
536
- * Creates a resuable {@link prune} function.
537
- *
538
- * @template T Type of the input value
539
- * @returns A reusable `prune` function
540
- *
541
- * @author Jeongho Nam - https://github.com/samchon
542
- */
543
- export function createPrune<T extends object>(): (input: T) => void;
544
-
545
- /**
546
- * @internal
547
- */
548
- export function createPrune<T extends object>(): (input: T) => void {
549
- halt("createPrune");
550
- }
551
- Object.assign(createPrune, prune);
552
-
553
- /**
554
- * Creates a reusable {@link assertPrune} function.
555
- *
556
- * @danger You must configure the generic argument `T`
557
- * @returns Nothing until you configure the generic argument `T`
558
- * @throws compile error
559
- *
560
- * @author Jeongho Nam - https://github.com/samchon
561
- */
562
- export function createAssertPrune(): never;
563
-
564
- /**
565
- * Creates a resuable {@link assertPrune} function.
566
- *
567
- * @template T Type of the input value
568
- * @returns A reusable `isPrune` function
569
- *
570
- * @author Jeongho Nam - https://github.com/samchon
571
- */
572
- export function createAssertPrune<T extends object>(): (input: T) => T;
573
-
574
- /**
575
- * @internal
576
- */
577
- export function createAssertPrune<T extends object>(): (input: T) => T {
578
- halt("createAssertPrune");
579
- }
580
- Object.assign(createAssertPrune, assertPrune);
581
-
582
- /**
583
- * Creates a reusable {@link isPrune} function.
584
- *
585
- * @danger You must configure the generic argument `T`
586
- * @returns Nothing until you configure the generic argument `T`
587
- * @throws compile error
588
- *
589
- * @author Jeongho Nam - https://github.com/samchon
590
- */
591
- export function createIsPrune(): never;
592
-
593
- /**
594
- * Creates a resuable {@link isPrune} function.
595
- *
596
- * @template T Type of the input value
597
- * @returns A reusable `isPrune` function
598
- *
599
- * @author Jeongho Nam - https://github.com/samchon
600
- */
601
- export function createIsPrune<T extends object>(): (input: T) => input is T;
602
-
603
- /**
604
- * @internal
605
- */
606
- export function createIsPrune<T extends object>(): (input: T) => input is T {
607
- halt("createIsPrune");
608
- }
609
- Object.assign(createIsPrune, isPrune);
610
-
611
- /**
612
- * Creates a reusable {@link validatePrune} function.
613
- *
614
- * @danger You must configure the generic argument `T`
615
- * @returns Nothing until you configure the generic argument `T`
616
- * @throws compile error
617
- *
618
- * @author Jeongho Nam - https://github.com/samchon
619
- */
620
- export function createValidatePrune(): never;
621
-
622
- /**
623
- * Creates a resuable {@link validatePrune} function.
624
- *
625
- * @template T Type of the input value
626
- * @returns A reusable `validatePrune` function
627
- *
628
- * @author Jeongho Nam - https://github.com/samchon
629
- */
630
- export function createValidatePrune<T extends object>(): (
631
- input: T,
632
- ) => IValidation<T>;
633
-
634
- /**
635
- * @internal
636
- */
637
- export function createValidatePrune<T extends object>(): (
638
- input: T,
639
- ) => IValidation<T> {
640
- halt("createValidatePrune");
641
- }
642
- Object.assign(createValidatePrune, validatePrune);
643
-
644
- /**
645
- * @internal
646
- */
647
- function halt(name: string): never {
648
- throw new Error(
649
- `Error on typia.misc.${name}(): no transform has been configured. Read and follow https://typia.misc.io/docs/setup please.`,
650
- );
651
- }
1
+ /* ===========================================================
2
+ MISCELLAENOUS
3
+ - LITERALS
4
+ - CLONE
5
+ - PRUNE
6
+ - FACTORY FUNCTIONS
7
+ ==============================================================
8
+ LITERALS
9
+ ----------------------------------------------------------- */
10
+ import { Namespace } from "./functional/Namespace";
11
+
12
+ import { Atomic } from "./typings/Atomic";
13
+
14
+ import { IValidation } from "./IValidation";
15
+ import { Resolved } from "./Resolved";
16
+
17
+ /**
18
+ * > You must configure the generic argument `T`.
19
+ *
20
+ * Union literal type to array.
21
+ *
22
+ * Converts a union literal type to an array of its members.
23
+ *
24
+ * ```typescript
25
+ * literals<"A" | "B" | 1>; // ["A", "B", 1]
26
+ * ```
27
+ *
28
+ * @template T Union literal type
29
+ * @return Array of union literal type's members
30
+ *
31
+ * @author Jeongho Nam - https://github.com/samchon
32
+ */
33
+ export function literals(): never;
34
+
35
+ /**
36
+ * Union literal type to array.
37
+ *
38
+ * Converts a union literal type to an array of its members.
39
+ *
40
+ * ```typescript
41
+ * literals<"A" | "B" | 1>; // ["A", "B", 1]
42
+ * ```
43
+ *
44
+ * @template T Union literal type
45
+ * @return Array of union literal type's members
46
+ *
47
+ * @author Jeongho Nam - https://github.com/samchon
48
+ */
49
+ export function literals<T extends Atomic.Type | null>(): T[];
50
+
51
+ /**
52
+ * @internal
53
+ */
54
+ export function literals(): never {
55
+ halt("literals");
56
+ }
57
+
58
+ /* -----------------------------------------------------------
59
+ CLONE
60
+ ----------------------------------------------------------- */
61
+ /**
62
+ * Clone a data.
63
+ *
64
+ * Clones an instance following type `T`. If the target *input* value or its member
65
+ * variable contains a class instance having methods, those methods would not be
66
+ * cloned.
67
+ *
68
+ * For reference, this `typia.misc.clone()` function does not validate the input value
69
+ * type. It just believes that the input value is following the type `T`. Therefore,
70
+ * if you can't ensure the input value type, it would be better to call
71
+ * {@link assertClone} function instead.
72
+ *
73
+ * @template T Type of the input value
74
+ * @param input A value to be cloned
75
+ * @return Cloned data
76
+ *
77
+ * @author Jeongho Nam - https://github.com/samchon
78
+ */
79
+ export function clone<T>(input: T): Resolved<T>;
80
+
81
+ /**
82
+ * @internal
83
+ */
84
+ export function clone(): never {
85
+ halt("clone");
86
+ }
87
+ Object.assign(clone, Namespace.misc.clone("clone"));
88
+
89
+ /**
90
+ * Clone a data with type assertion.
91
+ *
92
+ * Clones an instance following type `T`, with type assertion. If the target `input`
93
+ * value or its member variable contains a class instance having methods, those
94
+ * methods would not be cloned.
95
+ *
96
+ * In such reason, when `input` value is not matched with the type `T`, it throws an
97
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, cloned
98
+ * data would be returned.
99
+ *
100
+ * @template T Type of the input value
101
+ * @param input A value to be cloned
102
+ * @return Cloned data
103
+ *
104
+ * @author Jeongho Nam - https://github.com/samchon
105
+ */
106
+ export function assertClone<T>(input: T): Resolved<T>;
107
+
108
+ /**
109
+ * Clone a data with type assertion.
110
+ *
111
+ * Clones an instance following type `T`, with type assertion. If the target `input`
112
+ * value or its member variable contains a class instance having methods, those
113
+ * methods would not be cloned.
114
+ *
115
+ * In such reason, when `input` value is not matched with the type `T`, it throws an
116
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, cloned
117
+ * data would be returned.
118
+ *
119
+ * @template T Type of the input value
120
+ * @param input A value to be cloned
121
+ * @return Cloned data
122
+ *
123
+ * @author Jeongho Nam - https://github.com/samchon
124
+ */
125
+ export function assertClone<T>(input: unknown): Resolved<T>;
126
+
127
+ /**
128
+ * @internal
129
+ */
130
+ export function assertClone(): never {
131
+ halt("assertClone");
132
+ }
133
+ Object.assign(assertClone, Namespace.assert("misc.assertClone"));
134
+ Object.assign(assertClone, Namespace.misc.clone("assertClone"));
135
+
136
+ /**
137
+ * Clone a data with type checking.
138
+ *
139
+ * Clones an instance following type `T`, with type checking. If the target `input`
140
+ * value or its member variable contains a class instance having methods, those
141
+ * methods would not be cloned.
142
+ *
143
+ * In such reason, when `input` value is not matched with the type `T`, it returns
144
+ * `null` value instead. Otherwise, there's no problem on the `input` value, cloned
145
+ * data would be returned.
146
+ *
147
+ * @template T Type of the input value
148
+ * @param input A value to be cloned
149
+ * @return Cloned data when exact type, otherwise null
150
+ *
151
+ * @author Jeongho Nam - https://github.com/samchon
152
+ */
153
+ export function isClone<T>(input: T): Resolved<T> | null;
154
+
155
+ /**
156
+ * Clone a data with type checking.
157
+ *
158
+ * Clones an instance following type `T`, with type checking. If the target `input`
159
+ * value or its member variable contains a class instance having methods, those
160
+ * methods would not be cloned.
161
+ *
162
+ * In such reason, when `input` value is not matched with the type `T`, it returns
163
+ * `null` value instead. Otherwise, there's no problem on the `input` value, cloned
164
+ * data would be returned.
165
+ *
166
+ * @template T Type of the input value
167
+ * @param input A value to be cloned
168
+ * @return Cloned data when exact type, otherwise null
169
+ *
170
+ * @author Jeongho Nam - https://github.com/samchon
171
+ */
172
+ export function isClone<T>(input: unknown): Resolved<T> | null;
173
+
174
+ /**
175
+ * @internal
176
+ */
177
+ export function isClone(): never {
178
+ halt("isClone");
179
+ }
180
+ Object.assign(isClone, Namespace.is());
181
+ Object.assign(isClone, Namespace.misc.clone("isClone"));
182
+
183
+ /**
184
+ * Clone a data with detailed type validation.
185
+ *
186
+ * Clones an instance following type `T`, with detailed type validation. If the target
187
+ * `input` value or its member variable contains a class instance having methods,
188
+ * those methods would not be cloned.
189
+ *
190
+ * In such reason, when `input` value is not matched with the type `T`, it returns
191
+ * {@link IValidation.Failure} value. Otherwise, there's no problem on the `input`
192
+ * value, cloned data would be stored in `data` property of the output
193
+ * {@link IValidation.Success} instance.
194
+ *
195
+ * @template T Type of the input value
196
+ * @param input A value to be cloned
197
+ * @returns Validation result with cloned value
198
+ */
199
+ export function validateClone<T>(input: T): IValidation<Resolved<T>>;
200
+
201
+ /**
202
+ * Clone a data with detailed type validation.
203
+ *
204
+ * Clones an instance following type `T`, with detailed type validation. If the target
205
+ * `input` value or its member variable contains a class instance having methods,
206
+ * those methods would not be cloned.
207
+ *
208
+ * In such reason, when `input` value is not matched with the type `T`, it returns
209
+ * {@link IValidation.Failure} value. Otherwise, there's no problem on the `input`
210
+ * value, cloned data would be stored in `data` property of the output
211
+ * {@link IValidation.Success} instance.
212
+ *
213
+ * @template T Type of the input value
214
+ * @param input A value to be cloned
215
+ * @returns Validation result with cloned value
216
+ */
217
+ export function validateClone<T>(input: unknown): IValidation<Resolved<T>>;
218
+
219
+ /**
220
+ * @internal
221
+ */
222
+ export function validateClone(): never {
223
+ halt("validateClone");
224
+ }
225
+ Object.assign(validateClone, Namespace.validate());
226
+ Object.assign(validateClone, Namespace.misc.clone("validateClone"));
227
+
228
+ /* -----------------------------------------------------------
229
+ PRUNE
230
+ ----------------------------------------------------------- */
231
+ /**
232
+ * Prune, erase superfluous properties.
233
+ *
234
+ * Remove every superfluous properties from the `input` object, even including nested
235
+ * objects. Note that, as every superfluous properties would be deleted, you never can
236
+ * read those superfluous properties after calling this `prune()` function.
237
+ *
238
+ * For reference, this `typia.misc.prune()` function does not validate the input value
239
+ * type. It just believes that the input value is following the type `T`. Therefore,
240
+ * if you can't ensure the input value type, it would better to call one of below
241
+ * functions instead.
242
+ *
243
+ * - {@link assertPrune}
244
+ * - {@link isPrune}
245
+ * - {@link validatePrune}
246
+ *
247
+ * @template T Type of the input value
248
+ * @param input Target instance to prune
249
+ *
250
+ * @author Jeongho Nam - https://github.com/samchon
251
+ */
252
+ export function prune<T extends object>(input: T): void;
253
+
254
+ /**
255
+ * @internal
256
+ */
257
+ export function prune(): never {
258
+ halt("prune");
259
+ }
260
+ Object.assign(prune, Namespace.misc.prune("prune"));
261
+
262
+ /**
263
+ * Prune, erase superfluous properties, with type assertion.
264
+ *
265
+ * `typia.misc.assertPrune()` is a combination function of {@link assert} and
266
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
267
+ * object including nested objects, with type assertion.
268
+ *
269
+ * In such reason, when `input` value is not matched with the type `T`, it throws an
270
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, its
271
+ * every superfluous properties would be removed, including nested objects.
272
+ *
273
+ * @template T Type of the input value
274
+ * @param input Target instance to assert and prune
275
+ *
276
+ * @author Jeongho Nam - https://github.com/samchon
277
+ */
278
+ export function assertPrune<T>(input: T): T;
279
+
280
+ /**
281
+ * Prune, erase superfluous properties, with type assertion.
282
+ *
283
+ * `typia.misc.assertPrune()` is a combination function of {@link assert} and
284
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
285
+ * object including nested objects, with type assertion.
286
+ *
287
+ * In such reason, when `input` value is not matched with the type `T`, it throws an
288
+ * {@link TypeGuardError}. Otherwise, there's no problem on the `input` value, its
289
+ * every superfluous properties would be removed, including nested objects.
290
+ *
291
+ * @template T Type of the input value
292
+ * @param input Target instance to assert and prune
293
+ *
294
+ * @author Jeongho Nam - https://github.com/samchon
295
+ */
296
+ export function assertPrune<T>(input: unknown): T;
297
+
298
+ /**
299
+ * @internal
300
+ */
301
+ export function assertPrune(): unknown {
302
+ halt("assertPrune");
303
+ }
304
+ Object.assign(assertPrune, Namespace.assert("misc.assertPrune"));
305
+ Object.assign(assertPrune, Namespace.misc.prune("assertPrune"));
306
+
307
+ /**
308
+ * Prune, erase superfluous properties, with type checking.
309
+ *
310
+ * `typia.misc.assertPrune()` is a combination function of {@link is} and
311
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
312
+ * object including nested objects, with type checking.
313
+ *
314
+ * In such reason, when `input` value is not matched with the type `T`, it returns
315
+ * `false` value. Otherwise, there's no problem on the `input` value, it returns
316
+ * `true` after removing every superfluous properties, including nested objects.
317
+ *
318
+ * @template T Type of the input value
319
+ * @param input Target instance to check and prune
320
+ * @returns Whether the parametric value is following the type `T` or not
321
+ *
322
+ * @author Jeongho Nam - https://github.com/samchon
323
+ */
324
+ export function isPrune<T>(input: T): input is T;
325
+
326
+ /**
327
+ * Prune, erase superfluous properties, with type checking.
328
+ *
329
+ * `typia.misc.assertPrune()` is a combination function of {@link is} and
330
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
331
+ * object including nested objects, with type checking.
332
+ *
333
+ * In such reason, when `input` value is not matched with the type `T`, it returns
334
+ * `false` value. Otherwise, there's no problem on the `input` value, it returns
335
+ * `true` after removing every superfluous properties, including nested objects.
336
+ *
337
+ * @template T Type of the input value
338
+ * @param input Target instance to check and prune
339
+ * @returns Whether the parametric value is following the type `T` or not
340
+ *
341
+ * @author Jeongho Nam - https://github.com/samchon
342
+ */
343
+ export function isPrune<T>(input: unknown): input is T;
344
+
345
+ /**
346
+ * @internal
347
+ */
348
+ export function isPrune(): never {
349
+ halt("isPrune");
350
+ }
351
+ Object.assign(isPrune, Namespace.is());
352
+ Object.assign(isPrune, Namespace.misc.prune("isPrune"));
353
+
354
+ /**
355
+ * Prune, erase superfluous properties, with type validation.
356
+ *
357
+ * `typia.misc.validatePrune()` is a combination function of {@link validate} and
358
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
359
+ * object including nested objects, with type validation.
360
+ *
361
+ * In such reason, when `input` value is not matched with the type `T`, it returns
362
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
363
+ * no problem on the `input` value, it returns {@link IValidation.ISucess} value after
364
+ * removing every superfluous properties, including nested objects.
365
+ *
366
+ * @template T Type of the input value
367
+ * @param input Target instance to validate and prune
368
+ * @returns Validation result
369
+ *
370
+ * @author Jeongho Nam - https://github.com/samchon
371
+ */
372
+ export function validatePrune<T>(input: T): IValidation<T>;
373
+
374
+ /**
375
+ * Prune, erase superfluous properties, with type validation.
376
+ *
377
+ * `typia.misc.validatePrune()` is a combination function of {@link validate} and
378
+ * {@link prune}. Therefore, it removes every superfluous properties from the `input`
379
+ * object including nested objects, with type validation.
380
+ *
381
+ * In such reason, when `input` value is not matched with the type `T`, it returns
382
+ * {@link IValidation.IFailure} value with detailed error reasons. Otherwise, there's
383
+ * no problem on the `input` value, it returns {@link IValidation.ISucess} value after
384
+ * removing every superfluous properties, including nested objects.
385
+ *
386
+ * @template T Type of the input value
387
+ * @param input Target instance to validate and prune
388
+ * @returns Validation result
389
+ *
390
+ * @author Jeongho Nam - https://github.com/samchon
391
+ */
392
+ export function validatePrune<T>(input: unknown): IValidation<T>;
393
+
394
+ /**
395
+ * @internal
396
+ */
397
+ export function validatePrune<T>(): IValidation<T> {
398
+ halt("validatePrune");
399
+ }
400
+ Object.assign(validatePrune, Namespace.misc.prune("validatePrune"));
401
+ Object.assign(validatePrune, Namespace.validate());
402
+
403
+ /* -----------------------------------------------------------
404
+ FACTORY FUNCTIONS
405
+ ----------------------------------------------------------- */
406
+ /**
407
+ * Creates a reusable {@link clone} function.
408
+ *
409
+ * @danger You must configure the generic argument `T`
410
+ * @returns Nothing until you configure the generic argument `T`
411
+ * @throws compile error
412
+ *
413
+ * @author Jeongho Nam - https://github.com/samchon
414
+ */
415
+ export function createClone(): never;
416
+
417
+ /**
418
+ * Creates a resuable {@link clone} function.
419
+ *
420
+ * @template T Type of the input value
421
+ * @returns A reusable `clone` function
422
+ *
423
+ * @author Jeongho Nam - https://github.com/samchon
424
+ */
425
+ export function createClone<T>(): (input: T) => Resolved<T>;
426
+
427
+ /**
428
+ * @internal
429
+ */
430
+ export function createClone(): never {
431
+ halt("createClone");
432
+ }
433
+ Object.assign(createClone, clone);
434
+
435
+ /**
436
+ * Creates a reusable {@link assertClone} function.
437
+ *
438
+ * @danger You must configure the generic argument `T`
439
+ * @returns Nothing until you configure the generic argument `T`
440
+ * @throws compile error
441
+ *
442
+ * @author Jeongho Nam - https://github.com/samchon
443
+ */
444
+ export function createAssertClone(): never;
445
+
446
+ /**
447
+ * Creates a resuable {@link assertClone} function.
448
+ *
449
+ * @template T Type of the input value
450
+ * @returns A reusable `clone` function
451
+ *
452
+ * @author Jeongho Nam - https://github.com/samchon
453
+ */
454
+ export function createAssertClone<T>(): (input: unknown) => Resolved<T>;
455
+
456
+ /**
457
+ * @internal
458
+ */
459
+ export function createAssertClone(): never {
460
+ halt("createAssertClone");
461
+ }
462
+ Object.assign(createAssertClone, assertClone);
463
+
464
+ /**
465
+ * Creates a reusable {@link isClone} function.
466
+ *
467
+ * @danger You must configure the generic argument `T`
468
+ * @returns Nothing until you configure the generic argument `T`
469
+ * @throws compile error
470
+ *
471
+ * @author Jeongho Nam - https://github.com/samchon
472
+ */
473
+ export function createIsClone(): never;
474
+
475
+ /**
476
+ * Creates a resuable {@link isClone} function.
477
+ *
478
+ * @template T Type of the input value
479
+ * @returns A reusable `clone` function
480
+ *
481
+ * @author Jeongho Nam - https://github.com/samchon
482
+ */
483
+ export function createIsClone<T>(): (input: unknown) => Resolved<T> | null;
484
+
485
+ /**
486
+ * @internal
487
+ */
488
+ export function createIsClone(): never {
489
+ halt("createIsClone");
490
+ }
491
+ Object.assign(createIsClone, isClone);
492
+
493
+ /**
494
+ * Creates a reusable {@link validateClone} function.
495
+ *
496
+ * @danger You must configure the generic argument `T`
497
+ * @returns Nothing until you configure the generic argument `T`
498
+ * @throws compile error
499
+ *
500
+ * @author Jeongho Nam - https://github.com/samchon
501
+ */
502
+ export function createValidateClone(): never;
503
+
504
+ /**
505
+ * Creates a resuable {@link validateClone} function.
506
+ *
507
+ * @template T Type of the input value
508
+ * @returns A reusable `clone` function
509
+ *
510
+ * @author Jeongho Nam - https://github.com/samchon
511
+ */
512
+ export function createValidateClone<T>(): (
513
+ input: unknown,
514
+ ) => IValidation<Resolved<T>>;
515
+
516
+ /**
517
+ * @internal
518
+ */
519
+ export function createValidateClone(): never {
520
+ halt("createValidateClone");
521
+ }
522
+ Object.assign(createValidateClone, validateClone);
523
+
524
+ /**
525
+ * Creates a reusable {@link prune} function.
526
+ *
527
+ * @danger You must configure the generic argument `T`
528
+ * @returns Nothing until you configure the generic argument `T`
529
+ * @throws compile error
530
+ *
531
+ * @author Jeongho Nam - https://github.com/samchon
532
+ */
533
+ export function createPrune(): never;
534
+
535
+ /**
536
+ * Creates a resuable {@link prune} function.
537
+ *
538
+ * @template T Type of the input value
539
+ * @returns A reusable `prune` function
540
+ *
541
+ * @author Jeongho Nam - https://github.com/samchon
542
+ */
543
+ export function createPrune<T extends object>(): (input: T) => void;
544
+
545
+ /**
546
+ * @internal
547
+ */
548
+ export function createPrune<T extends object>(): (input: T) => void {
549
+ halt("createPrune");
550
+ }
551
+ Object.assign(createPrune, prune);
552
+
553
+ /**
554
+ * Creates a reusable {@link assertPrune} function.
555
+ *
556
+ * @danger You must configure the generic argument `T`
557
+ * @returns Nothing until you configure the generic argument `T`
558
+ * @throws compile error
559
+ *
560
+ * @author Jeongho Nam - https://github.com/samchon
561
+ */
562
+ export function createAssertPrune(): never;
563
+
564
+ /**
565
+ * Creates a resuable {@link assertPrune} function.
566
+ *
567
+ * @template T Type of the input value
568
+ * @returns A reusable `isPrune` function
569
+ *
570
+ * @author Jeongho Nam - https://github.com/samchon
571
+ */
572
+ export function createAssertPrune<T extends object>(): (input: T) => T;
573
+
574
+ /**
575
+ * @internal
576
+ */
577
+ export function createAssertPrune<T extends object>(): (input: T) => T {
578
+ halt("createAssertPrune");
579
+ }
580
+ Object.assign(createAssertPrune, assertPrune);
581
+
582
+ /**
583
+ * Creates a reusable {@link isPrune} function.
584
+ *
585
+ * @danger You must configure the generic argument `T`
586
+ * @returns Nothing until you configure the generic argument `T`
587
+ * @throws compile error
588
+ *
589
+ * @author Jeongho Nam - https://github.com/samchon
590
+ */
591
+ export function createIsPrune(): never;
592
+
593
+ /**
594
+ * Creates a resuable {@link isPrune} function.
595
+ *
596
+ * @template T Type of the input value
597
+ * @returns A reusable `isPrune` function
598
+ *
599
+ * @author Jeongho Nam - https://github.com/samchon
600
+ */
601
+ export function createIsPrune<T extends object>(): (input: T) => input is T;
602
+
603
+ /**
604
+ * @internal
605
+ */
606
+ export function createIsPrune<T extends object>(): (input: T) => input is T {
607
+ halt("createIsPrune");
608
+ }
609
+ Object.assign(createIsPrune, isPrune);
610
+
611
+ /**
612
+ * Creates a reusable {@link validatePrune} function.
613
+ *
614
+ * @danger You must configure the generic argument `T`
615
+ * @returns Nothing until you configure the generic argument `T`
616
+ * @throws compile error
617
+ *
618
+ * @author Jeongho Nam - https://github.com/samchon
619
+ */
620
+ export function createValidatePrune(): never;
621
+
622
+ /**
623
+ * Creates a resuable {@link validatePrune} function.
624
+ *
625
+ * @template T Type of the input value
626
+ * @returns A reusable `validatePrune` function
627
+ *
628
+ * @author Jeongho Nam - https://github.com/samchon
629
+ */
630
+ export function createValidatePrune<T extends object>(): (
631
+ input: T,
632
+ ) => IValidation<T>;
633
+
634
+ /**
635
+ * @internal
636
+ */
637
+ export function createValidatePrune<T extends object>(): (
638
+ input: T,
639
+ ) => IValidation<T> {
640
+ halt("createValidatePrune");
641
+ }
642
+ Object.assign(createValidatePrune, validatePrune);
643
+
644
+ /**
645
+ * @internal
646
+ */
647
+ function halt(name: string): never {
648
+ throw new Error(
649
+ `Error on typia.misc.${name}(): no transform has been configured. Read and follow https://typia.misc.io/docs/setup please.`,
650
+ );
651
+ }