typia 7.4.2-dev.20241217 → 7.4.2

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.
Files changed (445) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +148 -148
  3. package/lib/executable/typia.js +0 -0
  4. package/package.json +1 -1
  5. package/src/IRandomGenerator.ts +49 -49
  6. package/src/IReadableURLSearchParams.ts +9 -9
  7. package/src/IValidation.ts +21 -21
  8. package/src/executable/TypiaGenerateWizard.ts +83 -83
  9. package/src/executable/TypiaPatchWizard.ts +45 -45
  10. package/src/executable/TypiaSetupWizard.ts +179 -179
  11. package/src/executable/setup/ArgumentParser.ts +42 -42
  12. package/src/executable/setup/FileRetriever.ts +19 -19
  13. package/src/executable/setup/PackageManager.ts +87 -87
  14. package/src/factories/ExpressionFactory.ts +216 -216
  15. package/src/factories/IdentifierFactory.ts +89 -89
  16. package/src/factories/JsonMetadataFactory.ts +83 -83
  17. package/src/factories/LiteralFactory.ts +52 -52
  18. package/src/factories/MetadataCollection.ts +278 -278
  19. package/src/factories/MetadataCommentTagFactory.ts +650 -650
  20. package/src/factories/MetadataFactory.ts +404 -404
  21. package/src/factories/MetadataTypeTagFactory.ts +411 -411
  22. package/src/factories/MetadataTypeTagSchemaFactory.ts +82 -82
  23. package/src/factories/NumericRangeFactory.ts +72 -72
  24. package/src/factories/ProtobufFactory.ts +875 -875
  25. package/src/factories/StatementFactory.ts +90 -90
  26. package/src/factories/TemplateFactory.ts +64 -64
  27. package/src/factories/TypeFactory.ts +140 -140
  28. package/src/factories/internal/metadata/IMetadataIteratorProps.ts +17 -17
  29. package/src/factories/internal/metadata/MetadataHelper.ts +21 -21
  30. package/src/factories/internal/metadata/emplace_metadata_alias.ts +33 -33
  31. package/src/factories/internal/metadata/emplace_metadata_array_type.ts +39 -39
  32. package/src/factories/internal/metadata/emplace_metadata_object.ts +208 -208
  33. package/src/factories/internal/metadata/emplace_metadata_tuple.ts +57 -57
  34. package/src/factories/internal/metadata/explore_metadata.ts +31 -31
  35. package/src/factories/internal/metadata/iterate_metadata.ts +54 -54
  36. package/src/factories/internal/metadata/iterate_metadata_alias.ts +33 -33
  37. package/src/factories/internal/metadata/iterate_metadata_array.ts +63 -63
  38. package/src/factories/internal/metadata/iterate_metadata_atomic.ts +62 -62
  39. package/src/factories/internal/metadata/iterate_metadata_coalesce.ts +28 -28
  40. package/src/factories/internal/metadata/iterate_metadata_collection.ts +146 -146
  41. package/src/factories/internal/metadata/iterate_metadata_comment_tags.ts +32 -32
  42. package/src/factories/internal/metadata/iterate_metadata_constant.ts +76 -76
  43. package/src/factories/internal/metadata/iterate_metadata_escape.ts +49 -49
  44. package/src/factories/internal/metadata/iterate_metadata_function.ts +91 -91
  45. package/src/factories/internal/metadata/iterate_metadata_intersection.ts +213 -213
  46. package/src/factories/internal/metadata/iterate_metadata_map.ts +57 -57
  47. package/src/factories/internal/metadata/iterate_metadata_native.ts +255 -255
  48. package/src/factories/internal/metadata/iterate_metadata_object.ts +35 -35
  49. package/src/factories/internal/metadata/iterate_metadata_set.ts +57 -57
  50. package/src/factories/internal/metadata/iterate_metadata_sort.ts +87 -87
  51. package/src/factories/internal/metadata/iterate_metadata_template.ts +41 -41
  52. package/src/factories/internal/metadata/iterate_metadata_tuple.ts +26 -26
  53. package/src/factories/internal/metadata/iterate_metadata_union.ts +19 -19
  54. package/src/functional.ts +750 -750
  55. package/src/http.ts +1047 -1047
  56. package/src/internal/_IProtobufWriter.ts +18 -18
  57. package/src/internal/_ProtobufReader.ts +194 -194
  58. package/src/internal/_ProtobufSizer.ts +145 -145
  59. package/src/internal/_ProtobufWriter.ts +145 -145
  60. package/src/internal/_accessExpressionAsString.ts +46 -46
  61. package/src/internal/_assertGuard.ts +13 -13
  62. package/src/internal/_functionalTypeGuardErrorFactory.ts +4 -4
  63. package/src/internal/_httpFormDataReadArray.ts +4 -4
  64. package/src/internal/_httpFormDataReadBigint.ts +18 -18
  65. package/src/internal/_httpFormDataReadBlob.ts +10 -10
  66. package/src/internal/_httpFormDataReadBoolean.ts +16 -16
  67. package/src/internal/_httpFormDataReadFile.ts +10 -10
  68. package/src/internal/_httpFormDataReadNumber.ts +15 -15
  69. package/src/internal/_httpFormDataReadString.ts +10 -10
  70. package/src/internal/_httpHeaderReadBigint.ts +10 -10
  71. package/src/internal/_httpHeaderReadBoolean.ts +8 -8
  72. package/src/internal/_httpHeaderReadNumber.ts +7 -7
  73. package/src/internal/_httpParameterReadBigint.ts +10 -10
  74. package/src/internal/_httpParameterReadBoolean.ts +8 -8
  75. package/src/internal/_httpParameterReadNumber.ts +7 -7
  76. package/src/internal/_httpParameterReadString.ts +2 -2
  77. package/src/internal/_httpQueryParseURLSearchParams.ts +12 -12
  78. package/src/internal/_httpQueryReadArray.ts +4 -4
  79. package/src/internal/_httpQueryReadBigint.ts +12 -12
  80. package/src/internal/_httpQueryReadBoolean.ts +14 -14
  81. package/src/internal/_httpQueryReadNumber.ts +9 -9
  82. package/src/internal/_httpQueryReadString.ts +4 -4
  83. package/src/internal/_isBetween.ts +2 -2
  84. package/src/internal/_isBigintString.ts +8 -8
  85. package/src/internal/_isFormatByte.ts +7 -7
  86. package/src/internal/_isFormatDate.ts +3 -3
  87. package/src/internal/_isFormatDateTime.ts +4 -4
  88. package/src/internal/_isFormatDuration.ts +4 -4
  89. package/src/internal/_isFormatEmail.ts +4 -4
  90. package/src/internal/_isFormatHostname.ts +4 -4
  91. package/src/internal/_isFormatIdnEmail.ts +4 -4
  92. package/src/internal/_isFormatIdnHostname.ts +4 -4
  93. package/src/internal/_isFormatIpv4.ts +4 -4
  94. package/src/internal/_isFormatIpv6.ts +4 -4
  95. package/src/internal/_isFormatIri.ts +3 -3
  96. package/src/internal/_isFormatIriReference.ts +4 -4
  97. package/src/internal/_isFormatJsonPointer.ts +3 -3
  98. package/src/internal/_isFormatPassword.ts +1 -1
  99. package/src/internal/_isFormatRegex.ts +8 -8
  100. package/src/internal/_isFormatRelativeJsonPointer.ts +4 -4
  101. package/src/internal/_isFormatTime.ts +4 -4
  102. package/src/internal/_isFormatUri.ts +6 -6
  103. package/src/internal/_isFormatUriReference.ts +5 -5
  104. package/src/internal/_isFormatUriTemplate.ts +4 -4
  105. package/src/internal/_isFormatUrl.ts +4 -4
  106. package/src/internal/_isFormatUuid.ts +3 -3
  107. package/src/internal/_isTypeFloat.ts +5 -5
  108. package/src/internal/_isTypeInt32.ts +5 -5
  109. package/src/internal/_isTypeInt64.ts +5 -5
  110. package/src/internal/_isTypeUint32.ts +5 -5
  111. package/src/internal/_isTypeUint64.ts +5 -5
  112. package/src/internal/_isUniqueItems.ts +159 -159
  113. package/src/internal/_jsonStringifyNumber.ts +12 -12
  114. package/src/internal/_jsonStringifyRest.ts +3 -3
  115. package/src/internal/_jsonStringifyString.ts +42 -42
  116. package/src/internal/_jsonStringifyTail.ts +2 -2
  117. package/src/internal/_llmApplicationFinalize.ts +20 -20
  118. package/src/internal/_miscCloneAny.ts +46 -46
  119. package/src/internal/_notationAny.ts +37 -37
  120. package/src/internal/_notationCamel.ts +13 -13
  121. package/src/internal/_notationPascal.ts +8 -8
  122. package/src/internal/_notationSnake.ts +43 -43
  123. package/src/internal/_randomArray.ts +21 -21
  124. package/src/internal/_randomBigint.ts +6 -6
  125. package/src/internal/_randomBoolean.ts +1 -1
  126. package/src/internal/_randomFormatByte.ts +3 -3
  127. package/src/internal/_randomFormatDate.ts +18 -18
  128. package/src/internal/_randomFormatDatetime.ts +16 -16
  129. package/src/internal/_randomFormatDuration.ts +27 -27
  130. package/src/internal/_randomFormatEmail.ts +11 -11
  131. package/src/internal/_randomFormatHostname.ts +6 -6
  132. package/src/internal/_randomFormatIdnEmail.ts +3 -3
  133. package/src/internal/_randomFormatIdnHostname.ts +3 -3
  134. package/src/internal/_randomFormatIpv4.ts +11 -11
  135. package/src/internal/_randomFormatIpv6.ts +11 -11
  136. package/src/internal/_randomFormatIri.ts +3 -3
  137. package/src/internal/_randomFormatIriReference.ts +3 -3
  138. package/src/internal/_randomFormatJsonPointer.ts +7 -7
  139. package/src/internal/_randomFormatPassword.ts +8 -8
  140. package/src/internal/_randomFormatRegex.ts +4 -4
  141. package/src/internal/_randomFormatRelativeJsonPointer.ts +8 -8
  142. package/src/internal/_randomFormatTime.ts +14 -14
  143. package/src/internal/_randomFormatUri.ts +3 -3
  144. package/src/internal/_randomFormatUriReference.ts +3 -3
  145. package/src/internal/_randomFormatUriTemplate.ts +3 -3
  146. package/src/internal/_randomFormatUrl.ts +11 -11
  147. package/src/internal/_randomFormatUuid.ts +6 -6
  148. package/src/internal/_randomInteger.ts +47 -47
  149. package/src/internal/_randomNumber.ts +74 -74
  150. package/src/internal/_randomPattern.ts +10 -10
  151. package/src/internal/_randomPick.ts +9 -9
  152. package/src/internal/_randomString.ts +24 -24
  153. package/src/internal/_throwTypeGuardError.ts +5 -5
  154. package/src/internal/_validateReport.ts +13 -13
  155. package/src/internal/private/__notationCapitalize.ts +2 -2
  156. package/src/internal/private/__notationUnsnake.ts +24 -24
  157. package/src/json.ts +752 -752
  158. package/src/llm.ts +481 -481
  159. package/src/misc.ts +658 -658
  160. package/src/module.ts +937 -937
  161. package/src/notations.ts +827 -827
  162. package/src/programmers/AssertProgrammer.ts +454 -454
  163. package/src/programmers/CheckerProgrammer.ts +1617 -1617
  164. package/src/programmers/FeatureProgrammer.ts +622 -622
  165. package/src/programmers/ImportProgrammer.ts +185 -185
  166. package/src/programmers/IsProgrammer.ts +273 -273
  167. package/src/programmers/RandomProgrammer.ts +1190 -1190
  168. package/src/programmers/TypiaProgrammer.ts +174 -174
  169. package/src/programmers/ValidateProgrammer.ts +439 -439
  170. package/src/programmers/functional/FunctionalAssertFunctionProgrammer.ts +153 -153
  171. package/src/programmers/functional/FunctionalAssertParametersProgrammer.ts +125 -125
  172. package/src/programmers/functional/FunctionalAssertReturnProgrammer.ts +115 -115
  173. package/src/programmers/functional/FunctionalIsFunctionProgrammer.ts +72 -72
  174. package/src/programmers/functional/FunctionalIsParametersProgrammer.ts +113 -113
  175. package/src/programmers/functional/FunctionalIsReturnProgrammer.ts +116 -116
  176. package/src/programmers/functional/FunctionalValidateFunctionProgrammer.ts +119 -119
  177. package/src/programmers/functional/FunctionalValidateParametersProgrammer.ts +274 -274
  178. package/src/programmers/functional/FunctionalValidateReturnProgrammer.ts +135 -135
  179. package/src/programmers/functional/internal/FunctionalGeneralProgrammer.ts +34 -34
  180. package/src/programmers/helpers/AtomicPredicator.ts +35 -35
  181. package/src/programmers/helpers/CloneJoiner.ts +143 -143
  182. package/src/programmers/helpers/FunctionProgrammer.ts +67 -67
  183. package/src/programmers/helpers/HttpMetadataUtil.ts +21 -21
  184. package/src/programmers/helpers/NotationJoiner.ts +144 -144
  185. package/src/programmers/helpers/OptionPredicator.ts +15 -15
  186. package/src/programmers/helpers/ProtobufUtil.ts +228 -228
  187. package/src/programmers/helpers/PruneJoiner.ts +148 -148
  188. package/src/programmers/helpers/RandomJoiner.ts +168 -168
  189. package/src/programmers/helpers/StringifyJoinder.ts +115 -115
  190. package/src/programmers/helpers/StringifyPredicator.ts +13 -13
  191. package/src/programmers/helpers/UnionExplorer.ts +372 -372
  192. package/src/programmers/helpers/UnionPredicator.ts +79 -79
  193. package/src/programmers/helpers/disable_function_programmer_declare.ts +32 -32
  194. package/src/programmers/http/HttpAssertFormDataProgrammer.ts +99 -99
  195. package/src/programmers/http/HttpAssertHeadersProgrammer.ts +99 -99
  196. package/src/programmers/http/HttpAssertQueryProgrammer.ts +105 -105
  197. package/src/programmers/http/HttpFormDataProgrammer.ts +308 -308
  198. package/src/programmers/http/HttpHeadersProgrammer.ts +400 -400
  199. package/src/programmers/http/HttpIsFormDataProgrammer.ts +108 -108
  200. package/src/programmers/http/HttpIsHeadersProgrammer.ts +108 -108
  201. package/src/programmers/http/HttpIsQueryProgrammer.ts +114 -114
  202. package/src/programmers/http/HttpParameterProgrammer.ts +115 -115
  203. package/src/programmers/http/HttpQueryProgrammer.ts +336 -336
  204. package/src/programmers/http/HttpValidateFormDataProgrammer.ts +92 -92
  205. package/src/programmers/http/HttpValidateHeadersProgrammer.ts +92 -92
  206. package/src/programmers/http/HttpValidateQueryProgrammer.ts +98 -98
  207. package/src/programmers/internal/check_array_length.ts +47 -47
  208. package/src/programmers/internal/check_bigint.ts +50 -50
  209. package/src/programmers/internal/check_dynamic_key.ts +201 -201
  210. package/src/programmers/internal/check_dynamic_properties.ts +208 -208
  211. package/src/programmers/internal/check_everything.ts +23 -23
  212. package/src/programmers/internal/check_native.ts +27 -27
  213. package/src/programmers/internal/check_number.ts +112 -112
  214. package/src/programmers/internal/check_object.ts +75 -75
  215. package/src/programmers/internal/check_string.ts +50 -50
  216. package/src/programmers/internal/check_template.ts +48 -48
  217. package/src/programmers/internal/check_union_array_like.ts +335 -335
  218. package/src/programmers/internal/decode_union_object.ts +116 -116
  219. package/src/programmers/internal/feature_object_entries.ts +61 -61
  220. package/src/programmers/internal/json_schema_alias.ts +47 -47
  221. package/src/programmers/internal/json_schema_array.ts +45 -45
  222. package/src/programmers/internal/json_schema_bigint.ts +15 -15
  223. package/src/programmers/internal/json_schema_boolean.ts +15 -15
  224. package/src/programmers/internal/json_schema_constant.ts +26 -26
  225. package/src/programmers/internal/json_schema_description.ts +12 -12
  226. package/src/programmers/internal/json_schema_discriminator.ts +35 -35
  227. package/src/programmers/internal/json_schema_escaped.ts +82 -82
  228. package/src/programmers/internal/json_schema_native.ts +33 -33
  229. package/src/programmers/internal/json_schema_number.ts +15 -15
  230. package/src/programmers/internal/json_schema_object.ts +158 -158
  231. package/src/programmers/internal/json_schema_plugin.ts +18 -18
  232. package/src/programmers/internal/json_schema_station.ts +182 -182
  233. package/src/programmers/internal/json_schema_string.ts +15 -15
  234. package/src/programmers/internal/json_schema_template.ts +55 -55
  235. package/src/programmers/internal/json_schema_title.ts +20 -20
  236. package/src/programmers/internal/json_schema_tuple.ts +35 -35
  237. package/src/programmers/internal/metadata_to_pattern.ts +42 -42
  238. package/src/programmers/internal/postfix_of_tuple.ts +5 -5
  239. package/src/programmers/internal/prune_object_properties.ts +71 -71
  240. package/src/programmers/internal/stringify_dynamic_properties.ts +162 -162
  241. package/src/programmers/internal/stringify_regular_properties.ts +81 -81
  242. package/src/programmers/internal/template_to_pattern.ts +23 -23
  243. package/src/programmers/internal/wrap_metadata_rest_tuple.ts +23 -23
  244. package/src/programmers/json/JsonApplicationProgrammer.ts +279 -279
  245. package/src/programmers/json/JsonAssertParseProgrammer.ts +113 -113
  246. package/src/programmers/json/JsonAssertStringifyProgrammer.ts +115 -115
  247. package/src/programmers/json/JsonIsParseProgrammer.ts +114 -114
  248. package/src/programmers/json/JsonIsStringifyProgrammer.ts +108 -108
  249. package/src/programmers/json/JsonSchemasProgrammer.ts +91 -91
  250. package/src/programmers/json/JsonStringifyProgrammer.ts +1124 -1124
  251. package/src/programmers/json/JsonValidateParseProgrammer.ts +105 -105
  252. package/src/programmers/json/JsonValidateStringifyProgrammer.ts +124 -124
  253. package/src/programmers/llm/LlmApplicationOfValidateProgrammer.ts +90 -90
  254. package/src/programmers/llm/LlmApplicationProgrammer.ts +280 -280
  255. package/src/programmers/llm/LlmModelPredicator.ts +127 -127
  256. package/src/programmers/llm/LlmParametersProgrammer.ts +93 -93
  257. package/src/programmers/llm/LlmSchemaProgrammer.ts +192 -192
  258. package/src/programmers/misc/MiscAssertCloneProgrammer.ts +95 -95
  259. package/src/programmers/misc/MiscAssertPruneProgrammer.ts +116 -116
  260. package/src/programmers/misc/MiscCloneProgrammer.ts +1032 -1032
  261. package/src/programmers/misc/MiscIsCloneProgrammer.ts +99 -99
  262. package/src/programmers/misc/MiscIsPruneProgrammer.ts +97 -97
  263. package/src/programmers/misc/MiscLiteralsProgrammer.ts +80 -80
  264. package/src/programmers/misc/MiscPruneProgrammer.ts +728 -728
  265. package/src/programmers/misc/MiscValidateCloneProgrammer.ts +111 -111
  266. package/src/programmers/misc/MiscValidatePruneProgrammer.ts +113 -113
  267. package/src/programmers/notations/NotationAssertGeneralProgrammer.ts +101 -101
  268. package/src/programmers/notations/NotationGeneralProgrammer.ts +984 -984
  269. package/src/programmers/notations/NotationIsGeneralProgrammer.ts +105 -105
  270. package/src/programmers/notations/NotationValidateGeneralProgrammer.ts +119 -119
  271. package/src/programmers/protobuf/ProtobufAssertDecodeProgrammer.ts +98 -98
  272. package/src/programmers/protobuf/ProtobufAssertEncodeProgrammer.ts +102 -102
  273. package/src/programmers/protobuf/ProtobufDecodeProgrammer.ts +654 -654
  274. package/src/programmers/protobuf/ProtobufEncodeProgrammer.ts +945 -945
  275. package/src/programmers/protobuf/ProtobufIsDecodeProgrammer.ts +109 -109
  276. package/src/programmers/protobuf/ProtobufIsEncodeProgrammer.ts +98 -98
  277. package/src/programmers/protobuf/ProtobufMessageProgrammer.ts +179 -179
  278. package/src/programmers/protobuf/ProtobufValidateDecodeProgrammer.ts +92 -92
  279. package/src/programmers/protobuf/ProtobufValidateEncodeProgrammer.ts +119 -119
  280. package/src/protobuf.ts +868 -868
  281. package/src/reflect.ts +57 -57
  282. package/src/schemas/json/IJsonApplication.ts +73 -73
  283. package/src/schemas/json/IJsonSchemaCollection.ts +29 -29
  284. package/src/schemas/json/__IJsonApplication.ts +63 -63
  285. package/src/schemas/llm/ILlmApplicationOfValidate.ts +55 -55
  286. package/src/schemas/llm/ILlmFunctionOfValidate.ts +39 -39
  287. package/src/schemas/metadata/IMetadata.ts +35 -35
  288. package/src/schemas/metadata/IMetadataAlias.ts +6 -6
  289. package/src/schemas/metadata/IMetadataAliasType.ts +12 -12
  290. package/src/schemas/metadata/IMetadataApplication.ts +7 -7
  291. package/src/schemas/metadata/IMetadataArray.ts +6 -6
  292. package/src/schemas/metadata/IMetadataComponents.ts +11 -11
  293. package/src/schemas/metadata/IMetadataConstantValue.ts +11 -11
  294. package/src/schemas/metadata/IMetadataDictionary.ts +11 -11
  295. package/src/schemas/metadata/IMetadataMap.ts +8 -8
  296. package/src/schemas/metadata/IMetadataNative.ts +6 -6
  297. package/src/schemas/metadata/IMetadataObject.ts +6 -6
  298. package/src/schemas/metadata/IMetadataObjectType.ts +13 -13
  299. package/src/schemas/metadata/IMetadataSet.ts +7 -7
  300. package/src/schemas/metadata/IMetadataTemplate.ts +7 -7
  301. package/src/schemas/metadata/IMetadataTuple.ts +6 -6
  302. package/src/schemas/metadata/IMetadataTypeTag.ts +16 -16
  303. package/src/schemas/metadata/Metadata.ts +669 -669
  304. package/src/schemas/metadata/MetadataAlias.ts +46 -46
  305. package/src/schemas/metadata/MetadataAliasType.ts +63 -63
  306. package/src/schemas/metadata/MetadataApplication.ts +44 -44
  307. package/src/schemas/metadata/MetadataArray.ts +49 -49
  308. package/src/schemas/metadata/MetadataAtomic.ts +87 -87
  309. package/src/schemas/metadata/MetadataComponents.ts +98 -98
  310. package/src/schemas/metadata/MetadataConstantValue.ts +62 -62
  311. package/src/schemas/metadata/MetadataMap.ts +48 -48
  312. package/src/schemas/metadata/MetadataNative.ts +44 -44
  313. package/src/schemas/metadata/MetadataObject.ts +48 -48
  314. package/src/schemas/metadata/MetadataObjectType.ts +149 -149
  315. package/src/schemas/metadata/MetadataParameter.ts +54 -54
  316. package/src/schemas/metadata/MetadataProperty.ts +59 -59
  317. package/src/schemas/metadata/MetadataSet.ts +45 -45
  318. package/src/schemas/metadata/MetadataTemplate.ts +80 -80
  319. package/src/schemas/metadata/MetadataTuple.ts +32 -32
  320. package/src/schemas/protobuf/IProtobufProperty.ts +6 -6
  321. package/src/schemas/protobuf/IProtobufPropertyType.ts +37 -37
  322. package/src/schemas/protobuf/IProtobufSchema.ts +50 -50
  323. package/src/tags/Example.ts +24 -24
  324. package/src/tags/Examples.ts +16 -16
  325. package/src/tags/Format.ts +50 -50
  326. package/src/tags/JsonSchemaPlugin.ts +8 -8
  327. package/src/tags/Sequence.ts +10 -10
  328. package/src/tags/TagBase.ts +82 -82
  329. package/src/tags/Type.ts +32 -32
  330. package/src/tags/UniqueItems.ts +14 -14
  331. package/src/tags/index.ts +21 -21
  332. package/src/transform.ts +35 -35
  333. package/src/transformers/CallExpressionTransformer.ts +547 -547
  334. package/src/transformers/FileTransformer.ts +136 -136
  335. package/src/transformers/IProgrammerProps.ts +11 -11
  336. package/src/transformers/ITransformOptions.ts +62 -62
  337. package/src/transformers/ITransformProps.ts +9 -9
  338. package/src/transformers/ITypiaContext.ts +18 -18
  339. package/src/transformers/ImportTransformer.ts +81 -81
  340. package/src/transformers/NodeTransformer.ts +17 -17
  341. package/src/transformers/TransformerError.ts +60 -60
  342. package/src/transformers/features/AssertTransformer.ts +24 -24
  343. package/src/transformers/features/CreateAssertTransformer.ts +24 -24
  344. package/src/transformers/features/CreateIsTransformer.ts +18 -18
  345. package/src/transformers/features/CreateRandomTransformer.ts +43 -43
  346. package/src/transformers/features/CreateValidateTransformer.ts +18 -18
  347. package/src/transformers/features/IsTransformer.ts +18 -18
  348. package/src/transformers/features/RandomTransformer.ts +41 -41
  349. package/src/transformers/features/ValidateTransformer.ts +18 -18
  350. package/src/transformers/features/functional/FunctionalGenericTransformer.ts +57 -57
  351. package/src/transformers/features/http/CreateHttpAssertFormDataTransformer.ts +13 -13
  352. package/src/transformers/features/http/CreateHttpAssertHeadersTransformer.ts +13 -13
  353. package/src/transformers/features/http/CreateHttpAssertQueryTransformer.ts +13 -13
  354. package/src/transformers/features/http/CreateHttpFormDataTransformer.ts +13 -13
  355. package/src/transformers/features/http/CreateHttpHeadersTransformer.ts +13 -13
  356. package/src/transformers/features/http/CreateHttpIsFormDataTransformer.ts +13 -13
  357. package/src/transformers/features/http/CreateHttpIsHeadersTransformer.ts +13 -13
  358. package/src/transformers/features/http/CreateHttpIsQueryTransformer.ts +13 -13
  359. package/src/transformers/features/http/CreateHttpParameterTransformer.ts +13 -13
  360. package/src/transformers/features/http/CreateHttpQueryTransformer.ts +13 -13
  361. package/src/transformers/features/http/CreateHttpValidateFormDataTransformer.ts +13 -13
  362. package/src/transformers/features/http/CreateHttpValidateHeadersTransformer.ts +13 -13
  363. package/src/transformers/features/http/CreateHttpValidateQueryTransformer.ts +13 -13
  364. package/src/transformers/features/http/HttpAssertFormDataTransformer.ts +13 -13
  365. package/src/transformers/features/http/HttpAssertHeadersTransformer.ts +13 -13
  366. package/src/transformers/features/http/HttpAssertQueryTransformer.ts +13 -13
  367. package/src/transformers/features/http/HttpFormDataTransformer.ts +13 -13
  368. package/src/transformers/features/http/HttpHeadersTransformer.ts +13 -13
  369. package/src/transformers/features/http/HttpIsFormDataTransformer.ts +13 -13
  370. package/src/transformers/features/http/HttpIsHeadersTransformer.ts +13 -13
  371. package/src/transformers/features/http/HttpIsQueryTransformer.ts +13 -13
  372. package/src/transformers/features/http/HttpParameterTransformer.ts +13 -13
  373. package/src/transformers/features/http/HttpQueryTransformer.ts +13 -13
  374. package/src/transformers/features/http/HttpValidateFormDataTransformer.ts +13 -13
  375. package/src/transformers/features/http/HttpValidateHeadersTransformer.ts +13 -13
  376. package/src/transformers/features/http/HttpValidateQueryTransformer.ts +13 -13
  377. package/src/transformers/features/json/JsonApplicationTransformer.ts +105 -105
  378. package/src/transformers/features/json/JsonAssertParseTransformer.ts +13 -13
  379. package/src/transformers/features/json/JsonAssertStringifyTransformer.ts +13 -13
  380. package/src/transformers/features/json/JsonCreateAssertParseTransformer.ts +13 -13
  381. package/src/transformers/features/json/JsonCreateAssertStringifyTransformer.ts +13 -13
  382. package/src/transformers/features/json/JsonCreateIsParseTransformer.ts +13 -13
  383. package/src/transformers/features/json/JsonCreateIsStringifyTransformer.ts +13 -13
  384. package/src/transformers/features/json/JsonCreateStringifyTransformer.ts +13 -13
  385. package/src/transformers/features/json/JsonCreateValidateParseTransformer.ts +13 -13
  386. package/src/transformers/features/json/JsonCreateValidateStringifyProgrammer.ts +13 -13
  387. package/src/transformers/features/json/JsonIsParseTransformer.ts +13 -13
  388. package/src/transformers/features/json/JsonIsStringifyTransformer.ts +13 -13
  389. package/src/transformers/features/json/JsonSchemasTransformer.ts +143 -143
  390. package/src/transformers/features/json/JsonStringifyTransformer.ts +13 -13
  391. package/src/transformers/features/json/JsonValidateParseTransformer.ts +13 -13
  392. package/src/transformers/features/json/JsonValidateStringifyTransformer.ts +13 -13
  393. package/src/transformers/features/llm/LlmApplicationOfValidateTransformer.ts +121 -121
  394. package/src/transformers/features/llm/LlmApplicationTransformer.ts +118 -118
  395. package/src/transformers/features/llm/LlmParametersTransformer.ts +94 -94
  396. package/src/transformers/features/llm/LlmSchemaTransformer.ts +135 -135
  397. package/src/transformers/features/misc/MiscAssertCloneTransformer.ts +13 -13
  398. package/src/transformers/features/misc/MiscAssertPruneTransformer.ts +13 -13
  399. package/src/transformers/features/misc/MiscCloneTransformer.ts +13 -13
  400. package/src/transformers/features/misc/MiscCreateAssertCloneTransformer.ts +13 -13
  401. package/src/transformers/features/misc/MiscCreateAssertPruneTransformer.ts +13 -13
  402. package/src/transformers/features/misc/MiscCreateCloneTransformer.ts +13 -13
  403. package/src/transformers/features/misc/MiscCreateIsCloneTransformer.ts +13 -13
  404. package/src/transformers/features/misc/MiscCreateIsPruneTransformer.ts +13 -13
  405. package/src/transformers/features/misc/MiscCreatePruneTransformer.ts +13 -13
  406. package/src/transformers/features/misc/MiscCreateValidateCloneTransformer.ts +13 -13
  407. package/src/transformers/features/misc/MiscCreateValidatePruneTransformer.ts +13 -13
  408. package/src/transformers/features/misc/MiscIsCloneTransformer.ts +13 -13
  409. package/src/transformers/features/misc/MiscIsPruneTransformer.ts +13 -13
  410. package/src/transformers/features/misc/MiscLiteralsTransformer.ts +35 -35
  411. package/src/transformers/features/misc/MiscPruneTransformer.ts +13 -13
  412. package/src/transformers/features/misc/MiscValidateCloneTransformer.ts +13 -13
  413. package/src/transformers/features/misc/MiscValidatePruneTransformer.ts +13 -13
  414. package/src/transformers/features/notations/NotationAssertGeneralTransformer.ts +20 -20
  415. package/src/transformers/features/notations/NotationCreateAssertGeneralTransformer.ts +20 -20
  416. package/src/transformers/features/notations/NotationCreateGeneralTransformer.ts +20 -20
  417. package/src/transformers/features/notations/NotationCreateIsGeneralTransformer.ts +20 -20
  418. package/src/transformers/features/notations/NotationCreateValidateGeneralTransformer.ts +20 -20
  419. package/src/transformers/features/notations/NotationGeneralTransformer.ts +18 -18
  420. package/src/transformers/features/notations/NotationIsGeneralTransformer.ts +20 -20
  421. package/src/transformers/features/notations/NotationValidateGeneralTransformer.ts +20 -20
  422. package/src/transformers/features/protobuf/ProtobufAssertDecodeTransformer.ts +13 -13
  423. package/src/transformers/features/protobuf/ProtobufAssertEncodeTransformer.ts +13 -13
  424. package/src/transformers/features/protobuf/ProtobufCreateAssertDecodeTransformer.ts +13 -13
  425. package/src/transformers/features/protobuf/ProtobufCreateAssertEncodeTransformer.ts +13 -13
  426. package/src/transformers/features/protobuf/ProtobufCreateDecodeTransformer.ts +13 -13
  427. package/src/transformers/features/protobuf/ProtobufCreateEncodeTransformer.ts +13 -13
  428. package/src/transformers/features/protobuf/ProtobufCreateIsDecodeTransformer.ts +13 -13
  429. package/src/transformers/features/protobuf/ProtobufCreateIsEncodeTransformer.ts +13 -13
  430. package/src/transformers/features/protobuf/ProtobufCreateValidateDecodeTransformer.ts +13 -13
  431. package/src/transformers/features/protobuf/ProtobufCreateValidateEncodeTransformer.ts +13 -13
  432. package/src/transformers/features/protobuf/ProtobufDecodeTransformer.ts +13 -13
  433. package/src/transformers/features/protobuf/ProtobufEncodeTransformer.ts +13 -13
  434. package/src/transformers/features/protobuf/ProtobufIsDecodeTransformer.ts +13 -13
  435. package/src/transformers/features/protobuf/ProtobufIsEncodeTransformer.ts +13 -13
  436. package/src/transformers/features/protobuf/ProtobufMessageTransformer.ts +35 -35
  437. package/src/transformers/features/protobuf/ProtobufValidateDecodeTransformer.ts +13 -13
  438. package/src/transformers/features/protobuf/ProtobufValidateEncodeTransformer.ts +13 -13
  439. package/src/transformers/features/reflect/ReflectMetadataTransformer.ts +69 -69
  440. package/src/transformers/features/reflect/ReflectNameTransformer.ts +82 -82
  441. package/src/transformers/internal/GenericTransformer.ts +101 -101
  442. package/src/utils/MapUtil.ts +14 -14
  443. package/src/utils/NamingConvention.ts +94 -94
  444. package/src/utils/ProtobufNameEncoder.ts +32 -32
  445. package/src/utils/StringUtil.ts +16 -16
package/src/functional.ts CHANGED
@@ -1,750 +1,750 @@
1
- import { IValidation } from "./IValidation";
2
- import { TypeGuardError } from "./TypeGuardError";
3
-
4
- /* ===========================================================
5
- FUNCTIONAL
6
- - ASSERT
7
- - IS
8
- - VALIDATE
9
- ==============================================================
10
- ASSERT
11
- ----------------------------------------------------------- */
12
- /**
13
- * Asserts a function.
14
- *
15
- * Asserts a function, by wrapping the function and checking its parameters and
16
- * return value through {@link assert} function. If some parameter or return value
17
- * does not match the expected type, it throws an {@link TypeGuardError} or a custom
18
- * error generated by the *errorFactory* parameter.
19
- *
20
- * For reference, {@link TypeGuardError.path} would be a little bit different with
21
- * individual {@link assert} function. If the {@link TypeGuardError} occurs from
22
- * some parameter, the path would start from `$input.parameters[number]`. Otherwise
23
- * the path would start from `$input.return`.
24
- *
25
- * - `$input.parameters[0].~`
26
- * - `$input.return.~`
27
- *
28
- * By the way, if what you want is not just finding the 1st type error through
29
- * assertion, but also finding every type errors, then use {@link validateFunction}
30
- * instead. Otherwise, what you want is just asserting parameters or return value
31
- * only, you can use {@link assertParameters} or {@link assertReturn} instead.
32
- *
33
- * On the other hand, if don't want to allow any superfluous properties, utilize
34
- * {@link assertEqualsFunction} or {@link validateEqualsFunction} instead.
35
- *
36
- * @template T Target function type
37
- * @param func Target function to assert
38
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
39
- * @returns The wrapper function with type assertions
40
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
41
- *
42
- * @author Jeongho Nam - https://github.com/samchon
43
- */
44
- export function assertFunction<T extends (...args: any[]) => any>(
45
- func: T,
46
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
47
- ): T;
48
-
49
- /**
50
- * @internal
51
- */
52
- export function assertFunction(): never {
53
- halt("assertFunction");
54
- }
55
-
56
- /**
57
- * Asserts parameters.
58
- *
59
- * Asserts a function, by wrapping the function and checking its parameters through
60
- * {@link assert} function. If some parameter does not match the expected type, it
61
- * throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
62
- * parameter.
63
- *
64
- * For reference, {@link TypeGuardError.path} would be a little bit different with
65
- * individual {@link assert} function. If the {@link TypeGuardError} occurs from
66
- * some parameter, the path would start from `$input.parameters[number]`.
67
- *
68
- * By the way, if what you want is not just finding the 1st type error through
69
- * assertion, but also finding every type errors, then use {@link validateParameters}
70
- * instead. Otherwise, what you want is not only asserting parameters, but also
71
- * asserting return value, you can use {@link assertFunction} instead.
72
- *
73
- * On the other hand, if don't want to allow any superfluous properties, utilize
74
- * {@link assertEqualsParameters} or {@link validateEqualsParameters} instead.
75
- *
76
- * @template T Target function type
77
- * @param func Target function to assert
78
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
79
- * @returns The wrapper function with type assertions
80
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
81
- *
82
- * @author Jeongho Nam - https://github.com/samchon
83
- */
84
- export function assertParameters<T extends (...args: any[]) => any>(
85
- func: T,
86
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
87
- ): T;
88
-
89
- /**
90
- * @internal
91
- */
92
- export function assertParameters(): never {
93
- halt("assertParameters");
94
- }
95
-
96
- /**
97
- * Asserts return value.
98
- *
99
- * Asserts a function, by wrapping the function and checking its return value through
100
- * {@link assert} function. If the return value does not match the expected type, it
101
- * throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
102
- * parameter.
103
- *
104
- * For reference, {@link TypeGuardError.path} would be a little bit different with
105
- * individual {@link assert} function. If the {@link TypeGuardError} occurs from
106
- * the return value, the path would start from `$input.return`.
107
- *
108
- * By the way, if what you want is not just finding the 1st type error through
109
- * assertion, but also finding every type errors, then use {@link validateReturn}
110
- * instead. Otherwise, what you want is not only asserting return value, but also
111
- * asserting parameters, you can use {@link assertFunction} instead.
112
- *
113
- * On the other hand, if don't want to allow any superfluous properties, utilize
114
- * {@link assertEqualsReturn} or {@link validateEqualsReturn} instead.
115
- *
116
- * @template T Target function type
117
- * @param func Target function to assert
118
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
119
- * @returns The wrapper function with type assertions
120
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
121
- *
122
- * @author Jeongho Nam - https://github.com/samchon
123
- */
124
- export function assertReturn<T extends (...args: any[]) => any>(
125
- func: T,
126
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
127
- ): T;
128
-
129
- /**
130
- * @internal
131
- */
132
- export function assertReturn(): never {
133
- halt("assertReturn");
134
- }
135
-
136
- /**
137
- * Asserts a function with strict equality.
138
- *
139
- * Asserts a function with strict equality, by wrapping the function and checking
140
- * its parameters and return value through {@link assertEquals} function. If some
141
- * parameter or return value does not match the expected type, it throws an
142
- * {@link TypeGuardError} or a custom error generated by the *errorFactory* parameter.
143
- *
144
- * For reference, {@link TypeGuardError.path} would be a little bit different with
145
- * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
146
- * some parameter, the path would start from `$input.parameters[number]`. Otherwise
147
- * the path would start from `$input.return`.
148
- *
149
- * - `$input.parameters[0].~`
150
- * - `$input.return.~`
151
- *
152
- * By the way, if what you want is not just finding the 1st type error through
153
- * assertion, but also finding every type errors, then use
154
- * {@link validateEqualsFunction} instead. Otherwise, what you want is just asserting
155
- * parameters or return value only, you can use {@link assertEqualsParameters} or
156
- * {@link assertEqualsReturn} instead.
157
- *
158
- * On the other hand, if you want to allow any superfluous properties, utilize
159
- * {@link assertFunction} or {@link validateFunction} instead.
160
- *
161
- * @template T Target function type
162
- * @param func Target function to assert
163
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
164
- * @returns The wrapper function with type assertions
165
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
166
- *
167
- * @author Jeongho Nam - https://github.com/samchon
168
- */
169
- export function assertEqualsFunction<T extends (...args: any[]) => any>(
170
- func: T,
171
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
172
- ): T;
173
-
174
- /**
175
- * @internal
176
- */
177
- export function assertEqualsFunction(): never {
178
- halt("assertEqualsFunction");
179
- }
180
-
181
- /**
182
- * Asserts parameters with strict equality.
183
- *
184
- * Asserts a function, by wrapping the function and checking its parameters through
185
- * {@link assertEquals} function. If some parameter does not match the expected type,
186
- * it throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
187
- * parameter.
188
- *
189
- * For reference, {@link TypeGuardError.path} would be a little bit different with
190
- * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
191
- * some parameter, the path would start from `$input.parameters[number]`.
192
- *
193
- * By the way, if what you want is not just finding the 1st type error through
194
- * assertion, but also finding every type errors, then use
195
- * {@link validateEqualsParameters} instead. Otherwise, what you want is not only
196
- * asserting parameters, but also asserting return value, you can use
197
- * {@link assertEqualsFunction} instead.
198
- *
199
- * On the other hand, if you want to allow any superfluous properties, utilize
200
- * {@link assertParameters} or {@link validateParameters} instead.
201
- *
202
- * @template T Target function type
203
- * @param func Target function to assert
204
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
205
- * @returns The wrapper function with type assertions
206
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
207
- *
208
- * @author Jeongho Nam - https://github.com/samchon
209
- */
210
- export function assertEqualsParameters<T extends (...args: any[]) => any>(
211
- func: T,
212
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
213
- ): T;
214
-
215
- /**
216
- * @internal
217
- */
218
- export function assertEqualsParameters(): never {
219
- halt("assertEqualsParameters");
220
- }
221
-
222
- /**
223
- * Asserts return value with strict equality.
224
- *
225
- * Asserts a function, by wrapping the function and checking its return value through
226
- * {@link assertEquals} function. If the return value does not match the expected type,
227
- * it throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
228
- * parameter.
229
- *
230
- * For reference, {@link TypeGuardError.path} would be a little bit different with
231
- * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
232
- * the return value, the path would start from `$input.return`.
233
- *
234
- * By the way, if what you want is not just finding the 1st type error through
235
- * assertion, but also finding every type errors, then use {@link validateEqualsReturn}
236
- * instead. Otherwise, what you want is not only asserting return value, but also
237
- * asserting parameters, you can use {@link assertEqualsFunction} instead.
238
- *
239
- * On the other hand, if you want to allow any superfluous properties, utilize
240
- * {@link assertReturn} or {@link validateReturn} instead.
241
- *
242
- * @template T Target function type
243
- * @param func Target function to assert
244
- * @param errorFactory Custom error factory. Default is `TypeGuardError`
245
- * @returns The wrapper function with type assertions
246
- * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
247
- *
248
- * @author Jeongho Nam - https://github.com/samchon
249
- */
250
- export function assertEqualsReturn<T extends (...args: any[]) => any>(
251
- func: T,
252
- errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
253
- ): T;
254
-
255
- /**
256
- * @internal
257
- */
258
- export function assertEqualsReturn(): never {
259
- halt("assertEqualsReturn");
260
- }
261
-
262
- /* -----------------------------------------------------------
263
- IS
264
- ----------------------------------------------------------- */
265
- /**
266
- * Tests a function.
267
- *
268
- * Tests a function, by wrapping the function and checking its parameters and
269
- * return value through {@link is} function. If some parameter or return value
270
- * does not match the expected type, it returns `null`. Otherwise there's no
271
- * type error, it returns the result of the function.
272
- *
273
- * By the way, if you want is not just testing type checking, but also finding
274
- * detailed type error reason(s), then use {@link assertFunction} or
275
- * {@link validateFunction} instead.
276
- *
277
- * On the other hand, if you don't want to allow any superfluous properties,
278
- * utilize {@link equalsFunction}, {@link assertEqualsFunction} or
279
- * {@link validateEqualsFunction} instead.
280
- *
281
- * @template T Target function type
282
- * @param func Target function to test
283
- * @returns The wrapper function with type tests
284
- *
285
- * @author Jeongho Nam - https://github.com/samchon
286
- */
287
- export function isFunction<T extends (...args: any[]) => any>(
288
- func: T,
289
- ): T extends (...args: infer Arguments) => infer Output
290
- ? Output extends Promise<infer R>
291
- ? (...args: Arguments) => Promise<R | null>
292
- : (...args: Arguments) => Output | null
293
- : never;
294
-
295
- /**
296
- * @internal
297
- */
298
- export function isFunction(): never {
299
- halt("isFunction");
300
- }
301
-
302
- /**
303
- * Tests parameters.
304
- *
305
- * Tests a function, by wrapping the function and checking its parameters through
306
- * {@link is} function. If some parameter does not match the expected type, it
307
- * returns `null`. Otherwise there's no type error, it returns the result of the
308
- * function.
309
- *
310
- * By the way, if you want is not just testing type checking, but also finding
311
- * detailed type error reason(s), then use {@link assertParameters} or
312
- * {@link validateParameters} instead.
313
- *
314
- * On the other hand, if you don't want to allow any superfluous properties,
315
- * utilize {@link equalsParameters}, {@link assertEqualsParameters} or
316
- * {@link validateEqualsParameters} instead.
317
- *
318
- * @template T Target function type
319
- * @param func Target function to test
320
- * @returns The wrapper function with type tests
321
- *
322
- * @author Jeongho Nam - https://github.com/samchon
323
- */
324
- export function isParameters<T extends (...args: any[]) => any>(
325
- func: T,
326
- ): T extends (...args: infer Arguments) => infer Output
327
- ? Output extends Promise<infer R>
328
- ? (...args: Arguments) => Promise<R | null>
329
- : (...args: Arguments) => Output | null
330
- : never;
331
-
332
- /**
333
- * @internal
334
- */
335
- export function isParameters(): never {
336
- halt("isParameters");
337
- }
338
-
339
- /**
340
- * Tests return value.
341
- *
342
- * Tests a function, by wrapping the function and checking its return value through
343
- * {@link is} function. If the return value does not match the expected type, it
344
- * returns `null`. Otherwise there's no type error, it returns the result of the
345
- * function.
346
- *
347
- * By the way, if you want is not just testing type checking, but also finding
348
- * detailed type error reason(s), then use {@link assertReturn} or
349
- * {@link validateReturn} instead.
350
- *
351
- * On the other hand, if you don't want to allow any superfluous properties,
352
- * utilize {@link equalsReturn}, {@link assertEqualsReturn} or
353
- * {@link validateEqualsReturn} instead.
354
- *
355
- * @template T Target function type
356
- * @param func Target function to test
357
- * @returns The wrapper function with type tests
358
- *
359
- * @author Jeongho Nam - https://github.com/samchon
360
- */
361
- export function isReturn<T extends (...args: any[]) => any>(
362
- func: T,
363
- ): T extends (...args: infer Arguments) => infer Output
364
- ? Output extends Promise<infer R>
365
- ? (...args: Arguments) => Promise<R | null>
366
- : (...args: Arguments) => Output | null
367
- : never;
368
-
369
- /**
370
- * @internal
371
- */
372
- export function isReturn(): never {
373
- halt("isReturn");
374
- }
375
-
376
- /**
377
- * Tests a function with strict equality.
378
- *
379
- * Tests a function with strict equality, by wrapping the function and checking its
380
- * parameters and return value through {@link isEquals} function. If some parameter
381
- * or return value does not match the expected type, it returns `null`. Otherwise
382
- * there's no type error, it returns the result of the function.
383
- *
384
- * By the way, if you want is not just testing type checking, but also finding
385
- * detailed type error reason(s), then use {@link assertEqualsFunction} or
386
- * {@link validateEqualsFunction} instead.
387
- *
388
- * On the other hand, if you want to allow any superfluous properties, utilize
389
- * {@link isFunction}, {@link assertFunction} or {@link validateFunction} instead.
390
- *
391
- * @template T Target function type
392
- * @param func Target function to test
393
- * @returns The wrapper function with type tests
394
- *
395
- * @author Jeongho Nam - https://github.com/samchon
396
- */
397
- export function equalsFunction<T extends (...args: any[]) => any>(
398
- func: T,
399
- ): T extends (...args: infer Arguments) => infer Output
400
- ? Output extends Promise<infer R>
401
- ? (...args: Arguments) => Promise<R | null>
402
- : (...args: Arguments) => Output | null
403
- : never;
404
-
405
- /**
406
- * @internal
407
- */
408
- export function equalsFunction(): never {
409
- halt("equalsFunction");
410
- }
411
-
412
- /**
413
- * Tests parameters with strict equality.
414
- *
415
- * Tests a function, by wrapping the function and checking its parameters through
416
- * {@link isEquals} function. If some parameter does not match the expected type,
417
- * it returns `null`. Otherwise there's no type error, it returns the result of the
418
- * function.
419
- *
420
- * By the way, if you want is not just testing type checking, but also finding
421
- * detailed type error reason(s), then use {@link assertEqualsParameters} or
422
- * {@link validateEqualsParameters} instead.
423
- *
424
- * @template T Target function type
425
- * @param func Target function to test
426
- * @returns The wrapper function with type tests
427
- *
428
- * @author Jeongho Nam - https://github.com/samchon
429
- */
430
- export function equalsParameters<T extends (...args: any[]) => any>(
431
- func: T,
432
- ): T extends (...args: infer Arguments) => infer Output
433
- ? Output extends Promise<infer R>
434
- ? (...args: Arguments) => Promise<R | null>
435
- : (...args: Arguments) => Output | null
436
- : never;
437
-
438
- /**
439
- * @internal
440
- */
441
- export function equalsParameters(): never {
442
- halt("equalsParameters");
443
- }
444
-
445
- /**
446
- * Tests return value with strict equality.
447
- *
448
- * Tests a function, by wrapping the function and checking its return value through
449
- * {@link isEquals} function. If the return value does not match the expected type,
450
- * it returns `null`. Otherwise there's no type error, it returns the result of the
451
- * function.
452
- *
453
- * By the way, if you want is not just testing type checking, but also finding
454
- * detailed type error reason(s), then use {@link assertEqualsReturn} or
455
- * {@link validateEqualsReturn} instead.
456
- *
457
- * On the other hand, if you want to allow any superfluous properties, utilize
458
- * {@link isReturn}, {@link assertReturn} or {@link validateReturn} instead.
459
- *
460
- * @template T Target function type
461
- * @param func Target function to test
462
- * @returns The wrapper function with type tests
463
- *
464
- * @author Jeongho Nam - https://github.com/samchon
465
- */
466
- export function equalsReturn<T extends (...args: any[]) => any>(
467
- func: T,
468
- ): T extends (...args: infer Arguments) => infer Output
469
- ? Output extends Promise<infer R>
470
- ? (...args: Arguments) => Promise<R | null>
471
- : (...args: Arguments) => Output | null
472
- : never;
473
-
474
- /**
475
- * @internal
476
- */
477
- export function equalsReturn(): never {
478
- halt("equalsReturn");
479
- }
480
-
481
- /* -----------------------------------------------------------
482
- VALIDATE
483
- ----------------------------------------------------------- */
484
- /**
485
- * Validates a function.
486
- *
487
- * Validates a function, by wrapping the function and checking its parameters and
488
- * return value through {@link validate} function. If some parameter or return value
489
- * does not match the expected type, it returns {@link IValidation.IError} typed
490
- * object. Otherwise there's no type error, it returns {@link IValidation.ISuccess}
491
- * typed object instead.
492
- *
493
- * For reference, {@link IValidation.IError.path} would be a little bit different with
494
- * individual {@link validate} function. If the {@link IValidation.IError} occurs from
495
- * some parameter, the path would start from `$input.parameters[number]`. Otherwise
496
- * the path would start from `$input.return`.
497
- *
498
- * - `$input.parameters[0].~`
499
- * - `$input.return.~`
500
- *
501
- * By the way, if what you want is not finding every type errors, but just finding
502
- * the 1st type error, then use {@link assertFunction} instead. Otherwise, what you
503
- * want is just validating parameters or return value only, you can use
504
- * {@link validateParameters} or {@link validateReturn} instead.
505
- *
506
- * On the other hand, if you don't want to allow any superfluous properties, utilize
507
- * {@link validateEqualsFunction} or {@link assertEqualsFunction} instead.
508
- *
509
- * @template T Target function type
510
- * @param func Target function to validate
511
- * @returns The wrapper function with type validations
512
- *
513
- * @author Jeongho Nam - https://github.com/samchon
514
- */
515
- export function validateFunction<T extends (...args: any[]) => any>(
516
- func: T,
517
- ): T extends (...args: infer Arguments) => infer Output
518
- ? Output extends Promise<infer R>
519
- ? (...args: Arguments) => Promise<IValidation<R>>
520
- : (...args: Arguments) => IValidation<Output>
521
- : never;
522
-
523
- /**
524
- * @internal
525
- */
526
- export function validateFunction(): never {
527
- halt("validateFunction");
528
- }
529
-
530
- /**
531
- * Validates parameters.
532
- *
533
- * Validates a function, by wrapping the function and checking its parameters through
534
- * {@link validate} function. If some parameter does not match the expected type, it
535
- * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
536
- * it returns {@link IValidation.ISuccess} typed object instead.
537
- *
538
- * For reference, {@link IValidation.IError.path} would be a little bit different with
539
- * individual {@link validate} function. If the {@link IValidation.IError} occurs from
540
- * some parameter, the path would start from `$input.parameters[number]`.
541
- *
542
- * By the way, if what you want is not finding every type errors, but just finding
543
- * the 1st type error, then use {@link assertParameters} instead. Otherwise, what you
544
- * want is not only validating parameters, but also validating return value, you can
545
- * use {@link validateFunction} instead.
546
- *
547
- * On the other hand, if you don't want to allow any superfluous properties, utilize
548
- * {@link validateEqualsParameters} or {@link assertEqualsParameters} instead.
549
- *
550
- * @template T Target function type
551
- * @param func Target function to validate
552
- * @returns The wrapper function with type validations
553
- *
554
- * @author Jeongho Nam - https://github.com/samchon
555
- */
556
- export function validateParameters<T extends (...args: any[]) => any>(
557
- func: T,
558
- ): T extends (...args: infer Arguments) => infer Output
559
- ? Output extends Promise<infer R>
560
- ? (...args: Arguments) => Promise<IValidation<R>>
561
- : (...args: Arguments) => IValidation<Output>
562
- : never;
563
-
564
- /**
565
- * @internal
566
- */
567
- export function validateParameters(): never {
568
- halt("validateReturn");
569
- }
570
-
571
- /**
572
- * Validates return value.
573
- *
574
- * Validates a function, by wrapping the function and checking its return value through
575
- * {@link validate} function. If the return value does not match the expected type, it
576
- * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
577
- * it returns {@link IValidation.ISuccess} typed object instead.
578
- *
579
- * For reference, {@link IValidation.IError.path} would be a little bit different with
580
- * individual {@link validate} function. If the {@link IValidation.IError} occurs from
581
- * the return value, the path would start from `$input.return`.
582
- *
583
- * By the way, if what you want is not finding every type errors, but just finding
584
- * the 1st type error, then use {@link assertReturn} instead. Otherwise, what you want
585
- * is not only validating return value, but also validating parameters, you can use
586
- * {@link validateFunction} instead.
587
- *
588
- * On the other hand, if you don't want to allow any superfluous properties, utilize
589
- * {@link validateEqualsReturn} or {@link assertEqualsReturn} instead.
590
- *
591
- * @template T Target function type
592
- * @param func Target function to validate
593
- * @returns The wrapper function with type validations
594
- *
595
- * @author Jeongho Nam - https://github.com/samchon
596
- */
597
- export function validateReturn<T extends (...args: any[]) => any>(
598
- func: T,
599
- ): T extends (...args: infer Arguments) => infer Output
600
- ? Output extends Promise<infer R>
601
- ? (...args: Arguments) => Promise<IValidation<R>>
602
- : (...args: Arguments) => IValidation<Output>
603
- : never;
604
-
605
- /**
606
- * @internal
607
- */
608
- export function validateReturn(): never {
609
- halt("validateReturn");
610
- }
611
-
612
- /**
613
- * Validates a function with strict equality.
614
- *
615
- * Validates a function with strict equality, by wrapping the function and checking
616
- * its parameters and return value through {@link validateEquals} function. If some
617
- * parameter or return value does not match the expected type, it returns
618
- * {@link IValidation.IError} typed object. Otherwise there's no type error, it
619
- * returns {@link IValidation.ISuccess} typed object instead.
620
- *
621
- * For reference, {@link IValidation.IError.path} would be a little bit different with
622
- * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
623
- * from some parameter, the path would start from `$input.parameters[number]`. Otherwise
624
- * the path would start from `$input.return`.
625
- *
626
- * - `$input.parameters[0].~`
627
- * - `$input.return.~`
628
- *
629
- * By the way, if what you want is not finding every type errors, but just finding
630
- * the 1st type error, then use {@link assertEqualsFunction} instead. Otherwise, what
631
- * you want is just validating parameters or return value only, you can use
632
- * {@link validateEqualsParameters} or {@link validateEqualsReturn} instead.
633
- *
634
- * On the other hand, if you want to allow any superfluous properties, utilize
635
- * {@link validateFunction} or {@link assertFunction} instead.
636
- *
637
- * @template T Target function type
638
- * @param func Target function to validate
639
- * @returns The wrapper function with type validations
640
- *
641
- * @author Jeongho Nam - https://github.com/samchon
642
- */
643
- export function validateEqualsFunction<T extends (...args: any[]) => any>(
644
- func: T,
645
- ): T extends (...args: infer Arguments) => infer Output
646
- ? Output extends Promise<infer R>
647
- ? (...args: Arguments) => Promise<IValidation<R>>
648
- : (...args: Arguments) => IValidation<Output>
649
- : never;
650
-
651
- /**
652
- * @internal
653
- */
654
- export function validateEqualsFunction(): never {
655
- halt("validateEqualsFunction");
656
- }
657
-
658
- /**
659
- * Validates parameters with strict equality.
660
- *
661
- * Validates a function, by wrapping the function and checking its parameters through
662
- * {@link validateEquals} function. If some parameter does not match the expected type,
663
- * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
664
- * it returns {@link IValidation.ISuccess} typed object instead.
665
- *
666
- * For reference, {@link IValidation.IError.path} would be a little bit different with
667
- * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
668
- * from some parameter, the path would start from `$input.parameters[number]`.
669
- *
670
- * By the way, if what you want is not finding every type errors, but just finding
671
- * the 1st type error, then use {@link assertEqualsParameters} instead. Otherwise,
672
- * what you want is not only validating parameters, but also validating return value,
673
- * you can use {@link validateEqualsFunction} instead.
674
- *
675
- * On the other hand, if you want to allow any superfluous properties, utilize
676
- * {@link validateParameters} or {@link assertParameters} instead.
677
- *
678
- * @template T Target function type
679
- * @param func Target function to validate
680
- * @returns The wrapper function with type validations
681
- *
682
- * @author Jeongho Nam - https://github.com/samchon
683
- */
684
- export function validateEqualsParameters<T extends (...args: any[]) => any>(
685
- func: T,
686
- ): T extends (...args: infer Arguments) => infer Output
687
- ? Output extends Promise<infer R>
688
- ? (...args: Arguments) => Promise<IValidation<R>>
689
- : (...args: Arguments) => IValidation<Output>
690
- : never;
691
-
692
- /**
693
- * @internal
694
- */
695
- export function validateEqualsParameters(): never {
696
- halt("validateEqualsParameters");
697
- }
698
-
699
- /**
700
- * Validates return value with strict equality.
701
- *
702
- * Validates a function, by wrapping the function and checking its return value through
703
- * {@link validateEquals} function. If the return value does not match the expected type,
704
- * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
705
- * it returns {@link IValidation.ISuccess} typed object instead.
706
- *
707
- * For reference, {@link IValidation.IError.path} would be a little bit different with
708
- * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
709
- * from the return value, the path would start from `$input.return`.
710
- *
711
- * By the way, if what you want is not finding every type errors, but just finding
712
- * the 1st type error, then use {@link assertEqualsReturn} instead. Otherwise, what you
713
- * want is not only validating return value, but also validating parameters, you can use
714
- * {@link validateEqualsFunction} instead.
715
- *
716
- * On the other hand, if you want to allow any superfluous properties, utilize
717
- * {@link validateReturn} or {@link assertReturn} instead.
718
- *
719
- * @template T Target function type
720
- * @param func Target function to validate
721
- * @returns The wrapper function with type validations
722
- *
723
- * @author Jeongho Nam - https://github.com/samchon
724
- */
725
- export function validateEqualsReturn<T extends (...args: any[]) => any>(
726
- func: T,
727
- ): T extends (...args: infer Arguments) => infer Output
728
- ? Output extends Promise<infer R>
729
- ? (...args: Arguments) => Promise<IValidation<R>>
730
- : (...args: Arguments) => IValidation<Output>
731
- : never;
732
-
733
- /**
734
- * @internal
735
- */
736
- export function validateEqualsReturn(): never {
737
- halt("validateEqualsReturn");
738
- }
739
-
740
- /* -----------------------------------------------------------
741
- HALTER
742
- ----------------------------------------------------------- */
743
- /**
744
- * @internal
745
- */
746
- function halt(name: string): never {
747
- throw new Error(
748
- `Error on typia.functional.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
749
- );
750
- }
1
+ import { IValidation } from "./IValidation";
2
+ import { TypeGuardError } from "./TypeGuardError";
3
+
4
+ /* ===========================================================
5
+ FUNCTIONAL
6
+ - ASSERT
7
+ - IS
8
+ - VALIDATE
9
+ ==============================================================
10
+ ASSERT
11
+ ----------------------------------------------------------- */
12
+ /**
13
+ * Asserts a function.
14
+ *
15
+ * Asserts a function, by wrapping the function and checking its parameters and
16
+ * return value through {@link assert} function. If some parameter or return value
17
+ * does not match the expected type, it throws an {@link TypeGuardError} or a custom
18
+ * error generated by the *errorFactory* parameter.
19
+ *
20
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
21
+ * individual {@link assert} function. If the {@link TypeGuardError} occurs from
22
+ * some parameter, the path would start from `$input.parameters[number]`. Otherwise
23
+ * the path would start from `$input.return`.
24
+ *
25
+ * - `$input.parameters[0].~`
26
+ * - `$input.return.~`
27
+ *
28
+ * By the way, if what you want is not just finding the 1st type error through
29
+ * assertion, but also finding every type errors, then use {@link validateFunction}
30
+ * instead. Otherwise, what you want is just asserting parameters or return value
31
+ * only, you can use {@link assertParameters} or {@link assertReturn} instead.
32
+ *
33
+ * On the other hand, if don't want to allow any superfluous properties, utilize
34
+ * {@link assertEqualsFunction} or {@link validateEqualsFunction} instead.
35
+ *
36
+ * @template T Target function type
37
+ * @param func Target function to assert
38
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
39
+ * @returns The wrapper function with type assertions
40
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
41
+ *
42
+ * @author Jeongho Nam - https://github.com/samchon
43
+ */
44
+ export function assertFunction<T extends (...args: any[]) => any>(
45
+ func: T,
46
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
47
+ ): T;
48
+
49
+ /**
50
+ * @internal
51
+ */
52
+ export function assertFunction(): never {
53
+ halt("assertFunction");
54
+ }
55
+
56
+ /**
57
+ * Asserts parameters.
58
+ *
59
+ * Asserts a function, by wrapping the function and checking its parameters through
60
+ * {@link assert} function. If some parameter does not match the expected type, it
61
+ * throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
62
+ * parameter.
63
+ *
64
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
65
+ * individual {@link assert} function. If the {@link TypeGuardError} occurs from
66
+ * some parameter, the path would start from `$input.parameters[number]`.
67
+ *
68
+ * By the way, if what you want is not just finding the 1st type error through
69
+ * assertion, but also finding every type errors, then use {@link validateParameters}
70
+ * instead. Otherwise, what you want is not only asserting parameters, but also
71
+ * asserting return value, you can use {@link assertFunction} instead.
72
+ *
73
+ * On the other hand, if don't want to allow any superfluous properties, utilize
74
+ * {@link assertEqualsParameters} or {@link validateEqualsParameters} instead.
75
+ *
76
+ * @template T Target function type
77
+ * @param func Target function to assert
78
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
79
+ * @returns The wrapper function with type assertions
80
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
81
+ *
82
+ * @author Jeongho Nam - https://github.com/samchon
83
+ */
84
+ export function assertParameters<T extends (...args: any[]) => any>(
85
+ func: T,
86
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
87
+ ): T;
88
+
89
+ /**
90
+ * @internal
91
+ */
92
+ export function assertParameters(): never {
93
+ halt("assertParameters");
94
+ }
95
+
96
+ /**
97
+ * Asserts return value.
98
+ *
99
+ * Asserts a function, by wrapping the function and checking its return value through
100
+ * {@link assert} function. If the return value does not match the expected type, it
101
+ * throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
102
+ * parameter.
103
+ *
104
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
105
+ * individual {@link assert} function. If the {@link TypeGuardError} occurs from
106
+ * the return value, the path would start from `$input.return`.
107
+ *
108
+ * By the way, if what you want is not just finding the 1st type error through
109
+ * assertion, but also finding every type errors, then use {@link validateReturn}
110
+ * instead. Otherwise, what you want is not only asserting return value, but also
111
+ * asserting parameters, you can use {@link assertFunction} instead.
112
+ *
113
+ * On the other hand, if don't want to allow any superfluous properties, utilize
114
+ * {@link assertEqualsReturn} or {@link validateEqualsReturn} instead.
115
+ *
116
+ * @template T Target function type
117
+ * @param func Target function to assert
118
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
119
+ * @returns The wrapper function with type assertions
120
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
121
+ *
122
+ * @author Jeongho Nam - https://github.com/samchon
123
+ */
124
+ export function assertReturn<T extends (...args: any[]) => any>(
125
+ func: T,
126
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
127
+ ): T;
128
+
129
+ /**
130
+ * @internal
131
+ */
132
+ export function assertReturn(): never {
133
+ halt("assertReturn");
134
+ }
135
+
136
+ /**
137
+ * Asserts a function with strict equality.
138
+ *
139
+ * Asserts a function with strict equality, by wrapping the function and checking
140
+ * its parameters and return value through {@link assertEquals} function. If some
141
+ * parameter or return value does not match the expected type, it throws an
142
+ * {@link TypeGuardError} or a custom error generated by the *errorFactory* parameter.
143
+ *
144
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
145
+ * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
146
+ * some parameter, the path would start from `$input.parameters[number]`. Otherwise
147
+ * the path would start from `$input.return`.
148
+ *
149
+ * - `$input.parameters[0].~`
150
+ * - `$input.return.~`
151
+ *
152
+ * By the way, if what you want is not just finding the 1st type error through
153
+ * assertion, but also finding every type errors, then use
154
+ * {@link validateEqualsFunction} instead. Otherwise, what you want is just asserting
155
+ * parameters or return value only, you can use {@link assertEqualsParameters} or
156
+ * {@link assertEqualsReturn} instead.
157
+ *
158
+ * On the other hand, if you want to allow any superfluous properties, utilize
159
+ * {@link assertFunction} or {@link validateFunction} instead.
160
+ *
161
+ * @template T Target function type
162
+ * @param func Target function to assert
163
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
164
+ * @returns The wrapper function with type assertions
165
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
166
+ *
167
+ * @author Jeongho Nam - https://github.com/samchon
168
+ */
169
+ export function assertEqualsFunction<T extends (...args: any[]) => any>(
170
+ func: T,
171
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
172
+ ): T;
173
+
174
+ /**
175
+ * @internal
176
+ */
177
+ export function assertEqualsFunction(): never {
178
+ halt("assertEqualsFunction");
179
+ }
180
+
181
+ /**
182
+ * Asserts parameters with strict equality.
183
+ *
184
+ * Asserts a function, by wrapping the function and checking its parameters through
185
+ * {@link assertEquals} function. If some parameter does not match the expected type,
186
+ * it throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
187
+ * parameter.
188
+ *
189
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
190
+ * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
191
+ * some parameter, the path would start from `$input.parameters[number]`.
192
+ *
193
+ * By the way, if what you want is not just finding the 1st type error through
194
+ * assertion, but also finding every type errors, then use
195
+ * {@link validateEqualsParameters} instead. Otherwise, what you want is not only
196
+ * asserting parameters, but also asserting return value, you can use
197
+ * {@link assertEqualsFunction} instead.
198
+ *
199
+ * On the other hand, if you want to allow any superfluous properties, utilize
200
+ * {@link assertParameters} or {@link validateParameters} instead.
201
+ *
202
+ * @template T Target function type
203
+ * @param func Target function to assert
204
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
205
+ * @returns The wrapper function with type assertions
206
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
207
+ *
208
+ * @author Jeongho Nam - https://github.com/samchon
209
+ */
210
+ export function assertEqualsParameters<T extends (...args: any[]) => any>(
211
+ func: T,
212
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
213
+ ): T;
214
+
215
+ /**
216
+ * @internal
217
+ */
218
+ export function assertEqualsParameters(): never {
219
+ halt("assertEqualsParameters");
220
+ }
221
+
222
+ /**
223
+ * Asserts return value with strict equality.
224
+ *
225
+ * Asserts a function, by wrapping the function and checking its return value through
226
+ * {@link assertEquals} function. If the return value does not match the expected type,
227
+ * it throws an {@link TypeGuardError} or a custom error generated by the *errorFactory*
228
+ * parameter.
229
+ *
230
+ * For reference, {@link TypeGuardError.path} would be a little bit different with
231
+ * individual {@link assertEquals} function. If the {@link TypeGuardError} occurs from
232
+ * the return value, the path would start from `$input.return`.
233
+ *
234
+ * By the way, if what you want is not just finding the 1st type error through
235
+ * assertion, but also finding every type errors, then use {@link validateEqualsReturn}
236
+ * instead. Otherwise, what you want is not only asserting return value, but also
237
+ * asserting parameters, you can use {@link assertEqualsFunction} instead.
238
+ *
239
+ * On the other hand, if you want to allow any superfluous properties, utilize
240
+ * {@link assertReturn} or {@link validateReturn} instead.
241
+ *
242
+ * @template T Target function type
243
+ * @param func Target function to assert
244
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
245
+ * @returns The wrapper function with type assertions
246
+ * @throws A {@link TypeGuardError} or a custom error generated by *errorFactory*
247
+ *
248
+ * @author Jeongho Nam - https://github.com/samchon
249
+ */
250
+ export function assertEqualsReturn<T extends (...args: any[]) => any>(
251
+ func: T,
252
+ errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error),
253
+ ): T;
254
+
255
+ /**
256
+ * @internal
257
+ */
258
+ export function assertEqualsReturn(): never {
259
+ halt("assertEqualsReturn");
260
+ }
261
+
262
+ /* -----------------------------------------------------------
263
+ IS
264
+ ----------------------------------------------------------- */
265
+ /**
266
+ * Tests a function.
267
+ *
268
+ * Tests a function, by wrapping the function and checking its parameters and
269
+ * return value through {@link is} function. If some parameter or return value
270
+ * does not match the expected type, it returns `null`. Otherwise there's no
271
+ * type error, it returns the result of the function.
272
+ *
273
+ * By the way, if you want is not just testing type checking, but also finding
274
+ * detailed type error reason(s), then use {@link assertFunction} or
275
+ * {@link validateFunction} instead.
276
+ *
277
+ * On the other hand, if you don't want to allow any superfluous properties,
278
+ * utilize {@link equalsFunction}, {@link assertEqualsFunction} or
279
+ * {@link validateEqualsFunction} instead.
280
+ *
281
+ * @template T Target function type
282
+ * @param func Target function to test
283
+ * @returns The wrapper function with type tests
284
+ *
285
+ * @author Jeongho Nam - https://github.com/samchon
286
+ */
287
+ export function isFunction<T extends (...args: any[]) => any>(
288
+ func: T,
289
+ ): T extends (...args: infer Arguments) => infer Output
290
+ ? Output extends Promise<infer R>
291
+ ? (...args: Arguments) => Promise<R | null>
292
+ : (...args: Arguments) => Output | null
293
+ : never;
294
+
295
+ /**
296
+ * @internal
297
+ */
298
+ export function isFunction(): never {
299
+ halt("isFunction");
300
+ }
301
+
302
+ /**
303
+ * Tests parameters.
304
+ *
305
+ * Tests a function, by wrapping the function and checking its parameters through
306
+ * {@link is} function. If some parameter does not match the expected type, it
307
+ * returns `null`. Otherwise there's no type error, it returns the result of the
308
+ * function.
309
+ *
310
+ * By the way, if you want is not just testing type checking, but also finding
311
+ * detailed type error reason(s), then use {@link assertParameters} or
312
+ * {@link validateParameters} instead.
313
+ *
314
+ * On the other hand, if you don't want to allow any superfluous properties,
315
+ * utilize {@link equalsParameters}, {@link assertEqualsParameters} or
316
+ * {@link validateEqualsParameters} instead.
317
+ *
318
+ * @template T Target function type
319
+ * @param func Target function to test
320
+ * @returns The wrapper function with type tests
321
+ *
322
+ * @author Jeongho Nam - https://github.com/samchon
323
+ */
324
+ export function isParameters<T extends (...args: any[]) => any>(
325
+ func: T,
326
+ ): T extends (...args: infer Arguments) => infer Output
327
+ ? Output extends Promise<infer R>
328
+ ? (...args: Arguments) => Promise<R | null>
329
+ : (...args: Arguments) => Output | null
330
+ : never;
331
+
332
+ /**
333
+ * @internal
334
+ */
335
+ export function isParameters(): never {
336
+ halt("isParameters");
337
+ }
338
+
339
+ /**
340
+ * Tests return value.
341
+ *
342
+ * Tests a function, by wrapping the function and checking its return value through
343
+ * {@link is} function. If the return value does not match the expected type, it
344
+ * returns `null`. Otherwise there's no type error, it returns the result of the
345
+ * function.
346
+ *
347
+ * By the way, if you want is not just testing type checking, but also finding
348
+ * detailed type error reason(s), then use {@link assertReturn} or
349
+ * {@link validateReturn} instead.
350
+ *
351
+ * On the other hand, if you don't want to allow any superfluous properties,
352
+ * utilize {@link equalsReturn}, {@link assertEqualsReturn} or
353
+ * {@link validateEqualsReturn} instead.
354
+ *
355
+ * @template T Target function type
356
+ * @param func Target function to test
357
+ * @returns The wrapper function with type tests
358
+ *
359
+ * @author Jeongho Nam - https://github.com/samchon
360
+ */
361
+ export function isReturn<T extends (...args: any[]) => any>(
362
+ func: T,
363
+ ): T extends (...args: infer Arguments) => infer Output
364
+ ? Output extends Promise<infer R>
365
+ ? (...args: Arguments) => Promise<R | null>
366
+ : (...args: Arguments) => Output | null
367
+ : never;
368
+
369
+ /**
370
+ * @internal
371
+ */
372
+ export function isReturn(): never {
373
+ halt("isReturn");
374
+ }
375
+
376
+ /**
377
+ * Tests a function with strict equality.
378
+ *
379
+ * Tests a function with strict equality, by wrapping the function and checking its
380
+ * parameters and return value through {@link isEquals} function. If some parameter
381
+ * or return value does not match the expected type, it returns `null`. Otherwise
382
+ * there's no type error, it returns the result of the function.
383
+ *
384
+ * By the way, if you want is not just testing type checking, but also finding
385
+ * detailed type error reason(s), then use {@link assertEqualsFunction} or
386
+ * {@link validateEqualsFunction} instead.
387
+ *
388
+ * On the other hand, if you want to allow any superfluous properties, utilize
389
+ * {@link isFunction}, {@link assertFunction} or {@link validateFunction} instead.
390
+ *
391
+ * @template T Target function type
392
+ * @param func Target function to test
393
+ * @returns The wrapper function with type tests
394
+ *
395
+ * @author Jeongho Nam - https://github.com/samchon
396
+ */
397
+ export function equalsFunction<T extends (...args: any[]) => any>(
398
+ func: T,
399
+ ): T extends (...args: infer Arguments) => infer Output
400
+ ? Output extends Promise<infer R>
401
+ ? (...args: Arguments) => Promise<R | null>
402
+ : (...args: Arguments) => Output | null
403
+ : never;
404
+
405
+ /**
406
+ * @internal
407
+ */
408
+ export function equalsFunction(): never {
409
+ halt("equalsFunction");
410
+ }
411
+
412
+ /**
413
+ * Tests parameters with strict equality.
414
+ *
415
+ * Tests a function, by wrapping the function and checking its parameters through
416
+ * {@link isEquals} function. If some parameter does not match the expected type,
417
+ * it returns `null`. Otherwise there's no type error, it returns the result of the
418
+ * function.
419
+ *
420
+ * By the way, if you want is not just testing type checking, but also finding
421
+ * detailed type error reason(s), then use {@link assertEqualsParameters} or
422
+ * {@link validateEqualsParameters} instead.
423
+ *
424
+ * @template T Target function type
425
+ * @param func Target function to test
426
+ * @returns The wrapper function with type tests
427
+ *
428
+ * @author Jeongho Nam - https://github.com/samchon
429
+ */
430
+ export function equalsParameters<T extends (...args: any[]) => any>(
431
+ func: T,
432
+ ): T extends (...args: infer Arguments) => infer Output
433
+ ? Output extends Promise<infer R>
434
+ ? (...args: Arguments) => Promise<R | null>
435
+ : (...args: Arguments) => Output | null
436
+ : never;
437
+
438
+ /**
439
+ * @internal
440
+ */
441
+ export function equalsParameters(): never {
442
+ halt("equalsParameters");
443
+ }
444
+
445
+ /**
446
+ * Tests return value with strict equality.
447
+ *
448
+ * Tests a function, by wrapping the function and checking its return value through
449
+ * {@link isEquals} function. If the return value does not match the expected type,
450
+ * it returns `null`. Otherwise there's no type error, it returns the result of the
451
+ * function.
452
+ *
453
+ * By the way, if you want is not just testing type checking, but also finding
454
+ * detailed type error reason(s), then use {@link assertEqualsReturn} or
455
+ * {@link validateEqualsReturn} instead.
456
+ *
457
+ * On the other hand, if you want to allow any superfluous properties, utilize
458
+ * {@link isReturn}, {@link assertReturn} or {@link validateReturn} instead.
459
+ *
460
+ * @template T Target function type
461
+ * @param func Target function to test
462
+ * @returns The wrapper function with type tests
463
+ *
464
+ * @author Jeongho Nam - https://github.com/samchon
465
+ */
466
+ export function equalsReturn<T extends (...args: any[]) => any>(
467
+ func: T,
468
+ ): T extends (...args: infer Arguments) => infer Output
469
+ ? Output extends Promise<infer R>
470
+ ? (...args: Arguments) => Promise<R | null>
471
+ : (...args: Arguments) => Output | null
472
+ : never;
473
+
474
+ /**
475
+ * @internal
476
+ */
477
+ export function equalsReturn(): never {
478
+ halt("equalsReturn");
479
+ }
480
+
481
+ /* -----------------------------------------------------------
482
+ VALIDATE
483
+ ----------------------------------------------------------- */
484
+ /**
485
+ * Validates a function.
486
+ *
487
+ * Validates a function, by wrapping the function and checking its parameters and
488
+ * return value through {@link validate} function. If some parameter or return value
489
+ * does not match the expected type, it returns {@link IValidation.IError} typed
490
+ * object. Otherwise there's no type error, it returns {@link IValidation.ISuccess}
491
+ * typed object instead.
492
+ *
493
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
494
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
495
+ * some parameter, the path would start from `$input.parameters[number]`. Otherwise
496
+ * the path would start from `$input.return`.
497
+ *
498
+ * - `$input.parameters[0].~`
499
+ * - `$input.return.~`
500
+ *
501
+ * By the way, if what you want is not finding every type errors, but just finding
502
+ * the 1st type error, then use {@link assertFunction} instead. Otherwise, what you
503
+ * want is just validating parameters or return value only, you can use
504
+ * {@link validateParameters} or {@link validateReturn} instead.
505
+ *
506
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
507
+ * {@link validateEqualsFunction} or {@link assertEqualsFunction} instead.
508
+ *
509
+ * @template T Target function type
510
+ * @param func Target function to validate
511
+ * @returns The wrapper function with type validations
512
+ *
513
+ * @author Jeongho Nam - https://github.com/samchon
514
+ */
515
+ export function validateFunction<T extends (...args: any[]) => any>(
516
+ func: T,
517
+ ): T extends (...args: infer Arguments) => infer Output
518
+ ? Output extends Promise<infer R>
519
+ ? (...args: Arguments) => Promise<IValidation<R>>
520
+ : (...args: Arguments) => IValidation<Output>
521
+ : never;
522
+
523
+ /**
524
+ * @internal
525
+ */
526
+ export function validateFunction(): never {
527
+ halt("validateFunction");
528
+ }
529
+
530
+ /**
531
+ * Validates parameters.
532
+ *
533
+ * Validates a function, by wrapping the function and checking its parameters through
534
+ * {@link validate} function. If some parameter does not match the expected type, it
535
+ * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
536
+ * it returns {@link IValidation.ISuccess} typed object instead.
537
+ *
538
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
539
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
540
+ * some parameter, the path would start from `$input.parameters[number]`.
541
+ *
542
+ * By the way, if what you want is not finding every type errors, but just finding
543
+ * the 1st type error, then use {@link assertParameters} instead. Otherwise, what you
544
+ * want is not only validating parameters, but also validating return value, you can
545
+ * use {@link validateFunction} instead.
546
+ *
547
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
548
+ * {@link validateEqualsParameters} or {@link assertEqualsParameters} instead.
549
+ *
550
+ * @template T Target function type
551
+ * @param func Target function to validate
552
+ * @returns The wrapper function with type validations
553
+ *
554
+ * @author Jeongho Nam - https://github.com/samchon
555
+ */
556
+ export function validateParameters<T extends (...args: any[]) => any>(
557
+ func: T,
558
+ ): T extends (...args: infer Arguments) => infer Output
559
+ ? Output extends Promise<infer R>
560
+ ? (...args: Arguments) => Promise<IValidation<R>>
561
+ : (...args: Arguments) => IValidation<Output>
562
+ : never;
563
+
564
+ /**
565
+ * @internal
566
+ */
567
+ export function validateParameters(): never {
568
+ halt("validateReturn");
569
+ }
570
+
571
+ /**
572
+ * Validates return value.
573
+ *
574
+ * Validates a function, by wrapping the function and checking its return value through
575
+ * {@link validate} function. If the return value does not match the expected type, it
576
+ * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
577
+ * it returns {@link IValidation.ISuccess} typed object instead.
578
+ *
579
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
580
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
581
+ * the return value, the path would start from `$input.return`.
582
+ *
583
+ * By the way, if what you want is not finding every type errors, but just finding
584
+ * the 1st type error, then use {@link assertReturn} instead. Otherwise, what you want
585
+ * is not only validating return value, but also validating parameters, you can use
586
+ * {@link validateFunction} instead.
587
+ *
588
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
589
+ * {@link validateEqualsReturn} or {@link assertEqualsReturn} instead.
590
+ *
591
+ * @template T Target function type
592
+ * @param func Target function to validate
593
+ * @returns The wrapper function with type validations
594
+ *
595
+ * @author Jeongho Nam - https://github.com/samchon
596
+ */
597
+ export function validateReturn<T extends (...args: any[]) => any>(
598
+ func: T,
599
+ ): T extends (...args: infer Arguments) => infer Output
600
+ ? Output extends Promise<infer R>
601
+ ? (...args: Arguments) => Promise<IValidation<R>>
602
+ : (...args: Arguments) => IValidation<Output>
603
+ : never;
604
+
605
+ /**
606
+ * @internal
607
+ */
608
+ export function validateReturn(): never {
609
+ halt("validateReturn");
610
+ }
611
+
612
+ /**
613
+ * Validates a function with strict equality.
614
+ *
615
+ * Validates a function with strict equality, by wrapping the function and checking
616
+ * its parameters and return value through {@link validateEquals} function. If some
617
+ * parameter or return value does not match the expected type, it returns
618
+ * {@link IValidation.IError} typed object. Otherwise there's no type error, it
619
+ * returns {@link IValidation.ISuccess} typed object instead.
620
+ *
621
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
622
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
623
+ * from some parameter, the path would start from `$input.parameters[number]`. Otherwise
624
+ * the path would start from `$input.return`.
625
+ *
626
+ * - `$input.parameters[0].~`
627
+ * - `$input.return.~`
628
+ *
629
+ * By the way, if what you want is not finding every type errors, but just finding
630
+ * the 1st type error, then use {@link assertEqualsFunction} instead. Otherwise, what
631
+ * you want is just validating parameters or return value only, you can use
632
+ * {@link validateEqualsParameters} or {@link validateEqualsReturn} instead.
633
+ *
634
+ * On the other hand, if you want to allow any superfluous properties, utilize
635
+ * {@link validateFunction} or {@link assertFunction} instead.
636
+ *
637
+ * @template T Target function type
638
+ * @param func Target function to validate
639
+ * @returns The wrapper function with type validations
640
+ *
641
+ * @author Jeongho Nam - https://github.com/samchon
642
+ */
643
+ export function validateEqualsFunction<T extends (...args: any[]) => any>(
644
+ func: T,
645
+ ): T extends (...args: infer Arguments) => infer Output
646
+ ? Output extends Promise<infer R>
647
+ ? (...args: Arguments) => Promise<IValidation<R>>
648
+ : (...args: Arguments) => IValidation<Output>
649
+ : never;
650
+
651
+ /**
652
+ * @internal
653
+ */
654
+ export function validateEqualsFunction(): never {
655
+ halt("validateEqualsFunction");
656
+ }
657
+
658
+ /**
659
+ * Validates parameters with strict equality.
660
+ *
661
+ * Validates a function, by wrapping the function and checking its parameters through
662
+ * {@link validateEquals} function. If some parameter does not match the expected type,
663
+ * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
664
+ * it returns {@link IValidation.ISuccess} typed object instead.
665
+ *
666
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
667
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
668
+ * from some parameter, the path would start from `$input.parameters[number]`.
669
+ *
670
+ * By the way, if what you want is not finding every type errors, but just finding
671
+ * the 1st type error, then use {@link assertEqualsParameters} instead. Otherwise,
672
+ * what you want is not only validating parameters, but also validating return value,
673
+ * you can use {@link validateEqualsFunction} instead.
674
+ *
675
+ * On the other hand, if you want to allow any superfluous properties, utilize
676
+ * {@link validateParameters} or {@link assertParameters} instead.
677
+ *
678
+ * @template T Target function type
679
+ * @param func Target function to validate
680
+ * @returns The wrapper function with type validations
681
+ *
682
+ * @author Jeongho Nam - https://github.com/samchon
683
+ */
684
+ export function validateEqualsParameters<T extends (...args: any[]) => any>(
685
+ func: T,
686
+ ): T extends (...args: infer Arguments) => infer Output
687
+ ? Output extends Promise<infer R>
688
+ ? (...args: Arguments) => Promise<IValidation<R>>
689
+ : (...args: Arguments) => IValidation<Output>
690
+ : never;
691
+
692
+ /**
693
+ * @internal
694
+ */
695
+ export function validateEqualsParameters(): never {
696
+ halt("validateEqualsParameters");
697
+ }
698
+
699
+ /**
700
+ * Validates return value with strict equality.
701
+ *
702
+ * Validates a function, by wrapping the function and checking its return value through
703
+ * {@link validateEquals} function. If the return value does not match the expected type,
704
+ * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
705
+ * it returns {@link IValidation.ISuccess} typed object instead.
706
+ *
707
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
708
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
709
+ * from the return value, the path would start from `$input.return`.
710
+ *
711
+ * By the way, if what you want is not finding every type errors, but just finding
712
+ * the 1st type error, then use {@link assertEqualsReturn} instead. Otherwise, what you
713
+ * want is not only validating return value, but also validating parameters, you can use
714
+ * {@link validateEqualsFunction} instead.
715
+ *
716
+ * On the other hand, if you want to allow any superfluous properties, utilize
717
+ * {@link validateReturn} or {@link assertReturn} instead.
718
+ *
719
+ * @template T Target function type
720
+ * @param func Target function to validate
721
+ * @returns The wrapper function with type validations
722
+ *
723
+ * @author Jeongho Nam - https://github.com/samchon
724
+ */
725
+ export function validateEqualsReturn<T extends (...args: any[]) => any>(
726
+ func: T,
727
+ ): T extends (...args: infer Arguments) => infer Output
728
+ ? Output extends Promise<infer R>
729
+ ? (...args: Arguments) => Promise<IValidation<R>>
730
+ : (...args: Arguments) => IValidation<Output>
731
+ : never;
732
+
733
+ /**
734
+ * @internal
735
+ */
736
+ export function validateEqualsReturn(): never {
737
+ halt("validateEqualsReturn");
738
+ }
739
+
740
+ /* -----------------------------------------------------------
741
+ HALTER
742
+ ----------------------------------------------------------- */
743
+ /**
744
+ * @internal
745
+ */
746
+ function halt(name: string): never {
747
+ throw new Error(
748
+ `Error on typia.functional.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
749
+ );
750
+ }