effect 4.0.0-beta.102 → 4.0.0-beta.103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Array.d.ts +971 -1037
- package/dist/Array.d.ts.map +1 -1
- package/dist/Array.js +381 -407
- package/dist/Array.js.map +1 -1
- package/dist/BigDecimal.d.ts +433 -756
- package/dist/BigDecimal.d.ts.map +1 -1
- package/dist/BigDecimal.js +200 -325
- package/dist/BigDecimal.js.map +1 -1
- package/dist/BigInt.d.ts +207 -267
- package/dist/BigInt.d.ts.map +1 -1
- package/dist/BigInt.js +107 -135
- package/dist/BigInt.js.map +1 -1
- package/dist/Boolean.d.ts +146 -188
- package/dist/Boolean.d.ts.map +1 -1
- package/dist/Boolean.js +64 -84
- package/dist/Boolean.js.map +1 -1
- package/dist/Brand.js.map +1 -1
- package/dist/Cache.d.ts +405 -254
- package/dist/Cache.d.ts.map +1 -1
- package/dist/Cache.js +166 -101
- package/dist/Cache.js.map +1 -1
- package/dist/Cause.d.ts +167 -277
- package/dist/Cause.d.ts.map +1 -1
- package/dist/Cause.js +122 -176
- package/dist/Cause.js.map +1 -1
- package/dist/Channel.d.ts +729 -768
- package/dist/Channel.d.ts.map +1 -1
- package/dist/Channel.js +514 -440
- package/dist/Channel.js.map +1 -1
- package/dist/ChannelSchema.d.ts +1 -1
- package/dist/ChannelSchema.d.ts.map +1 -1
- package/dist/ChannelSchema.js.map +1 -1
- package/dist/Chunk.d.ts +834 -1173
- package/dist/Chunk.d.ts.map +1 -1
- package/dist/Chunk.js +326 -439
- package/dist/Chunk.js.map +1 -1
- package/dist/Clock.d.ts +180 -49
- package/dist/Clock.d.ts.map +1 -1
- package/dist/Clock.js +96 -31
- package/dist/Clock.js.map +1 -1
- package/dist/Combiner.d.ts +20 -33
- package/dist/Combiner.d.ts.map +1 -1
- package/dist/Combiner.js +18 -30
- package/dist/Combiner.js.map +1 -1
- package/dist/Config.d.ts +225 -173
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js +336 -265
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.d.ts +194 -68
- package/dist/ConfigProvider.d.ts.map +1 -1
- package/dist/ConfigProvider.js +115 -80
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Console.d.ts +233 -33
- package/dist/Console.d.ts.map +1 -1
- package/dist/Console.js +232 -32
- package/dist/Console.js.map +1 -1
- package/dist/Context.d.ts +151 -274
- package/dist/Context.d.ts.map +1 -1
- package/dist/Context.js +171 -214
- package/dist/Context.js.map +1 -1
- package/dist/Cron.d.ts +68 -77
- package/dist/Cron.d.ts.map +1 -1
- package/dist/Cron.js +57 -66
- package/dist/Cron.js.map +1 -1
- package/dist/Crypto.d.ts +13 -15
- package/dist/Crypto.d.ts.map +1 -1
- package/dist/Crypto.js +9 -10
- package/dist/Crypto.js.map +1 -1
- package/dist/Data.d.ts +60 -80
- package/dist/Data.d.ts.map +1 -1
- package/dist/Data.js +16 -23
- package/dist/Data.js.map +1 -1
- package/dist/DateTime.d.ts +562 -660
- package/dist/DateTime.d.ts.map +1 -1
- package/dist/DateTime.js +307 -362
- package/dist/DateTime.js.map +1 -1
- package/dist/Deferred.d.ts +253 -256
- package/dist/Deferred.d.ts.map +1 -1
- package/dist/Deferred.js +104 -96
- package/dist/Deferred.js.map +1 -1
- package/dist/Duration.d.ts +216 -308
- package/dist/Duration.d.ts.map +1 -1
- package/dist/Duration.js +132 -186
- package/dist/Duration.js.map +1 -1
- package/dist/Effect.d.ts +2841 -3247
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effect.js +1322 -1546
- package/dist/Effect.js.map +1 -1
- package/dist/Effectable.js.map +1 -1
- package/dist/Encoding.d.ts +22 -40
- package/dist/Encoding.d.ts.map +1 -1
- package/dist/Encoding.js +22 -40
- package/dist/Encoding.js.map +1 -1
- package/dist/Equal.d.ts +33 -37
- package/dist/Equal.d.ts.map +1 -1
- package/dist/Equal.js +29 -21
- package/dist/Equal.js.map +1 -1
- package/dist/Equivalence.d.ts +103 -105
- package/dist/Equivalence.d.ts.map +1 -1
- package/dist/Equivalence.js +77 -79
- package/dist/Equivalence.js.map +1 -1
- package/dist/ErrorReporter.d.ts +51 -27
- package/dist/ErrorReporter.d.ts.map +1 -1
- package/dist/ErrorReporter.js +50 -26
- package/dist/ErrorReporter.js.map +1 -1
- package/dist/ExecutionPlan.d.ts +13 -55
- package/dist/ExecutionPlan.d.ts.map +1 -1
- package/dist/ExecutionPlan.js +7 -28
- package/dist/ExecutionPlan.js.map +1 -1
- package/dist/Exit.d.ts +116 -192
- package/dist/Exit.d.ts.map +1 -1
- package/dist/Exit.js +82 -130
- package/dist/Exit.js.map +1 -1
- package/dist/Fiber.d.ts +82 -146
- package/dist/Fiber.d.ts.map +1 -1
- package/dist/Fiber.js +48 -87
- package/dist/Fiber.js.map +1 -1
- package/dist/FiberHandle.d.ts +152 -105
- package/dist/FiberHandle.d.ts.map +1 -1
- package/dist/FiberHandle.js +106 -73
- package/dist/FiberHandle.js.map +1 -1
- package/dist/FiberMap.d.ts +213 -168
- package/dist/FiberMap.d.ts.map +1 -1
- package/dist/FiberMap.js +114 -89
- package/dist/FiberMap.js.map +1 -1
- package/dist/FiberSet.d.ts +123 -81
- package/dist/FiberSet.d.ts.map +1 -1
- package/dist/FiberSet.js +85 -59
- package/dist/FiberSet.js.map +1 -1
- package/dist/FileSystem.d.ts +153 -264
- package/dist/FileSystem.d.ts.map +1 -1
- package/dist/FileSystem.js +42 -147
- package/dist/FileSystem.js.map +1 -1
- package/dist/Filter.d.ts +61 -33
- package/dist/Filter.d.ts.map +1 -1
- package/dist/Filter.js +26 -15
- package/dist/Filter.js.map +1 -1
- package/dist/Formatter.d.ts +25 -33
- package/dist/Formatter.d.ts.map +1 -1
- package/dist/Formatter.js +48 -49
- package/dist/Formatter.js.map +1 -1
- package/dist/Function.d.ts +76 -145
- package/dist/Function.d.ts.map +1 -1
- package/dist/Function.js +40 -57
- package/dist/Function.js.map +1 -1
- package/dist/Graph.d.ts +360 -714
- package/dist/Graph.d.ts.map +1 -1
- package/dist/Graph.js +168 -297
- package/dist/Graph.js.map +1 -1
- package/dist/HKT.d.ts +12 -6
- package/dist/HKT.d.ts.map +1 -1
- package/dist/Hash.d.ts +47 -83
- package/dist/Hash.d.ts.map +1 -1
- package/dist/Hash.js +46 -68
- package/dist/Hash.js.map +1 -1
- package/dist/HashMap.d.ts +319 -411
- package/dist/HashMap.d.ts.map +1 -1
- package/dist/HashMap.js +122 -166
- package/dist/HashMap.js.map +1 -1
- package/dist/HashRing.d.ts.map +1 -1
- package/dist/HashRing.js +1 -0
- package/dist/HashRing.js.map +1 -1
- package/dist/HashSet.d.ts +177 -284
- package/dist/HashSet.d.ts.map +1 -1
- package/dist/HashSet.js +68 -109
- package/dist/HashSet.js.map +1 -1
- package/dist/Inspectable.d.ts +12 -12
- package/dist/Inspectable.js +8 -8
- package/dist/Inspectable.js.map +1 -1
- package/dist/Iterable.d.ts +620 -786
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Iterable.js +228 -306
- package/dist/Iterable.js.map +1 -1
- package/dist/JsonPatch.d.ts +11 -13
- package/dist/JsonPatch.d.ts.map +1 -1
- package/dist/JsonPatch.js +44 -102
- package/dist/JsonPatch.js.map +1 -1
- package/dist/JsonPointer.d.ts +8 -8
- package/dist/JsonPointer.js +8 -8
- package/dist/JsonPointer.js.map +1 -1
- package/dist/JsonSchema.d.ts +98 -44
- package/dist/JsonSchema.d.ts.map +1 -1
- package/dist/JsonSchema.js +297 -234
- package/dist/JsonSchema.js.map +1 -1
- package/dist/Latch.d.ts +23 -35
- package/dist/Latch.d.ts.map +1 -1
- package/dist/Latch.js +16 -28
- package/dist/Latch.js.map +1 -1
- package/dist/Layer.d.ts +359 -260
- package/dist/Layer.d.ts.map +1 -1
- package/dist/Layer.js +195 -175
- package/dist/Layer.js.map +1 -1
- package/dist/LayerMap.d.ts +42 -29
- package/dist/LayerMap.d.ts.map +1 -1
- package/dist/LayerMap.js +31 -21
- package/dist/LayerMap.js.map +1 -1
- package/dist/LayerRef.d.ts +6 -2
- package/dist/LayerRef.d.ts.map +1 -1
- package/dist/LayerRef.js +6 -2
- package/dist/LayerRef.js.map +1 -1
- package/dist/LogLevel.d.ts +114 -214
- package/dist/LogLevel.d.ts.map +1 -1
- package/dist/LogLevel.js +41 -76
- package/dist/LogLevel.js.map +1 -1
- package/dist/Logger.d.ts +218 -467
- package/dist/Logger.d.ts.map +1 -1
- package/dist/Logger.js +204 -450
- package/dist/Logger.js.map +1 -1
- package/dist/ManagedRuntime.d.ts +7 -5
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/ManagedRuntime.js +7 -5
- package/dist/ManagedRuntime.js.map +1 -1
- package/dist/Match.d.ts +217 -252
- package/dist/Match.d.ts.map +1 -1
- package/dist/Match.js +150 -183
- package/dist/Match.js.map +1 -1
- package/dist/Metric.d.ts +442 -993
- package/dist/Metric.d.ts.map +1 -1
- package/dist/Metric.js +198 -642
- package/dist/Metric.js.map +1 -1
- package/dist/MutableHashMap.d.ts +144 -173
- package/dist/MutableHashMap.d.ts.map +1 -1
- package/dist/MutableHashMap.js +68 -79
- package/dist/MutableHashMap.js.map +1 -1
- package/dist/MutableHashSet.d.ts +84 -89
- package/dist/MutableHashSet.d.ts.map +1 -1
- package/dist/MutableHashSet.js +44 -47
- package/dist/MutableHashSet.js.map +1 -1
- package/dist/MutableList.d.ts +71 -370
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableList.js +59 -284
- package/dist/MutableList.js.map +1 -1
- package/dist/MutableRef.d.ts +420 -243
- package/dist/MutableRef.d.ts.map +1 -1
- package/dist/MutableRef.js +209 -120
- package/dist/MutableRef.js.map +1 -1
- package/dist/Newtype.d.ts +21 -14
- package/dist/Newtype.d.ts.map +1 -1
- package/dist/Newtype.js +15 -13
- package/dist/Newtype.js.map +1 -1
- package/dist/NonEmptyIterable.d.ts +7 -137
- package/dist/NonEmptyIterable.d.ts.map +1 -1
- package/dist/NonEmptyIterable.js +5 -93
- package/dist/NonEmptyIterable.js.map +1 -1
- package/dist/Number.d.ts +196 -233
- package/dist/Number.d.ts.map +1 -1
- package/dist/Number.js +90 -109
- package/dist/Number.js.map +1 -1
- package/dist/Optic.d.ts +97 -189
- package/dist/Optic.d.ts.map +1 -1
- package/dist/Optic.js +187 -290
- package/dist/Optic.js.map +1 -1
- package/dist/Option.d.ts +447 -812
- package/dist/Option.d.ts.map +1 -1
- package/dist/Option.js +211 -392
- package/dist/Option.js.map +1 -1
- package/dist/Order.d.ts +109 -109
- package/dist/Order.js +91 -91
- package/dist/Order.js.map +1 -1
- package/dist/Ordering.d.ts +20 -23
- package/dist/Ordering.d.ts.map +1 -1
- package/dist/Ordering.js +8 -9
- package/dist/Ordering.js.map +1 -1
- package/dist/PartitionedSemaphore.js.map +1 -1
- package/dist/Path.d.ts +38 -41
- package/dist/Path.d.ts.map +1 -1
- package/dist/Path.js +3 -4
- package/dist/Path.js.map +1 -1
- package/dist/Pipeable.d.ts +6 -5
- package/dist/Pipeable.d.ts.map +1 -1
- package/dist/Pipeable.js +2 -2
- package/dist/Pipeable.js.map +1 -1
- package/dist/PlatformError.d.ts +4 -4
- package/dist/PlatformError.js +3 -3
- package/dist/PlatformError.js.map +1 -1
- package/dist/Pool.d.ts +4 -2
- package/dist/Pool.d.ts.map +1 -1
- package/dist/Pool.js +4 -2
- package/dist/Pool.js.map +1 -1
- package/dist/Predicate.d.ts +200 -181
- package/dist/Predicate.d.ts.map +1 -1
- package/dist/Predicate.js +100 -108
- package/dist/Predicate.js.map +1 -1
- package/dist/PrimaryKey.d.ts +7 -7
- package/dist/PrimaryKey.js +5 -5
- package/dist/PrimaryKey.js.map +1 -1
- package/dist/PubSub.d.ts +425 -494
- package/dist/PubSub.d.ts.map +1 -1
- package/dist/PubSub.js +373 -362
- package/dist/PubSub.js.map +1 -1
- package/dist/Pull.d.ts +24 -18
- package/dist/Pull.d.ts.map +1 -1
- package/dist/Pull.js +11 -9
- package/dist/Pull.js.map +1 -1
- package/dist/Queue.d.ts +200 -159
- package/dist/Queue.d.ts.map +1 -1
- package/dist/Queue.js +162 -132
- package/dist/Queue.js.map +1 -1
- package/dist/Random.d.ts +49 -74
- package/dist/Random.d.ts.map +1 -1
- package/dist/Random.js +35 -54
- package/dist/Random.js.map +1 -1
- package/dist/RcMap.d.ts +121 -63
- package/dist/RcMap.d.ts.map +1 -1
- package/dist/RcMap.js +42 -21
- package/dist/RcMap.js.map +1 -1
- package/dist/RcRef.d.ts +24 -13
- package/dist/RcRef.d.ts.map +1 -1
- package/dist/RcRef.js +15 -9
- package/dist/RcRef.js.map +1 -1
- package/dist/Record.d.ts +291 -488
- package/dist/Record.d.ts.map +1 -1
- package/dist/Record.js +111 -202
- package/dist/Record.js.map +1 -1
- package/dist/Redactable.d.ts +6 -2
- package/dist/Redactable.d.ts.map +1 -1
- package/dist/Redactable.js +7 -2
- package/dist/Redactable.js.map +1 -1
- package/dist/Redacted.d.ts +25 -25
- package/dist/Redacted.d.ts.map +1 -1
- package/dist/Redacted.js +19 -20
- package/dist/Redacted.js.map +1 -1
- package/dist/Reducer.d.ts +8 -15
- package/dist/Reducer.d.ts.map +1 -1
- package/dist/Reducer.js +6 -12
- package/dist/Reducer.js.map +1 -1
- package/dist/Ref.d.ts +95 -165
- package/dist/Ref.d.ts.map +1 -1
- package/dist/Ref.js +75 -122
- package/dist/Ref.js.map +1 -1
- package/dist/References.d.ts +102 -168
- package/dist/References.d.ts.map +1 -1
- package/dist/References.js +102 -168
- package/dist/References.js.map +1 -1
- package/dist/RegExp.d.ts +10 -14
- package/dist/RegExp.d.ts.map +1 -1
- package/dist/RegExp.js +10 -14
- package/dist/RegExp.js.map +1 -1
- package/dist/Request.d.ts +31 -21
- package/dist/Request.d.ts.map +1 -1
- package/dist/Request.js +16 -13
- package/dist/Request.js.map +1 -1
- package/dist/RequestResolver.d.ts +201 -90
- package/dist/RequestResolver.d.ts.map +1 -1
- package/dist/RequestResolver.js +87 -41
- package/dist/RequestResolver.js.map +1 -1
- package/dist/Resource.js.map +1 -1
- package/dist/Result.d.ts +302 -470
- package/dist/Result.d.ts.map +1 -1
- package/dist/Result.js +133 -217
- package/dist/Result.js.map +1 -1
- package/dist/Runtime.d.ts +50 -75
- package/dist/Runtime.d.ts.map +1 -1
- package/dist/Runtime.js +39 -60
- package/dist/Runtime.js.map +1 -1
- package/dist/Schedule.d.ts +290 -1636
- package/dist/Schedule.d.ts.map +1 -1
- package/dist/Schedule.js +162 -803
- package/dist/Schedule.js.map +1 -1
- package/dist/Scheduler.d.ts +5 -5
- package/dist/Scheduler.d.ts.map +1 -1
- package/dist/Scheduler.js +18 -6
- package/dist/Scheduler.js.map +1 -1
- package/dist/Schema.d.ts +644 -642
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +491 -527
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +27 -50
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +366 -279
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaError.d.ts +7 -6
- package/dist/SchemaError.d.ts.map +1 -1
- package/dist/SchemaError.js +7 -6
- package/dist/SchemaError.js.map +1 -1
- package/dist/SchemaGetter.d.ts +217 -174
- package/dist/SchemaGetter.d.ts.map +1 -1
- package/dist/SchemaGetter.js +218 -185
- package/dist/SchemaGetter.js.map +1 -1
- package/dist/SchemaIssue.d.ts +62 -190
- package/dist/SchemaIssue.d.ts.map +1 -1
- package/dist/SchemaIssue.js +73 -265
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts +2 -2
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaParser.js +123 -75
- package/dist/SchemaParser.js.map +1 -1
- package/dist/SchemaRepresentation.d.ts +22 -36
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +20 -26
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +114 -74
- package/dist/SchemaTransformation.d.ts.map +1 -1
- package/dist/SchemaTransformation.js +120 -85
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/Scope.d.ts +123 -151
- package/dist/Scope.d.ts.map +1 -1
- package/dist/Scope.js +72 -92
- package/dist/Scope.js.map +1 -1
- package/dist/ScopedCache.js.map +1 -1
- package/dist/ScopedRef.d.ts +3 -3
- package/dist/ScopedRef.js +2 -2
- package/dist/ScopedRef.js.map +1 -1
- package/dist/Semaphore.d.ts +96 -10
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Semaphore.js +78 -39
- package/dist/Semaphore.js.map +1 -1
- package/dist/Sink.d.ts +117 -107
- package/dist/Sink.d.ts.map +1 -1
- package/dist/Sink.js +107 -100
- package/dist/Sink.js.map +1 -1
- package/dist/Stdio.d.ts +1 -1
- package/dist/Stdio.js.map +1 -1
- package/dist/Stream.d.ts +2415 -2949
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +1078 -1381
- package/dist/Stream.js.map +1 -1
- package/dist/String.d.ts +262 -308
- package/dist/String.d.ts.map +1 -1
- package/dist/String.js +184 -215
- package/dist/String.js.map +1 -1
- package/dist/Struct.d.ts +109 -114
- package/dist/Struct.d.ts.map +1 -1
- package/dist/Struct.js +41 -50
- package/dist/Struct.js.map +1 -1
- package/dist/SubscriptionRef.d.ts +282 -250
- package/dist/SubscriptionRef.d.ts.map +1 -1
- package/dist/SubscriptionRef.js +104 -92
- package/dist/SubscriptionRef.js.map +1 -1
- package/dist/Symbol.d.ts +3 -3
- package/dist/Symbol.js +3 -3
- package/dist/Symbol.js.map +1 -1
- package/dist/SynchronizedRef.js.map +1 -1
- package/dist/Take.js.map +1 -1
- package/dist/Terminal.d.ts +2 -2
- package/dist/Terminal.js +1 -1
- package/dist/Terminal.js.map +1 -1
- package/dist/Tracer.d.ts +100 -54
- package/dist/Tracer.d.ts.map +1 -1
- package/dist/Tracer.js +41 -24
- package/dist/Tracer.js.map +1 -1
- package/dist/Trie.d.ts +287 -679
- package/dist/Trie.d.ts.map +1 -1
- package/dist/Trie.js +109 -251
- package/dist/Trie.js.map +1 -1
- package/dist/Tuple.d.ts +92 -127
- package/dist/Tuple.d.ts.map +1 -1
- package/dist/Tuple.js +42 -57
- package/dist/Tuple.js.map +1 -1
- package/dist/TxChunk.d.ts +201 -121
- package/dist/TxChunk.d.ts.map +1 -1
- package/dist/TxChunk.js +85 -56
- package/dist/TxChunk.js.map +1 -1
- package/dist/TxDeferred.d.ts +62 -46
- package/dist/TxDeferred.d.ts.map +1 -1
- package/dist/TxDeferred.js +30 -22
- package/dist/TxDeferred.js.map +1 -1
- package/dist/TxHashMap.d.ts +631 -779
- package/dist/TxHashMap.d.ts.map +1 -1
- package/dist/TxHashMap.js +268 -330
- package/dist/TxHashMap.js.map +1 -1
- package/dist/TxHashSet.d.ts +297 -236
- package/dist/TxHashSet.d.ts.map +1 -1
- package/dist/TxHashSet.js +130 -100
- package/dist/TxHashSet.js.map +1 -1
- package/dist/TxPriorityQueue.d.ts +126 -95
- package/dist/TxPriorityQueue.d.ts.map +1 -1
- package/dist/TxPriorityQueue.js +74 -56
- package/dist/TxPriorityQueue.js.map +1 -1
- package/dist/TxPubSub.d.ts +101 -88
- package/dist/TxPubSub.d.ts.map +1 -1
- package/dist/TxPubSub.js +87 -66
- package/dist/TxPubSub.js.map +1 -1
- package/dist/TxQueue.d.ts +200 -180
- package/dist/TxQueue.d.ts.map +1 -1
- package/dist/TxQueue.js +160 -136
- package/dist/TxQueue.js.map +1 -1
- package/dist/TxReentrantLock.d.ts +97 -66
- package/dist/TxReentrantLock.d.ts.map +1 -1
- package/dist/TxReentrantLock.js +67 -45
- package/dist/TxReentrantLock.js.map +1 -1
- package/dist/TxRef.d.ts +51 -32
- package/dist/TxRef.d.ts.map +1 -1
- package/dist/TxRef.js +23 -15
- package/dist/TxRef.js.map +1 -1
- package/dist/TxSemaphore.d.ts +129 -95
- package/dist/TxSemaphore.d.ts.map +1 -1
- package/dist/TxSemaphore.js +85 -70
- package/dist/TxSemaphore.js.map +1 -1
- package/dist/TxSubscriptionRef.d.ts +97 -70
- package/dist/TxSubscriptionRef.d.ts.map +1 -1
- package/dist/TxSubscriptionRef.js +44 -34
- package/dist/TxSubscriptionRef.js.map +1 -1
- package/dist/Types.d.ts +126 -67
- package/dist/Types.d.ts.map +1 -1
- package/dist/UndefinedOr.js.map +1 -1
- package/dist/Unify.d.ts +45 -65
- package/dist/Unify.d.ts.map +1 -1
- package/dist/Unify.js +6 -9
- package/dist/Unify.js.map +1 -1
- package/dist/Utils.d.ts +23 -16
- package/dist/Utils.d.ts.map +1 -1
- package/dist/Utils.js +3 -7
- package/dist/Utils.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/internal/array.js.map +1 -1
- package/dist/internal/core.js +1 -1
- package/dist/internal/core.js.map +1 -1
- package/dist/internal/dateTime.js +4 -0
- package/dist/internal/dateTime.js.map +1 -1
- package/dist/internal/doNotation.js.map +1 -1
- package/dist/internal/effect.js +77 -40
- package/dist/internal/effect.js.map +1 -1
- package/dist/internal/equal.js.map +1 -1
- package/dist/internal/errors.js.map +1 -1
- package/dist/internal/executionPlan.js.map +1 -1
- package/dist/internal/hashMap.js.map +1 -1
- package/dist/internal/hashSet.js.map +1 -1
- package/dist/internal/layer.js.map +1 -1
- package/dist/internal/matcher.js.map +1 -1
- package/dist/internal/metric.js.map +1 -1
- package/dist/internal/option.js.map +1 -1
- package/dist/internal/persistence.d.ts +2 -0
- package/dist/internal/persistence.d.ts.map +1 -0
- package/dist/internal/persistence.js +3 -0
- package/dist/internal/persistence.js.map +1 -0
- package/dist/internal/random.js.map +1 -1
- package/dist/internal/rcRef.js.map +1 -1
- package/dist/internal/record.js.map +1 -1
- package/dist/internal/redacted.js.map +1 -1
- package/dist/internal/references.js +3 -0
- package/dist/internal/references.js.map +1 -1
- package/dist/internal/request.js.map +1 -1
- package/dist/internal/result.js.map +1 -1
- package/dist/internal/schedule.js.map +1 -1
- package/dist/internal/schema/annotations.js.map +1 -1
- package/dist/internal/schema/cause.js.map +1 -1
- package/dist/internal/schema/fromJsonSchemaDocument.js +13 -11
- package/dist/internal/schema/fromJsonSchemaDocument.js.map +1 -1
- package/dist/internal/schema/fromRepresentation.js +8 -15
- package/dist/internal/schema/fromRepresentation.js.map +1 -1
- package/dist/internal/schema/parser.d.ts +14 -0
- package/dist/internal/schema/parser.d.ts.map +1 -0
- package/dist/internal/schema/parser.js +13 -0
- package/dist/internal/schema/parser.js.map +1 -0
- package/dist/internal/schema/schema.js.map +1 -1
- package/dist/internal/schema/toArbitrary.js.map +1 -1
- package/dist/internal/schema/toCodeDocument.js.map +1 -1
- package/dist/internal/schema/toEquivalence.js.map +1 -1
- package/dist/internal/schema/toJsonSchemaDocument.js +48 -6
- package/dist/internal/schema/toJsonSchemaDocument.js.map +1 -1
- package/dist/internal/schema/toRepresentation.js +87 -107
- package/dist/internal/schema/toRepresentation.js.map +1 -1
- package/dist/internal/stackTraceLimit.js.map +1 -1
- package/dist/internal/stream.js.map +1 -1
- package/dist/internal/tracer.js.map +1 -1
- package/dist/internal/trie.js +13 -9
- package/dist/internal/trie.js.map +1 -1
- package/dist/testing/FastCheck.d.ts +8 -7
- package/dist/testing/FastCheck.d.ts.map +1 -1
- package/dist/testing/FastCheck.js +8 -7
- package/dist/testing/FastCheck.js.map +1 -1
- package/dist/testing/TestClock.d.ts +57 -28
- package/dist/testing/TestClock.d.ts.map +1 -1
- package/dist/testing/TestClock.js +50 -18
- package/dist/testing/TestClock.js.map +1 -1
- package/dist/testing/TestConsole.d.ts +32 -31
- package/dist/testing/TestConsole.d.ts.map +1 -1
- package/dist/testing/TestConsole.js +24 -22
- package/dist/testing/TestConsole.js.map +1 -1
- package/dist/testing/TestSchema.d.ts +29 -29
- package/dist/testing/TestSchema.js +25 -25
- package/dist/testing/TestSchema.js.map +1 -1
- package/dist/testing/index.js.map +1 -1
- package/dist/unstable/ai/AiError.d.ts +95 -118
- package/dist/unstable/ai/AiError.d.ts.map +1 -1
- package/dist/unstable/ai/AiError.js +94 -117
- package/dist/unstable/ai/AiError.js.map +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.d.ts +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.js +1 -1
- package/dist/unstable/ai/AnthropicStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/Chat.d.ts +132 -97
- package/dist/unstable/ai/Chat.d.ts.map +1 -1
- package/dist/unstable/ai/Chat.js +55 -51
- package/dist/unstable/ai/Chat.js.map +1 -1
- package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
- package/dist/unstable/ai/IdGenerator.d.ts +32 -28
- package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
- package/dist/unstable/ai/IdGenerator.js +26 -21
- package/dist/unstable/ai/IdGenerator.js.map +1 -1
- package/dist/unstable/ai/LanguageModel.d.ts +107 -67
- package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
- package/dist/unstable/ai/LanguageModel.js +104 -64
- package/dist/unstable/ai/LanguageModel.js.map +1 -1
- package/dist/unstable/ai/McpProtocol.d.ts +30 -0
- package/dist/unstable/ai/McpProtocol.d.ts.map +1 -0
- package/dist/unstable/ai/McpProtocol.js +20 -0
- package/dist/unstable/ai/McpProtocol.js.map +1 -0
- package/dist/unstable/ai/McpSchema.d.ts +141 -75
- package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
- package/dist/unstable/ai/McpSchema.js +58 -50
- package/dist/unstable/ai/McpSchema.js.map +1 -1
- package/dist/unstable/ai/McpServer.d.ts +68 -59
- package/dist/unstable/ai/McpServer.d.ts.map +1 -1
- package/dist/unstable/ai/McpServer.js +694 -241
- package/dist/unstable/ai/McpServer.js.map +1 -1
- package/dist/unstable/ai/Model.d.ts +8 -19
- package/dist/unstable/ai/Model.d.ts.map +1 -1
- package/dist/unstable/ai/Model.js +9 -20
- package/dist/unstable/ai/Model.js.map +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.d.ts +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.js +1 -1
- package/dist/unstable/ai/OpenAiStructuredOutput.js.map +1 -1
- package/dist/unstable/ai/Prompt.d.ts +112 -38
- package/dist/unstable/ai/Prompt.d.ts.map +1 -1
- package/dist/unstable/ai/Prompt.js +53 -17
- package/dist/unstable/ai/Prompt.js.map +1 -1
- package/dist/unstable/ai/Response.d.ts +28 -14
- package/dist/unstable/ai/Response.d.ts.map +1 -1
- package/dist/unstable/ai/Response.js +9 -4
- package/dist/unstable/ai/Response.js.map +1 -1
- package/dist/unstable/ai/ResponseIdTracker.js.map +1 -1
- package/dist/unstable/ai/Telemetry.d.ts +46 -13
- package/dist/unstable/ai/Telemetry.d.ts.map +1 -1
- package/dist/unstable/ai/Telemetry.js +18 -7
- package/dist/unstable/ai/Telemetry.js.map +1 -1
- package/dist/unstable/ai/Tokenizer.d.ts +14 -3
- package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
- package/dist/unstable/ai/Tokenizer.js +10 -2
- package/dist/unstable/ai/Tokenizer.js.map +1 -1
- package/dist/unstable/ai/Tool.d.ts +59 -44
- package/dist/unstable/ai/Tool.d.ts.map +1 -1
- package/dist/unstable/ai/Tool.js +48 -39
- package/dist/unstable/ai/Tool.js.map +1 -1
- package/dist/unstable/ai/Toolkit.d.ts +26 -8
- package/dist/unstable/ai/Toolkit.d.ts.map +1 -1
- package/dist/unstable/ai/Toolkit.js +18 -4
- package/dist/unstable/ai/Toolkit.js.map +1 -1
- package/dist/unstable/ai/index.d.ts +4 -0
- package/dist/unstable/ai/index.d.ts.map +1 -1
- package/dist/unstable/ai/index.js +4 -0
- package/dist/unstable/ai/index.js.map +1 -1
- package/dist/unstable/ai/internal/codec-transformer.js.map +1 -1
- package/dist/unstable/ai/internal/mcpProtocol.d.ts +21 -0
- package/dist/unstable/ai/internal/mcpProtocol.d.ts.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocol.js +22 -0
- package/dist/unstable/ai/internal/mcpProtocol.js.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.d.ts +2 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.d.ts.map +1 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.js +32 -0
- package/dist/unstable/ai/internal/mcpProtocolRegistry.js.map +1 -0
- package/dist/unstable/ai/internal/structured-output.js +14 -15
- package/dist/unstable/ai/internal/structured-output.js.map +1 -1
- package/dist/unstable/cli/Argument.d.ts +273 -69
- package/dist/unstable/cli/Argument.d.ts.map +1 -1
- package/dist/unstable/cli/Argument.js +111 -33
- package/dist/unstable/cli/Argument.js.map +1 -1
- package/dist/unstable/cli/CliConfig.js.map +1 -1
- package/dist/unstable/cli/CliError.d.ts +69 -76
- package/dist/unstable/cli/CliError.d.ts.map +1 -1
- package/dist/unstable/cli/CliError.js +57 -61
- package/dist/unstable/cli/CliError.js.map +1 -1
- package/dist/unstable/cli/CliOutput.d.ts +35 -54
- package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
- package/dist/unstable/cli/CliOutput.js +26 -42
- package/dist/unstable/cli/CliOutput.js.map +1 -1
- package/dist/unstable/cli/Command.d.ts +705 -107
- package/dist/unstable/cli/Command.d.ts.map +1 -1
- package/dist/unstable/cli/Command.js +238 -42
- package/dist/unstable/cli/Command.js.map +1 -1
- package/dist/unstable/cli/Completions.js.map +1 -1
- package/dist/unstable/cli/Flag.d.ts +418 -138
- package/dist/unstable/cli/Flag.d.ts.map +1 -1
- package/dist/unstable/cli/Flag.js +197 -71
- package/dist/unstable/cli/Flag.js.map +1 -1
- package/dist/unstable/cli/GlobalFlag.d.ts +1 -1
- package/dist/unstable/cli/GlobalFlag.js.map +1 -1
- package/dist/unstable/cli/HelpDoc.d.ts +12 -4
- package/dist/unstable/cli/HelpDoc.d.ts.map +1 -1
- package/dist/unstable/cli/Param.d.ts +292 -78
- package/dist/unstable/cli/Param.d.ts.map +1 -1
- package/dist/unstable/cli/Param.js +128 -46
- package/dist/unstable/cli/Param.js.map +1 -1
- package/dist/unstable/cli/Primitive.d.ts +370 -149
- package/dist/unstable/cli/Primitive.d.ts.map +1 -1
- package/dist/unstable/cli/Primitive.js +344 -136
- package/dist/unstable/cli/Primitive.js.map +1 -1
- package/dist/unstable/cli/Prompt.d.ts +23 -14
- package/dist/unstable/cli/Prompt.d.ts.map +1 -1
- package/dist/unstable/cli/Prompt.js +23 -14
- package/dist/unstable/cli/Prompt.js.map +1 -1
- package/dist/unstable/cli/index.js.map +1 -1
- package/dist/unstable/cli/internal/ansi.js.map +1 -1
- package/dist/unstable/cli/internal/auto-suggest.js.map +1 -1
- package/dist/unstable/cli/internal/command.js.map +1 -1
- package/dist/unstable/cli/internal/completions/bash.js.map +1 -1
- package/dist/unstable/cli/internal/completions/descriptor.js.map +1 -1
- package/dist/unstable/cli/internal/completions/fish.js.map +1 -1
- package/dist/unstable/cli/internal/completions/zsh.js.map +1 -1
- package/dist/unstable/cli/internal/config.js.map +1 -1
- package/dist/unstable/cli/internal/help.js.map +1 -1
- package/dist/unstable/cli/internal/lexer.js +17 -7
- package/dist/unstable/cli/internal/lexer.js.map +1 -1
- package/dist/unstable/cli/internal/parser.js +2 -2
- package/dist/unstable/cli/internal/parser.js.map +1 -1
- package/dist/unstable/cli/internal/wizard.js.map +1 -1
- package/dist/unstable/cluster/ClusterCron.js.map +1 -1
- package/dist/unstable/cluster/ClusterError.js.map +1 -1
- package/dist/unstable/cluster/ClusterMetrics.js.map +1 -1
- package/dist/unstable/cluster/ClusterSchema.d.ts +8 -8
- package/dist/unstable/cluster/ClusterSchema.js +8 -8
- package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js +5 -1
- package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
- package/dist/unstable/cluster/DeliverAt.js.map +1 -1
- package/dist/unstable/cluster/Entity.d.ts +10 -10
- package/dist/unstable/cluster/Entity.d.ts.map +1 -1
- package/dist/unstable/cluster/Entity.js +8 -8
- package/dist/unstable/cluster/Entity.js.map +1 -1
- package/dist/unstable/cluster/EntityAddress.js.map +1 -1
- package/dist/unstable/cluster/EntityId.js.map +1 -1
- package/dist/unstable/cluster/EntityProxy.d.ts +4 -2
- package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxy.js +4 -2
- package/dist/unstable/cluster/EntityProxy.js.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.js.map +1 -1
- package/dist/unstable/cluster/EntityResource.d.ts +2 -2
- package/dist/unstable/cluster/EntityResource.js +2 -2
- package/dist/unstable/cluster/EntityResource.js.map +1 -1
- package/dist/unstable/cluster/EntityType.js.map +1 -1
- package/dist/unstable/cluster/Envelope.d.ts +3 -3
- package/dist/unstable/cluster/Envelope.js +3 -3
- package/dist/unstable/cluster/Envelope.js.map +1 -1
- package/dist/unstable/cluster/HttpRunner.d.ts +2 -2
- package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
- package/dist/unstable/cluster/HttpRunner.js +6 -4
- package/dist/unstable/cluster/HttpRunner.js.map +1 -1
- package/dist/unstable/cluster/K8sHttpClient.js.map +1 -1
- package/dist/unstable/cluster/MachineId.js.map +1 -1
- package/dist/unstable/cluster/Message.d.ts +9 -9
- package/dist/unstable/cluster/Message.js +6 -6
- package/dist/unstable/cluster/Message.js.map +1 -1
- package/dist/unstable/cluster/MessageStorage.d.ts +15 -15
- package/dist/unstable/cluster/MessageStorage.js +5 -5
- package/dist/unstable/cluster/MessageStorage.js.map +1 -1
- package/dist/unstable/cluster/Reply.d.ts.map +1 -1
- package/dist/unstable/cluster/Reply.js +4 -4
- package/dist/unstable/cluster/Reply.js.map +1 -1
- package/dist/unstable/cluster/Runner.js.map +1 -1
- package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
- package/dist/unstable/cluster/RunnerHealth.d.ts +1 -1
- package/dist/unstable/cluster/RunnerHealth.js +1 -1
- package/dist/unstable/cluster/RunnerHealth.js.map +1 -1
- package/dist/unstable/cluster/RunnerServer.d.ts +2 -1
- package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
- package/dist/unstable/cluster/RunnerServer.js +16 -16
- package/dist/unstable/cluster/RunnerServer.js.map +1 -1
- package/dist/unstable/cluster/RunnerStorage.d.ts +2 -2
- package/dist/unstable/cluster/RunnerStorage.js +1 -1
- package/dist/unstable/cluster/RunnerStorage.js.map +1 -1
- package/dist/unstable/cluster/Runners.d.ts +6 -6
- package/dist/unstable/cluster/Runners.d.ts.map +1 -1
- package/dist/unstable/cluster/Runners.js +19 -10
- package/dist/unstable/cluster/Runners.js.map +1 -1
- package/dist/unstable/cluster/ShardId.js.map +1 -1
- package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
- package/dist/unstable/cluster/Sharding.js +3 -2
- package/dist/unstable/cluster/Sharding.js.map +1 -1
- package/dist/unstable/cluster/ShardingConfig.d.ts +3 -3
- package/dist/unstable/cluster/ShardingConfig.js +3 -3
- package/dist/unstable/cluster/ShardingConfig.js.map +1 -1
- package/dist/unstable/cluster/ShardingRegistrationEvent.js.map +1 -1
- package/dist/unstable/cluster/SingleRunner.js.map +1 -1
- package/dist/unstable/cluster/Singleton.js.map +1 -1
- package/dist/unstable/cluster/SingletonAddress.d.ts +1 -1
- package/dist/unstable/cluster/SingletonAddress.js +1 -1
- package/dist/unstable/cluster/SingletonAddress.js.map +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts +8 -8
- package/dist/unstable/cluster/Snowflake.js +8 -8
- package/dist/unstable/cluster/Snowflake.js.map +1 -1
- package/dist/unstable/cluster/SocketRunner.js.map +1 -1
- package/dist/unstable/cluster/SqlMessageStorage.js +1 -1
- package/dist/unstable/cluster/SqlMessageStorage.js.map +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/SqlRunnerStorage.js +20 -5
- package/dist/unstable/cluster/SqlRunnerStorage.js.map +1 -1
- package/dist/unstable/cluster/TestRunner.js.map +1 -1
- package/dist/unstable/cluster/index.js.map +1 -1
- package/dist/unstable/cluster/internal/entityManager.js +5 -5
- package/dist/unstable/cluster/internal/entityManager.js.map +1 -1
- package/dist/unstable/cluster/internal/entityReaper.js.map +1 -1
- package/dist/unstable/cluster/internal/hash.js.map +1 -1
- package/dist/unstable/cluster/internal/interruptors.js.map +1 -1
- package/dist/unstable/cluster/internal/resourceMap.js.map +1 -1
- package/dist/unstable/cluster/internal/resourceRef.js.map +1 -1
- package/dist/unstable/cluster/internal/shardLock.js.map +1 -1
- package/dist/unstable/devtools/DevTools.js.map +1 -1
- package/dist/unstable/devtools/DevToolsClient.js.map +1 -1
- package/dist/unstable/devtools/DevToolsSchema.js.map +1 -1
- package/dist/unstable/devtools/DevToolsServer.js.map +1 -1
- package/dist/unstable/devtools/index.js.map +1 -1
- package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
- package/dist/unstable/encoding/Msgpack.js +6 -8
- package/dist/unstable/encoding/Msgpack.js.map +1 -1
- package/dist/unstable/encoding/Ndjson.js.map +1 -1
- package/dist/unstable/encoding/Sse.d.ts +72 -8
- package/dist/unstable/encoding/Sse.d.ts.map +1 -1
- package/dist/unstable/encoding/Sse.js +58 -8
- package/dist/unstable/encoding/Sse.js.map +1 -1
- package/dist/unstable/encoding/index.js.map +1 -1
- package/dist/unstable/eventlog/Event.d.ts +20 -20
- package/dist/unstable/eventlog/Event.js.map +1 -1
- package/dist/unstable/eventlog/EventGroup.d.ts +4 -4
- package/dist/unstable/eventlog/EventGroup.js.map +1 -1
- package/dist/unstable/eventlog/EventJournal.d.ts +15 -15
- package/dist/unstable/eventlog/EventJournal.js +13 -13
- package/dist/unstable/eventlog/EventJournal.js.map +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts +3 -3
- package/dist/unstable/eventlog/EventLog.js +3 -3
- package/dist/unstable/eventlog/EventLog.js.map +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.js +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
- package/dist/unstable/eventlog/EventLogMessage.d.ts +2 -2
- package/dist/unstable/eventlog/EventLogMessage.js +1 -1
- package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +15 -15
- package/dist/unstable/eventlog/EventLogRemote.js +1 -1
- package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServer.d.ts +11 -2
- package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServer.js +45 -21
- package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +4 -4
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServerEncrypted.js +13 -5
- package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +5 -5
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js +14 -6
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.js +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.js.map +1 -1
- package/dist/unstable/eventlog/SqlEventJournal.js.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerEncrypted.js.map +1 -1
- package/dist/unstable/eventlog/SqlEventLogServerUnencrypted.js.map +1 -1
- package/dist/unstable/eventlog/index.js.map +1 -1
- package/dist/unstable/eventlog/internal/identityRootSecretDerivation.js.map +1 -1
- package/dist/unstable/http/Cookies.d.ts +2 -2
- package/dist/unstable/http/Cookies.d.ts.map +1 -1
- package/dist/unstable/http/Cookies.js +30 -18
- package/dist/unstable/http/Cookies.js.map +1 -1
- package/dist/unstable/http/Etag.d.ts +1 -1
- package/dist/unstable/http/Etag.js +1 -1
- package/dist/unstable/http/Etag.js.map +1 -1
- package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
- package/dist/unstable/http/FetchHttpClient.js.map +1 -1
- package/dist/unstable/http/Headers.d.ts +2 -2
- package/dist/unstable/http/Headers.js +2 -2
- package/dist/unstable/http/Headers.js.map +1 -1
- package/dist/unstable/http/HttpBody.d.ts +5 -3
- package/dist/unstable/http/HttpBody.d.ts.map +1 -1
- package/dist/unstable/http/HttpBody.js +11 -5
- package/dist/unstable/http/HttpBody.js.map +1 -1
- package/dist/unstable/http/HttpClient.d.ts +51 -44
- package/dist/unstable/http/HttpClient.d.ts.map +1 -1
- package/dist/unstable/http/HttpClient.js +46 -17
- package/dist/unstable/http/HttpClient.js.map +1 -1
- package/dist/unstable/http/HttpClientError.js.map +1 -1
- package/dist/unstable/http/HttpClientRequest.d.ts.map +1 -1
- package/dist/unstable/http/HttpClientRequest.js +2 -0
- package/dist/unstable/http/HttpClientRequest.js.map +1 -1
- package/dist/unstable/http/HttpClientResponse.d.ts +4 -4
- package/dist/unstable/http/HttpClientResponse.js +2 -2
- package/dist/unstable/http/HttpClientResponse.js.map +1 -1
- package/dist/unstable/http/HttpEffect.d.ts +6 -6
- package/dist/unstable/http/HttpEffect.js +3 -3
- package/dist/unstable/http/HttpEffect.js.map +1 -1
- package/dist/unstable/http/HttpIncomingMessage.js.map +1 -1
- package/dist/unstable/http/HttpMethod.d.ts +6 -9
- package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
- package/dist/unstable/http/HttpMethod.js +6 -9
- package/dist/unstable/http/HttpMethod.js.map +1 -1
- package/dist/unstable/http/HttpMiddleware.d.ts +75 -9
- package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
- package/dist/unstable/http/HttpMiddleware.js +164 -39
- package/dist/unstable/http/HttpMiddleware.js.map +1 -1
- package/dist/unstable/http/HttpPlatform.d.ts +76 -0
- package/dist/unstable/http/HttpPlatform.d.ts.map +1 -1
- package/dist/unstable/http/HttpPlatform.js +32 -0
- package/dist/unstable/http/HttpPlatform.js.map +1 -1
- package/dist/unstable/http/HttpRouter.d.ts +88 -89
- package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
- package/dist/unstable/http/HttpRouter.js +78 -79
- package/dist/unstable/http/HttpRouter.js.map +1 -1
- package/dist/unstable/http/HttpServer.d.ts +13 -13
- package/dist/unstable/http/HttpServer.js +6 -6
- package/dist/unstable/http/HttpServer.js.map +1 -1
- package/dist/unstable/http/HttpServerError.d.ts +2 -2
- package/dist/unstable/http/HttpServerError.js +2 -2
- package/dist/unstable/http/HttpServerError.js.map +1 -1
- package/dist/unstable/http/HttpServerRequest.d.ts +4 -4
- package/dist/unstable/http/HttpServerRequest.js +4 -4
- package/dist/unstable/http/HttpServerRequest.js.map +1 -1
- package/dist/unstable/http/HttpServerRespondable.js.map +1 -1
- package/dist/unstable/http/HttpServerResponse.d.ts +22 -0
- package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerResponse.js +10 -0
- package/dist/unstable/http/HttpServerResponse.js.map +1 -1
- package/dist/unstable/http/HttpStaticServer.d.ts +35 -7
- package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
- package/dist/unstable/http/HttpStaticServer.js +35 -7
- package/dist/unstable/http/HttpStaticServer.js.map +1 -1
- package/dist/unstable/http/HttpTraceContext.js.map +1 -1
- package/dist/unstable/http/Multipart.d.ts +6 -6
- package/dist/unstable/http/Multipart.js +5 -5
- package/dist/unstable/http/Multipart.js.map +1 -1
- package/dist/unstable/http/Template.js.map +1 -1
- package/dist/unstable/http/Url.d.ts +33 -63
- package/dist/unstable/http/Url.d.ts.map +1 -1
- package/dist/unstable/http/Url.js +14 -28
- package/dist/unstable/http/Url.js.map +1 -1
- package/dist/unstable/http/UrlParams.d.ts +10 -18
- package/dist/unstable/http/UrlParams.d.ts.map +1 -1
- package/dist/unstable/http/UrlParams.js +9 -17
- package/dist/unstable/http/UrlParams.js.map +1 -1
- package/dist/unstable/http/index.js.map +1 -1
- package/dist/unstable/http/internal/compression.d.ts +2 -0
- package/dist/unstable/http/internal/compression.d.ts.map +1 -0
- package/dist/unstable/http/internal/compression.js +155 -0
- package/dist/unstable/http/internal/compression.js.map +1 -0
- package/dist/unstable/http/internal/preResponseHandler.js.map +1 -1
- package/dist/unstable/httpapi/HttpApi.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.js +10 -11
- package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.d.ts +4 -5
- package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.js +11 -13
- package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiEndpoint.d.ts +42 -42
- package/dist/unstable/httpapi/HttpApiEndpoint.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiError.d.ts +13 -13
- package/dist/unstable/httpapi/HttpApiError.js +13 -13
- package/dist/unstable/httpapi/HttpApiError.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiGroup.d.ts +15 -15
- package/dist/unstable/httpapi/HttpApiGroup.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +71 -24
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.js +57 -10
- package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.d.ts +0 -12
- package/dist/unstable/httpapi/HttpApiScalar.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSchema.d.ts +6 -6
- package/dist/unstable/httpapi/HttpApiSchema.js +4 -4
- package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiTest.js.map +1 -1
- package/dist/unstable/httpapi/OpenApi.d.ts +13 -13
- package/dist/unstable/httpapi/OpenApi.js +13 -13
- package/dist/unstable/httpapi/OpenApi.js.map +1 -1
- package/dist/unstable/httpapi/index.js.map +1 -1
- package/dist/unstable/httpapi/internal/html.js.map +1 -1
- package/dist/unstable/httpapi/internal/httpApiScalar.js.map +1 -1
- package/dist/unstable/httpapi/internal/httpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/internal/mediaType.js.map +1 -1
- package/dist/unstable/observability/Otlp.js.map +1 -1
- package/dist/unstable/observability/OtlpExporter.d.ts +12 -14
- package/dist/unstable/observability/OtlpExporter.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpExporter.js +17 -4
- package/dist/unstable/observability/OtlpExporter.js.map +1 -1
- package/dist/unstable/observability/OtlpLogger.js.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.d.ts +4 -1
- package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.js.map +1 -1
- package/dist/unstable/observability/OtlpResource.d.ts +16 -7
- package/dist/unstable/observability/OtlpResource.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpResource.js +21 -12
- package/dist/unstable/observability/OtlpResource.js.map +1 -1
- package/dist/unstable/observability/OtlpSerialization.js.map +1 -1
- package/dist/unstable/observability/OtlpTracer.js.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.d.ts +13 -4
- package/dist/unstable/observability/PrometheusMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.js +10 -3
- package/dist/unstable/observability/PrometheusMetrics.js.map +1 -1
- package/dist/unstable/observability/index.js.map +1 -1
- package/dist/unstable/observability/internal/otlpEnv.js +1 -1
- package/dist/unstable/observability/internal/otlpEnv.js.map +1 -1
- package/dist/unstable/observability/internal/otlpProtobuf.js.map +1 -1
- package/dist/unstable/observability/internal/protobuf.js +3 -0
- package/dist/unstable/observability/internal/protobuf.js.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.d.ts +8 -3
- package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.js +22 -13
- package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
- package/dist/unstable/persistence/Persistable.d.ts +8 -8
- package/dist/unstable/persistence/Persistable.js.map +1 -1
- package/dist/unstable/persistence/PersistedCache.js.map +1 -1
- package/dist/unstable/persistence/PersistedQueue.d.ts +6 -6
- package/dist/unstable/persistence/PersistedQueue.js +6 -6
- package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
- package/dist/unstable/persistence/Persistence.d.ts +3 -3
- package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
- package/dist/unstable/persistence/Persistence.js +91 -15
- package/dist/unstable/persistence/Persistence.js.map +1 -1
- package/dist/unstable/persistence/RateLimiter.d.ts +26 -15
- package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
- package/dist/unstable/persistence/RateLimiter.js +24 -13
- package/dist/unstable/persistence/RateLimiter.js.map +1 -1
- package/dist/unstable/persistence/Redis.d.ts +2 -2
- package/dist/unstable/persistence/Redis.js +1 -1
- package/dist/unstable/persistence/Redis.js.map +1 -1
- package/dist/unstable/persistence/index.js.map +1 -1
- package/dist/unstable/process/ChildProcess.d.ts +64 -21
- package/dist/unstable/process/ChildProcess.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcess.js +14 -5
- package/dist/unstable/process/ChildProcess.js.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.d.ts +21 -10
- package/dist/unstable/process/ChildProcessSpawner.d.ts.map +1 -1
- package/dist/unstable/process/ChildProcessSpawner.js +1 -1
- package/dist/unstable/process/ChildProcessSpawner.js.map +1 -1
- package/dist/unstable/process/index.js.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.d.ts +8 -8
- package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.js +10 -10
- package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
- package/dist/unstable/reactivity/Atom.d.ts +25 -22
- package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.js +14 -13
- package/dist/unstable/reactivity/Atom.js.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.js +4 -1
- package/dist/unstable/reactivity/AtomHttpApi.js.map +1 -1
- package/dist/unstable/reactivity/AtomRef.js.map +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js +24 -3
- package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
- package/dist/unstable/reactivity/AtomRpc.d.ts +1 -1
- package/dist/unstable/reactivity/AtomRpc.d.ts.map +1 -1
- package/dist/unstable/reactivity/AtomRpc.js +4 -1
- package/dist/unstable/reactivity/AtomRpc.js.map +1 -1
- package/dist/unstable/reactivity/Hydration.d.ts +1 -1
- package/dist/unstable/reactivity/Hydration.js +1 -1
- package/dist/unstable/reactivity/Hydration.js.map +1 -1
- package/dist/unstable/reactivity/Reactivity.js.map +1 -1
- package/dist/unstable/reactivity/index.js.map +1 -1
- package/dist/unstable/rpc/Rpc.d.ts +35 -33
- package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
- package/dist/unstable/rpc/Rpc.js +4 -2
- package/dist/unstable/rpc/Rpc.js.map +1 -1
- package/dist/unstable/rpc/RpcClient.d.ts +12 -12
- package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.js +12 -11
- package/dist/unstable/rpc/RpcClient.js.map +1 -1
- package/dist/unstable/rpc/RpcClientError.js.map +1 -1
- package/dist/unstable/rpc/RpcGroup.d.ts +8 -8
- package/dist/unstable/rpc/RpcGroup.js +1 -1
- package/dist/unstable/rpc/RpcGroup.js.map +1 -1
- package/dist/unstable/rpc/RpcMessage.d.ts +31 -30
- package/dist/unstable/rpc/RpcMessage.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcMessage.js +6 -6
- package/dist/unstable/rpc/RpcMessage.js.map +1 -1
- package/dist/unstable/rpc/RpcMiddleware.d.ts +10 -10
- package/dist/unstable/rpc/RpcMiddleware.js +1 -1
- package/dist/unstable/rpc/RpcMiddleware.js.map +1 -1
- package/dist/unstable/rpc/RpcSchema.d.ts +4 -4
- package/dist/unstable/rpc/RpcSchema.js +3 -3
- package/dist/unstable/rpc/RpcSchema.js.map +1 -1
- package/dist/unstable/rpc/RpcSerialization.d.ts +58 -7
- package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcSerialization.js +175 -96
- package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
- package/dist/unstable/rpc/RpcServer.d.ts +13 -13
- package/dist/unstable/rpc/RpcServer.js +17 -13
- package/dist/unstable/rpc/RpcServer.js.map +1 -1
- package/dist/unstable/rpc/RpcTest.js.map +1 -1
- package/dist/unstable/rpc/RpcWorker.d.ts +5 -5
- package/dist/unstable/rpc/RpcWorker.js +4 -4
- package/dist/unstable/rpc/RpcWorker.js.map +1 -1
- package/dist/unstable/rpc/Utils.js.map +1 -1
- package/dist/unstable/rpc/index.js.map +1 -1
- package/dist/unstable/schema/Model.d.ts +52 -50
- package/dist/unstable/schema/Model.d.ts.map +1 -1
- package/dist/unstable/schema/Model.js +35 -33
- package/dist/unstable/schema/Model.js.map +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts +5 -5
- package/dist/unstable/schema/VariantSchema.js +2 -2
- package/dist/unstable/schema/VariantSchema.js.map +1 -1
- package/dist/unstable/schema/index.js.map +1 -1
- package/dist/unstable/socket/Socket.d.ts +11 -3
- package/dist/unstable/socket/Socket.d.ts.map +1 -1
- package/dist/unstable/socket/Socket.js +9 -4
- package/dist/unstable/socket/Socket.js.map +1 -1
- package/dist/unstable/socket/SocketServer.js.map +1 -1
- package/dist/unstable/socket/index.js.map +1 -1
- package/dist/unstable/sql/Migrator.js.map +1 -1
- package/dist/unstable/sql/SqlClient.d.ts +1 -1
- package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
- package/dist/unstable/sql/SqlClient.js +2 -2
- package/dist/unstable/sql/SqlClient.js.map +1 -1
- package/dist/unstable/sql/SqlConnection.js.map +1 -1
- package/dist/unstable/sql/SqlError.js.map +1 -1
- package/dist/unstable/sql/SqlModel.d.ts +2 -2
- package/dist/unstable/sql/SqlModel.js +2 -2
- package/dist/unstable/sql/SqlModel.js.map +1 -1
- package/dist/unstable/sql/SqlResolver.d.ts +5 -5
- package/dist/unstable/sql/SqlResolver.js +2 -2
- package/dist/unstable/sql/SqlResolver.js.map +1 -1
- package/dist/unstable/sql/SqlSchema.js.map +1 -1
- package/dist/unstable/sql/SqlStream.js.map +1 -1
- package/dist/unstable/sql/Statement.d.ts +6 -6
- package/dist/unstable/sql/Statement.js +15 -15
- package/dist/unstable/sql/Statement.js.map +1 -1
- package/dist/unstable/sql/index.js.map +1 -1
- package/dist/unstable/workers/Transferable.d.ts +1 -1
- package/dist/unstable/workers/Transferable.js +1 -1
- package/dist/unstable/workers/Transferable.js.map +1 -1
- package/dist/unstable/workers/Worker.d.ts +2 -2
- package/dist/unstable/workers/Worker.js +2 -2
- package/dist/unstable/workers/Worker.js.map +1 -1
- package/dist/unstable/workers/WorkerError.d.ts +7 -7
- package/dist/unstable/workers/WorkerError.js +6 -6
- package/dist/unstable/workers/WorkerError.js.map +1 -1
- package/dist/unstable/workers/WorkerRunner.d.ts +1 -1
- package/dist/unstable/workers/WorkerRunner.js +1 -1
- package/dist/unstable/workers/WorkerRunner.js.map +1 -1
- package/dist/unstable/workers/index.js.map +1 -1
- package/dist/unstable/workflow/Activity.d.ts +2 -2
- package/dist/unstable/workflow/Activity.js +2 -2
- package/dist/unstable/workflow/Activity.js.map +1 -1
- package/dist/unstable/workflow/DurableClock.d.ts +1 -1
- package/dist/unstable/workflow/DurableClock.js +1 -1
- package/dist/unstable/workflow/DurableClock.js.map +1 -1
- package/dist/unstable/workflow/DurableDeferred.d.ts +10 -10
- package/dist/unstable/workflow/DurableDeferred.js +5 -5
- package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
- package/dist/unstable/workflow/DurableQueue.d.ts +22 -20
- package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableQueue.js +22 -20
- package/dist/unstable/workflow/DurableQueue.js.map +1 -1
- package/dist/unstable/workflow/Workflow.d.ts +21 -21
- package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
- package/dist/unstable/workflow/Workflow.js +13 -14
- package/dist/unstable/workflow/Workflow.js.map +1 -1
- package/dist/unstable/workflow/WorkflowEngine.d.ts +1 -1
- package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.d.ts +4 -2
- package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.js +4 -2
- package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.js.map +1 -1
- package/dist/unstable/workflow/index.js.map +1 -1
- package/dist/unstable/workflow/internal/crypto.js.map +1 -1
- package/package.json +5 -6
- package/src/Array.ts +982 -1045
- package/src/BigDecimal.ts +433 -756
- package/src/BigInt.ts +213 -269
- package/src/Boolean.ts +146 -188
- package/src/Cache.ts +409 -255
- package/src/Cause.ts +167 -277
- package/src/Channel.ts +891 -816
- package/src/ChannelSchema.ts +1 -1
- package/src/Chunk.ts +841 -1181
- package/src/Clock.ts +181 -49
- package/src/Combiner.ts +20 -33
- package/src/Config.ts +615 -332
- package/src/ConfigProvider.ts +214 -120
- package/src/Console.ts +289 -39
- package/src/Context.ts +319 -378
- package/src/Cron.ts +68 -77
- package/src/Crypto.ts +13 -15
- package/src/Data.ts +60 -80
- package/src/DateTime.ts +564 -660
- package/src/Deferred.ts +253 -256
- package/src/Duration.ts +216 -308
- package/src/Effect.ts +2893 -3279
- package/src/Encoding.ts +22 -40
- package/src/Equal.ts +49 -39
- package/src/Equivalence.ts +103 -105
- package/src/ErrorReporter.ts +51 -27
- package/src/ExecutionPlan.ts +13 -55
- package/src/Exit.ts +116 -192
- package/src/Fiber.ts +81 -148
- package/src/FiberHandle.ts +152 -105
- package/src/FiberMap.ts +225 -174
- package/src/FiberSet.ts +124 -82
- package/src/FileSystem.ts +155 -263
- package/src/Filter.ts +61 -33
- package/src/Formatter.ts +54 -56
- package/src/Function.ts +76 -145
- package/src/Graph.ts +416 -770
- package/src/HKT.ts +12 -6
- package/src/Hash.ts +52 -83
- package/src/HashMap.ts +319 -411
- package/src/HashRing.ts +1 -0
- package/src/HashSet.ts +177 -284
- package/src/Inspectable.ts +12 -12
- package/src/Iterable.ts +620 -786
- package/src/JsonPatch.ts +58 -112
- package/src/JsonPointer.ts +8 -8
- package/src/JsonSchema.ts +402 -244
- package/src/Latch.ts +23 -35
- package/src/Layer.ts +359 -260
- package/src/LayerMap.ts +49 -29
- package/src/LayerRef.ts +6 -2
- package/src/LogLevel.ts +114 -214
- package/src/Logger.ts +344 -697
- package/src/ManagedRuntime.ts +7 -5
- package/src/Match.ts +217 -252
- package/src/Metric.ts +516 -1089
- package/src/MutableHashMap.ts +218 -255
- package/src/MutableHashSet.ts +84 -89
- package/src/MutableList.ts +73 -370
- package/src/MutableRef.ts +420 -243
- package/src/Newtype.ts +21 -14
- package/src/NonEmptyIterable.ts +7 -137
- package/src/Number.ts +196 -233
- package/src/Optic.ts +243 -383
- package/src/Option.ts +447 -812
- package/src/Order.ts +109 -109
- package/src/Ordering.ts +20 -23
- package/src/Path.ts +38 -41
- package/src/Pipeable.ts +6 -5
- package/src/PlatformError.ts +4 -4
- package/src/Pool.ts +4 -2
- package/src/Predicate.ts +200 -181
- package/src/PrimaryKey.ts +7 -7
- package/src/PubSub.ts +526 -552
- package/src/Pull.ts +24 -18
- package/src/Queue.ts +200 -159
- package/src/Random.ts +49 -74
- package/src/RcMap.ts +121 -63
- package/src/RcRef.ts +24 -13
- package/src/Record.ts +291 -488
- package/src/Redactable.ts +10 -3
- package/src/Redacted.ts +25 -25
- package/src/Reducer.ts +8 -15
- package/src/Ref.ts +221 -361
- package/src/References.ts +102 -168
- package/src/RegExp.ts +10 -14
- package/src/Request.ts +31 -21
- package/src/RequestResolver.ts +202 -91
- package/src/Result.ts +312 -484
- package/src/Runtime.ts +50 -75
- package/src/Schedule.ts +308 -1734
- package/src/Scheduler.ts +20 -7
- package/src/Schema.ts +716 -745
- package/src/SchemaAST.ts +466 -358
- package/src/SchemaError.ts +7 -6
- package/src/SchemaGetter.ts +242 -190
- package/src/SchemaIssue.ts +89 -275
- package/src/SchemaParser.ts +180 -93
- package/src/SchemaRepresentation.ts +22 -40
- package/src/SchemaTransformation.ts +129 -88
- package/src/Scope.ts +123 -151
- package/src/ScopedRef.ts +4 -4
- package/src/Semaphore.ts +152 -51
- package/src/Sink.ts +128 -113
- package/src/Stdio.ts +1 -1
- package/src/Stream.ts +2602 -3123
- package/src/String.ts +275 -312
- package/src/Struct.ts +109 -114
- package/src/SubscriptionRef.ts +284 -252
- package/src/Symbol.ts +3 -3
- package/src/Terminal.ts +2 -2
- package/src/Tracer.ts +102 -55
- package/src/Trie.ts +287 -679
- package/src/Tuple.ts +92 -127
- package/src/TxChunk.ts +201 -121
- package/src/TxDeferred.ts +62 -46
- package/src/TxHashMap.ts +645 -799
- package/src/TxHashSet.ts +443 -356
- package/src/TxPriorityQueue.ts +130 -98
- package/src/TxPubSub.ts +107 -80
- package/src/TxQueue.ts +214 -183
- package/src/TxReentrantLock.ts +97 -66
- package/src/TxRef.ts +51 -32
- package/src/TxSemaphore.ts +129 -95
- package/src/TxSubscriptionRef.ts +97 -70
- package/src/Types.ts +126 -67
- package/src/Unify.ts +45 -65
- package/src/Utils.ts +23 -16
- package/src/internal/core.ts +2 -2
- package/src/internal/dateTime.ts +6 -0
- package/src/internal/effect.ts +93 -48
- package/src/internal/persistence.ts +2 -0
- package/src/internal/references.ts +3 -2
- package/src/internal/schema/fromJsonSchemaDocument.ts +15 -13
- package/src/internal/schema/fromRepresentation.ts +10 -16
- package/src/internal/schema/parser.ts +22 -0
- package/src/internal/schema/toJsonSchemaDocument.ts +60 -6
- package/src/internal/schema/toRepresentation.ts +104 -119
- package/src/internal/trie.ts +10 -11
- package/src/testing/FastCheck.ts +8 -7
- package/src/testing/TestClock.ts +72 -30
- package/src/testing/TestConsole.ts +32 -31
- package/src/testing/TestSchema.ts +29 -29
- package/src/unstable/ai/AiError.ts +95 -118
- package/src/unstable/ai/AnthropicStructuredOutput.ts +1 -1
- package/src/unstable/ai/Chat.ts +132 -97
- package/src/unstable/ai/IdGenerator.ts +32 -28
- package/src/unstable/ai/LanguageModel.ts +107 -67
- package/src/unstable/ai/McpProtocol.ts +48 -0
- package/src/unstable/ai/McpSchema.ts +60 -50
- package/src/unstable/ai/McpServer.ts +930 -304
- package/src/unstable/ai/Model.ts +9 -20
- package/src/unstable/ai/OpenAiStructuredOutput.ts +1 -1
- package/src/unstable/ai/Prompt.ts +145 -43
- package/src/unstable/ai/Response.ts +28 -14
- package/src/unstable/ai/Telemetry.ts +46 -13
- package/src/unstable/ai/Tokenizer.ts +14 -3
- package/src/unstable/ai/Tool.ts +59 -44
- package/src/unstable/ai/Toolkit.ts +26 -8
- package/src/unstable/ai/index.ts +5 -0
- package/src/unstable/ai/internal/mcpProtocol.ts +85 -0
- package/src/unstable/ai/internal/mcpProtocolRegistry.ts +70 -0
- package/src/unstable/ai/internal/structured-output.ts +13 -18
- package/src/unstable/cli/Argument.ts +273 -69
- package/src/unstable/cli/CliError.ts +69 -76
- package/src/unstable/cli/CliOutput.ts +44 -58
- package/src/unstable/cli/Command.ts +705 -107
- package/src/unstable/cli/Flag.ts +418 -138
- package/src/unstable/cli/GlobalFlag.ts +1 -1
- package/src/unstable/cli/HelpDoc.ts +12 -4
- package/src/unstable/cli/Param.ts +292 -78
- package/src/unstable/cli/Primitive.ts +370 -149
- package/src/unstable/cli/Prompt.ts +28 -14
- package/src/unstable/cli/internal/lexer.ts +8 -2
- package/src/unstable/cli/internal/parser.ts +2 -2
- package/src/unstable/cluster/ClusterSchema.ts +8 -8
- package/src/unstable/cluster/ClusterWorkflowEngine.ts +5 -1
- package/src/unstable/cluster/Entity.ts +15 -16
- package/src/unstable/cluster/EntityProxy.ts +4 -2
- package/src/unstable/cluster/EntityResource.ts +2 -2
- package/src/unstable/cluster/Envelope.ts +3 -3
- package/src/unstable/cluster/HttpRunner.ts +6 -4
- package/src/unstable/cluster/Message.ts +9 -9
- package/src/unstable/cluster/MessageStorage.ts +15 -15
- package/src/unstable/cluster/Reply.ts +4 -6
- package/src/unstable/cluster/RunnerHealth.ts +1 -1
- package/src/unstable/cluster/RunnerServer.ts +41 -8
- package/src/unstable/cluster/RunnerStorage.ts +2 -2
- package/src/unstable/cluster/Runners.ts +23 -12
- package/src/unstable/cluster/Sharding.ts +7 -8
- package/src/unstable/cluster/ShardingConfig.ts +3 -3
- package/src/unstable/cluster/SingletonAddress.ts +1 -1
- package/src/unstable/cluster/Snowflake.ts +8 -8
- package/src/unstable/cluster/SqlMessageStorage.ts +1 -1
- package/src/unstable/cluster/SqlRunnerStorage.ts +21 -5
- package/src/unstable/cluster/internal/entityManager.ts +11 -15
- package/src/unstable/encoding/Msgpack.ts +6 -8
- package/src/unstable/encoding/Sse.ts +98 -16
- package/src/unstable/eventlog/Event.ts +20 -20
- package/src/unstable/eventlog/EventGroup.ts +4 -4
- package/src/unstable/eventlog/EventJournal.ts +15 -15
- package/src/unstable/eventlog/EventLog.ts +3 -3
- package/src/unstable/eventlog/EventLogEncryption.ts +1 -1
- package/src/unstable/eventlog/EventLogMessage.ts +2 -2
- package/src/unstable/eventlog/EventLogRemote.ts +1 -1
- package/src/unstable/eventlog/EventLogServer.ts +41 -7
- package/src/unstable/eventlog/EventLogServerEncrypted.ts +13 -5
- package/src/unstable/eventlog/EventLogServerUnencrypted.ts +14 -6
- package/src/unstable/eventlog/EventLogSessionAuth.ts +1 -1
- package/src/unstable/http/Cookies.ts +35 -21
- package/src/unstable/http/Etag.ts +1 -1
- package/src/unstable/http/FetchHttpClient.ts +3 -1
- package/src/unstable/http/Headers.ts +2 -2
- package/src/unstable/http/HttpBody.ts +20 -5
- package/src/unstable/http/HttpClient.ts +83 -55
- package/src/unstable/http/HttpClientRequest.ts +2 -0
- package/src/unstable/http/HttpClientResponse.ts +4 -4
- package/src/unstable/http/HttpEffect.ts +8 -8
- package/src/unstable/http/HttpMethod.ts +6 -9
- package/src/unstable/http/HttpMiddleware.ts +202 -39
- package/src/unstable/http/HttpPlatform.ts +95 -0
- package/src/unstable/http/HttpRouter.ts +102 -98
- package/src/unstable/http/HttpServer.ts +13 -13
- package/src/unstable/http/HttpServerError.ts +2 -2
- package/src/unstable/http/HttpServerRequest.ts +4 -4
- package/src/unstable/http/HttpServerResponse.ts +30 -0
- package/src/unstable/http/HttpStaticServer.ts +35 -7
- package/src/unstable/http/Multipart.ts +6 -6
- package/src/unstable/http/Url.ts +33 -63
- package/src/unstable/http/UrlParams.ts +10 -18
- package/src/unstable/http/internal/compression.ts +196 -0
- package/src/unstable/httpapi/HttpApiBuilder.ts +10 -9
- package/src/unstable/httpapi/HttpApiClient.ts +14 -14
- package/src/unstable/httpapi/HttpApiEndpoint.ts +42 -42
- package/src/unstable/httpapi/HttpApiError.ts +13 -13
- package/src/unstable/httpapi/HttpApiGroup.ts +15 -15
- package/src/unstable/httpapi/HttpApiMiddleware.ts +71 -24
- package/src/unstable/httpapi/HttpApiScalar.ts +0 -12
- package/src/unstable/httpapi/HttpApiSchema.ts +6 -6
- package/src/unstable/httpapi/OpenApi.ts +13 -13
- package/src/unstable/observability/OtlpExporter.ts +31 -19
- package/src/unstable/observability/OtlpMetrics.ts +4 -1
- package/src/unstable/observability/OtlpResource.ts +26 -17
- package/src/unstable/observability/PrometheusMetrics.ts +13 -4
- package/src/unstable/observability/internal/otlpEnv.ts +1 -1
- package/src/unstable/observability/internal/protobuf.ts +3 -0
- package/src/unstable/persistence/KeyValueStore.ts +72 -49
- package/src/unstable/persistence/Persistable.ts +8 -8
- package/src/unstable/persistence/PersistedQueue.ts +6 -6
- package/src/unstable/persistence/Persistence.ts +126 -19
- package/src/unstable/persistence/RateLimiter.ts +26 -15
- package/src/unstable/persistence/Redis.ts +2 -2
- package/src/unstable/process/ChildProcess.ts +64 -21
- package/src/unstable/process/ChildProcessSpawner.ts +21 -10
- package/src/unstable/reactivity/AsyncResult.ts +12 -13
- package/src/unstable/reactivity/Atom.ts +28 -25
- package/src/unstable/reactivity/AtomHttpApi.ts +5 -4
- package/src/unstable/reactivity/AtomRegistry.ts +24 -3
- package/src/unstable/reactivity/AtomRpc.ts +5 -4
- package/src/unstable/reactivity/Hydration.ts +1 -1
- package/src/unstable/rpc/Rpc.ts +35 -33
- package/src/unstable/rpc/RpcClient.ts +16 -15
- package/src/unstable/rpc/RpcGroup.ts +8 -8
- package/src/unstable/rpc/RpcMessage.ts +31 -30
- package/src/unstable/rpc/RpcMiddleware.ts +10 -10
- package/src/unstable/rpc/RpcSchema.ts +4 -4
- package/src/unstable/rpc/RpcSerialization.ts +167 -68
- package/src/unstable/rpc/RpcServer.ts +18 -15
- package/src/unstable/rpc/RpcWorker.ts +5 -5
- package/src/unstable/schema/Model.ts +52 -50
- package/src/unstable/schema/VariantSchema.ts +5 -5
- package/src/unstable/socket/Socket.ts +17 -4
- package/src/unstable/sql/SqlClient.ts +5 -6
- package/src/unstable/sql/SqlModel.ts +2 -2
- package/src/unstable/sql/SqlResolver.ts +5 -5
- package/src/unstable/sql/Statement.ts +24 -23
- package/src/unstable/workers/Transferable.ts +1 -1
- package/src/unstable/workers/Worker.ts +2 -2
- package/src/unstable/workers/WorkerError.ts +7 -7
- package/src/unstable/workers/WorkerRunner.ts +1 -1
- package/src/unstable/workflow/Activity.ts +2 -2
- package/src/unstable/workflow/DurableClock.ts +1 -1
- package/src/unstable/workflow/DurableDeferred.ts +10 -10
- package/src/unstable/workflow/DurableQueue.ts +22 -20
- package/src/unstable/workflow/Workflow.ts +23 -23
- package/src/unstable/workflow/WorkflowEngine.ts +1 -1
- package/src/unstable/workflow/WorkflowProxy.ts +4 -2
- package/dist/internal/version.d.ts +0 -3
- package/dist/internal/version.d.ts.map +0 -1
- package/dist/internal/version.js +0 -2
- package/dist/internal/version.js.map +0 -1
- package/src/internal/version.ts +0 -2
package/dist/Schema.d.ts
CHANGED
|
@@ -17,7 +17,6 @@ import * as BigDecimal_ from "./BigDecimal.ts";
|
|
|
17
17
|
import type * as Brand from "./Brand.ts";
|
|
18
18
|
import * as Cause_ from "./Cause.ts";
|
|
19
19
|
import * as Chunk_ from "./Chunk.ts";
|
|
20
|
-
import type * as Combiner from "./Combiner.ts";
|
|
21
20
|
import * as DateTime from "./DateTime.ts";
|
|
22
21
|
import type { Differ } from "./Differ.ts";
|
|
23
22
|
import * as Duration_ from "./Duration.ts";
|
|
@@ -299,8 +298,8 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<C
|
|
|
299
298
|
*
|
|
300
299
|
* **Example** (Schema for a parametric `Box<A>` type)
|
|
301
300
|
*
|
|
302
|
-
* ```ts
|
|
303
|
-
* import { Effect,
|
|
301
|
+
* ```ts import.meta.vitest
|
|
302
|
+
* import { Effect, Schema, SchemaIssue as Issue, SchemaParser } from "effect"
|
|
304
303
|
*
|
|
305
304
|
* interface Box<A> {
|
|
306
305
|
* readonly value: A
|
|
@@ -315,7 +314,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<C
|
|
|
315
314
|
* ([itemCodec]) =>
|
|
316
315
|
* (u, ast, options) => {
|
|
317
316
|
* if (!isBox(u)) {
|
|
318
|
-
* return Effect.fail(new SchemaIssue.InvalidType(ast
|
|
317
|
+
* return Effect.fail(new SchemaIssue.InvalidType(ast))
|
|
319
318
|
* }
|
|
320
319
|
* return Effect.map(
|
|
321
320
|
* SchemaParser.decodeUnknownEffect(itemCodec)(u.value, options),
|
|
@@ -325,6 +324,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<C
|
|
|
325
324
|
* )
|
|
326
325
|
*
|
|
327
326
|
* const schema = Box(Schema.Number)
|
|
327
|
+
* Effect.runSync(Schema.decodeUnknownEffect(schema)({ value: 1 })) // => { value: 1 }
|
|
328
328
|
* ```
|
|
329
329
|
*
|
|
330
330
|
* @category constructors
|
|
@@ -352,7 +352,7 @@ export interface declare<T, Iso = T> extends declareConstructor<T, T, readonly [
|
|
|
352
352
|
*
|
|
353
353
|
* **Example** (Defining a schema for a custom `UserId` branded type)
|
|
354
354
|
*
|
|
355
|
-
* ```ts
|
|
355
|
+
* ```ts import.meta.vitest
|
|
356
356
|
* import { Schema } from "effect"
|
|
357
357
|
*
|
|
358
358
|
* type UserId = string & { readonly _tag: "UserId" }
|
|
@@ -364,6 +364,7 @@ export interface declare<T, Iso = T> extends declareConstructor<T, T, readonly [
|
|
|
364
364
|
* title: "UserId",
|
|
365
365
|
* description: "A user identifier starting with 'user_'"
|
|
366
366
|
* })
|
|
367
|
+
* Schema.decodeUnknownSync(UserId)("user_123") // => "user_123"
|
|
367
368
|
* ```
|
|
368
369
|
*
|
|
369
370
|
* @see {@link declareConstructor} for creating schemas for parametric types.
|
|
@@ -384,7 +385,7 @@ export declare function declare<T, Iso = T>(is: (u: unknown) => u is T, annotati
|
|
|
384
385
|
*
|
|
385
386
|
* **Example** (Inspecting all type parameters of a schema)
|
|
386
387
|
*
|
|
387
|
-
* ```ts
|
|
388
|
+
* ```ts import.meta.vitest
|
|
388
389
|
* import { Schema } from "effect"
|
|
389
390
|
*
|
|
390
391
|
* const schema = Schema.String
|
|
@@ -414,7 +415,7 @@ export declare function revealBottom<S extends Top>(bottom: S): Bottom<S["Type"]
|
|
|
414
415
|
*
|
|
415
416
|
* **Example** (Adding a title and description)
|
|
416
417
|
*
|
|
417
|
-
* ```ts
|
|
418
|
+
* ```ts import.meta.vitest
|
|
418
419
|
* import { Schema } from "effect"
|
|
419
420
|
*
|
|
420
421
|
* const Age = Schema.Natural.pipe(
|
|
@@ -423,6 +424,7 @@ export declare function revealBottom<S extends Top>(bottom: S): Bottom<S["Type"]
|
|
|
423
424
|
* description: "A non-negative integer representing age in years"
|
|
424
425
|
* })
|
|
425
426
|
* )
|
|
427
|
+
* Schema.resolveAnnotations(Age)?.title // => "Age"
|
|
426
428
|
* ```
|
|
427
429
|
*
|
|
428
430
|
* @see {@link annotateEncoded} to annotate the encoded side instead.
|
|
@@ -443,7 +445,7 @@ export declare function annotate<S extends Top>(annotations: Annotations.Bottom<
|
|
|
443
445
|
*
|
|
444
446
|
* **Example** (Adding a title to the encoded representation)
|
|
445
447
|
*
|
|
446
|
-
* ```ts
|
|
448
|
+
* ```ts import.meta.vitest
|
|
447
449
|
* import { Schema } from "effect"
|
|
448
450
|
*
|
|
449
451
|
* const schema = Schema.NumberFromString.pipe(
|
|
@@ -452,8 +454,7 @@ export declare function annotate<S extends Top>(annotations: Annotations.Bottom<
|
|
|
452
454
|
* })
|
|
453
455
|
* )
|
|
454
456
|
*
|
|
455
|
-
*
|
|
456
|
-
* // "my title"
|
|
457
|
+
* Schema.toEncoded(schema).ast.annotations?.title // => "my title"
|
|
457
458
|
* ```
|
|
458
459
|
*
|
|
459
460
|
* @see {@link annotate} to annotate the type side instead.
|
|
@@ -476,7 +477,7 @@ export declare function annotateEncoded<S extends Top>(annotations: Annotations.
|
|
|
476
477
|
*
|
|
477
478
|
* **Example** (Customizing the missing-key message for a required field)
|
|
478
479
|
*
|
|
479
|
-
* ```ts
|
|
480
|
+
* ```ts import.meta.vitest
|
|
480
481
|
* import { Schema } from "effect"
|
|
481
482
|
*
|
|
482
483
|
* const schema = Schema.Struct({
|
|
@@ -487,6 +488,7 @@ export declare function annotateEncoded<S extends Top>(annotations: Annotations.
|
|
|
487
488
|
* })
|
|
488
489
|
* )
|
|
489
490
|
* })
|
|
491
|
+
* schema.fields.username.ast.context?.annotations?.messageMissingKey // => "Username is required"
|
|
490
492
|
* ```
|
|
491
493
|
*
|
|
492
494
|
* @category annotations
|
|
@@ -640,7 +642,7 @@ export declare namespace Schema {
|
|
|
640
642
|
*
|
|
641
643
|
* **Example** (Extracting the decoded type)
|
|
642
644
|
*
|
|
643
|
-
* ```ts
|
|
645
|
+
* ```ts import.meta.vitest
|
|
644
646
|
* import { Schema } from "effect"
|
|
645
647
|
*
|
|
646
648
|
* const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
|
|
@@ -670,13 +672,13 @@ export declare namespace Schema {
|
|
|
670
672
|
*
|
|
671
673
|
* **Example** (Accepting any schema decoding to `string`)
|
|
672
674
|
*
|
|
673
|
-
* ```ts
|
|
675
|
+
* ```ts import.meta.vitest
|
|
674
676
|
* import { Schema } from "effect"
|
|
675
677
|
*
|
|
676
|
-
*
|
|
678
|
+
* const accept = (_schema: Schema.Schema<string>): void => {}
|
|
677
679
|
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
+
* accept(Schema.String)
|
|
681
|
+
* accept(Schema.NonEmptyString)
|
|
680
682
|
* ```
|
|
681
683
|
*
|
|
682
684
|
* @see {@link Codec} — also tracks Encoded, DecodingServices, EncodingServices
|
|
@@ -700,7 +702,7 @@ export declare namespace Codec {
|
|
|
700
702
|
*
|
|
701
703
|
* **Example** (Extracting the encoded type)
|
|
702
704
|
*
|
|
703
|
-
* ```ts
|
|
705
|
+
* ```ts import.meta.vitest
|
|
704
706
|
* import { Schema } from "effect"
|
|
705
707
|
*
|
|
706
708
|
* const schema = Schema.NumberFromString
|
|
@@ -719,7 +721,7 @@ export declare namespace Codec {
|
|
|
719
721
|
*
|
|
720
722
|
* **Example** (Checking decoding service requirements)
|
|
721
723
|
*
|
|
722
|
-
* ```ts
|
|
724
|
+
* ```ts import.meta.vitest
|
|
723
725
|
* import { Schema } from "effect"
|
|
724
726
|
*
|
|
725
727
|
* const schema = Schema.String
|
|
@@ -738,7 +740,7 @@ export declare namespace Codec {
|
|
|
738
740
|
*
|
|
739
741
|
* **Example** (Checking encoding service requirements)
|
|
740
742
|
*
|
|
741
|
-
* ```ts
|
|
743
|
+
* ```ts import.meta.vitest
|
|
742
744
|
* import { Schema } from "effect"
|
|
743
745
|
*
|
|
744
746
|
* const schema = Schema.String
|
|
@@ -770,12 +772,13 @@ export declare namespace Codec {
|
|
|
770
772
|
*
|
|
771
773
|
* **Example** (Accepting a codec that decodes to `number` from `string`)
|
|
772
774
|
*
|
|
773
|
-
* ```ts
|
|
775
|
+
* ```ts import.meta.vitest
|
|
774
776
|
* import { Schema } from "effect"
|
|
775
777
|
*
|
|
776
|
-
*
|
|
778
|
+
* const serialize = <T>(codec: Schema.Codec<T, string>, value: T): string =>
|
|
779
|
+
* Schema.encodeSync(codec)(value)
|
|
777
780
|
*
|
|
778
|
-
* serialize(Schema.NumberFromString) //
|
|
781
|
+
* serialize(Schema.NumberFromString, 42) // => "42"
|
|
779
782
|
* ```
|
|
780
783
|
*
|
|
781
784
|
* @see {@link Codec.Encoded} — extract the encoded type
|
|
@@ -848,7 +851,7 @@ export interface Encoder<out E, out RE = never> extends Schema<unknown> {
|
|
|
848
851
|
*
|
|
849
852
|
* **Example** (Recovering encoded type from a schema variable)
|
|
850
853
|
*
|
|
851
|
-
* ```ts
|
|
854
|
+
* ```ts import.meta.vitest
|
|
852
855
|
* import { Schema } from "effect"
|
|
853
856
|
*
|
|
854
857
|
* const schema: Schema.Schema<number> = Schema.NumberFromString
|
|
@@ -890,18 +893,14 @@ export {
|
|
|
890
893
|
/**
|
|
891
894
|
* Returns `true` if `u` is a {@link SchemaError}.
|
|
892
895
|
*
|
|
893
|
-
* **Example** (Narrowing Schema errors
|
|
896
|
+
* **Example** (Narrowing Schema errors)
|
|
894
897
|
*
|
|
895
|
-
* ```ts
|
|
896
|
-
* import { Schema } from "effect"
|
|
898
|
+
* ```ts import.meta.vitest
|
|
899
|
+
* import { Result, Schema } from "effect"
|
|
897
900
|
*
|
|
898
|
-
* try
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
* if (Schema.isSchemaError(err)) {
|
|
902
|
-
* console.log(err._tag) // "SchemaError"
|
|
903
|
-
* }
|
|
904
|
-
* }
|
|
901
|
+
* const result = Result.try(() => Schema.decodeUnknownSync(Schema.Number)("oops"))
|
|
902
|
+
* const error: unknown = Result.isFailure(result) ? result.failure : undefined
|
|
903
|
+
* Schema.isSchemaError(error) // => true
|
|
905
904
|
* ```
|
|
906
905
|
*
|
|
907
906
|
* @category guards
|
|
@@ -915,25 +914,22 @@ isSchemaError,
|
|
|
915
914
|
* **Details**
|
|
916
915
|
*
|
|
917
916
|
* The `issue` field contains a structured {@link SchemaIssue.Issue} tree describing
|
|
918
|
-
* every validation failure, including the path to the problematic value
|
|
919
|
-
* expected
|
|
920
|
-
*
|
|
917
|
+
* every validation failure, including the path to the problematic value and
|
|
918
|
+
* the expected type or constraint. Built-in issues have no `actual` field,
|
|
919
|
+
* and built-in messages do not include the rejected value. Other Issue fields
|
|
920
|
+
* and custom annotations or messages are not sanitized. `message` renders the
|
|
921
|
+
* issue tree as a human-readable string.
|
|
921
922
|
*
|
|
922
923
|
* Use {@link isSchemaError} to narrow an unknown value to `SchemaError`.
|
|
923
924
|
*
|
|
924
|
-
* **Example** (
|
|
925
|
+
* **Example** (Inspecting a SchemaError)
|
|
925
926
|
*
|
|
926
|
-
* ```ts
|
|
927
|
-
* import { Schema } from "effect"
|
|
927
|
+
* ```ts import.meta.vitest
|
|
928
|
+
* import { Result, Schema } from "effect"
|
|
928
929
|
*
|
|
929
|
-
*
|
|
930
|
-
*
|
|
931
|
-
*
|
|
932
|
-
* if (Schema.isSchemaError(err)) {
|
|
933
|
-
* console.log(err.message)
|
|
934
|
-
* // Expected number, actual "not a number"
|
|
935
|
-
* }
|
|
936
|
-
* }
|
|
930
|
+
* const result = Schema.decodeUnknownResult(Schema.Number)("not a number")
|
|
931
|
+
* const message = Result.isFailure(result) ? result.failure.message : ""
|
|
932
|
+
* message // => "Expected number"
|
|
937
933
|
* ```
|
|
938
934
|
*
|
|
939
935
|
* @category errors
|
|
@@ -953,7 +949,7 @@ SchemaError };
|
|
|
953
949
|
*
|
|
954
950
|
* **Example** (Creating a standard schema from a regular schema)
|
|
955
951
|
*
|
|
956
|
-
* ```ts
|
|
952
|
+
* ```ts import.meta.vitest
|
|
957
953
|
* import { Schema } from "effect"
|
|
958
954
|
*
|
|
959
955
|
* // Define custom hook functions for error formatting
|
|
@@ -991,16 +987,21 @@ SchemaError };
|
|
|
991
987
|
* name: "Alice",
|
|
992
988
|
* age: 30
|
|
993
989
|
* })
|
|
994
|
-
* console.log(validResult) // { value: { name: "Alice", age: 30 } }
|
|
995
|
-
*
|
|
996
990
|
* const invalidResult = standardSchema["~standard"].validate({
|
|
997
991
|
* name: "",
|
|
998
992
|
* age: 200
|
|
999
993
|
* })
|
|
1000
|
-
*
|
|
994
|
+
*
|
|
995
|
+
* if (validResult instanceof Promise || invalidResult instanceof Promise) {
|
|
996
|
+
* throw new Error("Expected synchronous validation")
|
|
997
|
+
* }
|
|
998
|
+
* if ("value" in validResult) {
|
|
999
|
+
* validResult.value // => { name: "Alice", age: 30 }
|
|
1000
|
+
* }
|
|
1001
|
+
* invalidResult.issues?.map((issue) => issue.path) // => [["name"], ["age"]]
|
|
1001
1002
|
* ```
|
|
1002
1003
|
*
|
|
1003
|
-
* @category
|
|
1004
|
+
* @category converting
|
|
1004
1005
|
* @since 4.0.0
|
|
1005
1006
|
*/
|
|
1006
1007
|
export declare function toStandardSchemaV1<S extends ConstraintDecoder<unknown>>(self: S, options?: {
|
|
@@ -1015,7 +1016,7 @@ export declare function toStandardSchemaV1<S extends ConstraintDecoder<unknown>>
|
|
|
1015
1016
|
*
|
|
1016
1017
|
* https://github.com/standard-schema/standard-schema/pull/134
|
|
1017
1018
|
*
|
|
1018
|
-
* @category
|
|
1019
|
+
* @category converting
|
|
1019
1020
|
* @since 4.0.0
|
|
1020
1021
|
*/
|
|
1021
1022
|
export declare function toStandardJSONSchemaV1<S extends Constraint>(self: S): StandardJSONSchemaV1<S["Encoded"], S["Type"]> & S;
|
|
@@ -1037,19 +1038,19 @@ export declare function toStandardJSONSchemaV1<S extends Constraint>(self: S): S
|
|
|
1037
1038
|
*
|
|
1038
1039
|
* **Example** (Defining a basic type guard)
|
|
1039
1040
|
*
|
|
1040
|
-
* ```ts
|
|
1041
|
+
* ```ts import.meta.vitest
|
|
1041
1042
|
* import { Schema } from "effect"
|
|
1042
1043
|
*
|
|
1043
1044
|
* const isString = Schema.is(Schema.String)
|
|
1044
1045
|
*
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1046
|
+
* isString("hello") // => true
|
|
1047
|
+
* isString(42) // => false
|
|
1047
1048
|
*
|
|
1048
1049
|
* // Type narrowing in action
|
|
1049
1050
|
* const value: unknown = "hello"
|
|
1050
1051
|
* if (isString(value)) {
|
|
1051
1052
|
* // value is now typed as string
|
|
1052
|
-
*
|
|
1053
|
+
* value.toUpperCase() // => "HELLO"
|
|
1053
1054
|
* }
|
|
1054
1055
|
* ```
|
|
1055
1056
|
*
|
|
@@ -1079,21 +1080,23 @@ export declare const is: typeof SchemaParser.is;
|
|
|
1079
1080
|
*
|
|
1080
1081
|
* **Example** (Asserting and narrowing an input)
|
|
1081
1082
|
*
|
|
1082
|
-
* ```ts
|
|
1083
|
-
* import { Schema } from "effect"
|
|
1083
|
+
* ```ts import.meta.vitest
|
|
1084
|
+
* import { Schema, SchemaIssue } from "effect"
|
|
1084
1085
|
*
|
|
1085
1086
|
* const input: unknown = "hello"
|
|
1086
1087
|
*
|
|
1087
1088
|
* // This will pass silently (no return value) and narrow input to string
|
|
1088
1089
|
* Schema.asserts(Schema.String, input)
|
|
1089
|
-
*
|
|
1090
|
+
* input.toUpperCase() // => "HELLO"
|
|
1090
1091
|
*
|
|
1091
1092
|
* // This will throw an error
|
|
1092
1093
|
* try {
|
|
1093
1094
|
* const invalid: unknown = 123
|
|
1094
1095
|
* Schema.asserts(Schema.String, invalid)
|
|
1095
1096
|
* } catch (error) {
|
|
1096
|
-
*
|
|
1097
|
+
* if (error instanceof Error) {
|
|
1098
|
+
* SchemaIssue.isIssue(error.cause) // => true
|
|
1099
|
+
* }
|
|
1097
1100
|
* }
|
|
1098
1101
|
* ```
|
|
1099
1102
|
*
|
|
@@ -1399,19 +1402,12 @@ export declare const decodePromise: <S extends ConstraintDecoder<unknown>>(schem
|
|
|
1399
1402
|
*
|
|
1400
1403
|
* **Example** (Decoding with a transformation schema)
|
|
1401
1404
|
*
|
|
1402
|
-
* ```ts
|
|
1405
|
+
* ```ts import.meta.vitest
|
|
1403
1406
|
* import { Schema } from "effect"
|
|
1404
1407
|
*
|
|
1405
1408
|
* const NumberFromString = Schema.NumberFromString
|
|
1406
1409
|
*
|
|
1407
|
-
*
|
|
1408
|
-
* // Output: 42
|
|
1409
|
-
*
|
|
1410
|
-
* Schema.decodeUnknownSync(NumberFromString)("not a number")
|
|
1411
|
-
* // throws SchemaError: NumberFromString
|
|
1412
|
-
* // └─ Encoded side transformation failure
|
|
1413
|
-
* // └─ NumberFromString
|
|
1414
|
-
* // └─ Expected a numeric string, actual "not a number"
|
|
1410
|
+
* Schema.decodeUnknownSync(NumberFromString)("42") // => 42
|
|
1415
1411
|
* ```
|
|
1416
1412
|
*
|
|
1417
1413
|
* @see {@link SchemaParser.decodeUnknownSync} for the adapter that throws an `Error` whose cause is `SchemaIssue.Issue`
|
|
@@ -1465,13 +1461,12 @@ export declare const decodeSync: <S extends ConstraintDecoder<unknown>>(schema:
|
|
|
1465
1461
|
*
|
|
1466
1462
|
* **Example** (Encoding a value to a string)
|
|
1467
1463
|
*
|
|
1468
|
-
* ```ts
|
|
1464
|
+
* ```ts import.meta.vitest
|
|
1469
1465
|
* import { Effect, Schema } from "effect"
|
|
1470
1466
|
*
|
|
1471
1467
|
* const NumberFromString = Schema.NumberFromString
|
|
1472
1468
|
*
|
|
1473
|
-
* Effect.runPromise(Schema.encodeUnknownEffect(NumberFromString)(42))
|
|
1474
|
-
* // Output: "42"
|
|
1469
|
+
* await Effect.runPromise(Schema.encodeUnknownEffect(NumberFromString)(42)) // => "42"
|
|
1475
1470
|
* ```
|
|
1476
1471
|
*
|
|
1477
1472
|
* @see {@link SchemaParser.encodeUnknownEffect} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
@@ -1833,7 +1828,7 @@ interface optionalKeyLambda extends Lambda {
|
|
|
1833
1828
|
*
|
|
1834
1829
|
* **Example** (Creating a struct with optional key)
|
|
1835
1830
|
*
|
|
1836
|
-
* ```ts
|
|
1831
|
+
* ```ts import.meta.vitest
|
|
1837
1832
|
* import { Schema } from "effect"
|
|
1838
1833
|
*
|
|
1839
1834
|
* const schema = Schema.Struct({
|
|
@@ -1892,7 +1887,7 @@ interface optionalLambda extends Lambda {
|
|
|
1892
1887
|
*
|
|
1893
1888
|
* **Example** (Defining an optional field accepting undefined)
|
|
1894
1889
|
*
|
|
1895
|
-
* ```ts
|
|
1890
|
+
* ```ts import.meta.vitest
|
|
1896
1891
|
* import { Schema } from "effect"
|
|
1897
1892
|
*
|
|
1898
1893
|
* const schema = Schema.Struct({
|
|
@@ -2059,12 +2054,12 @@ export interface flip<S extends Top> extends BottomLazy<SchemaAST.AST, flip<S>,
|
|
|
2059
2054
|
*
|
|
2060
2055
|
* **Example** (Flipping a number-from-string schema)
|
|
2061
2056
|
*
|
|
2062
|
-
* ```ts
|
|
2057
|
+
* ```ts import.meta.vitest
|
|
2063
2058
|
* import { Schema } from "effect"
|
|
2064
2059
|
*
|
|
2065
2060
|
* // NumberFromString: decodes string → number
|
|
2066
2061
|
* const flipped = Schema.flip(Schema.NumberFromString)
|
|
2067
|
-
*
|
|
2062
|
+
* Schema.decodeSync(flipped)(42) // => "42"
|
|
2068
2063
|
* ```
|
|
2069
2064
|
*
|
|
2070
2065
|
* @category transforming
|
|
@@ -2086,11 +2081,12 @@ export interface Literal<L extends SchemaAST.LiteralValue> extends Bottom<L, L,
|
|
|
2086
2081
|
*
|
|
2087
2082
|
* **Example** (Defining a string literal)
|
|
2088
2083
|
*
|
|
2089
|
-
* ```ts
|
|
2084
|
+
* ```ts import.meta.vitest
|
|
2090
2085
|
* import { Schema } from "effect"
|
|
2091
2086
|
*
|
|
2092
2087
|
* const schema = Schema.Literal("hello")
|
|
2093
2088
|
* // Type: Schema.Literal<"hello">
|
|
2089
|
+
* Schema.decodeSync(schema)("hello") // => "hello"
|
|
2094
2090
|
* ```
|
|
2095
2091
|
*
|
|
2096
2092
|
* @see {@link Literals} for a schema that represents a union of literals.
|
|
@@ -2180,11 +2176,11 @@ export interface TemplateLiteral<Parts extends TemplateLiteral.Parts> extends Bo
|
|
|
2180
2176
|
*
|
|
2181
2177
|
* **Example** (Defining a URL path pattern)
|
|
2182
2178
|
*
|
|
2183
|
-
* ```ts
|
|
2179
|
+
* ```ts import.meta.vitest
|
|
2184
2180
|
* import { Schema } from "effect"
|
|
2185
2181
|
*
|
|
2186
2182
|
* const schema = Schema.TemplateLiteral(["/user/", Schema.Number])
|
|
2187
|
-
*
|
|
2183
|
+
* Schema.is(schema)("/user/123") // => true
|
|
2188
2184
|
* ```
|
|
2189
2185
|
*
|
|
2190
2186
|
* @see {@link TemplateLiteralParser} for a schema that also parses matched parts into a tuple.
|
|
@@ -2246,11 +2242,11 @@ export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> exte
|
|
|
2246
2242
|
*
|
|
2247
2243
|
* **Example** (Parsing path parameters)
|
|
2248
2244
|
*
|
|
2249
|
-
* ```ts
|
|
2245
|
+
* ```ts import.meta.vitest
|
|
2250
2246
|
* import { Schema } from "effect"
|
|
2251
2247
|
*
|
|
2252
2248
|
* const schema = Schema.TemplateLiteralParser(["/user/", Schema.NumberFromString])
|
|
2253
|
-
*
|
|
2249
|
+
* Schema.decodeSync(schema)("/user/42") // => ["/user/", 42]
|
|
2254
2250
|
* ```
|
|
2255
2251
|
*
|
|
2256
2252
|
* @see {@link TemplateLiteral} for a validation-only version that keeps the string encoded.
|
|
@@ -2274,7 +2270,7 @@ export interface Enum<A extends {
|
|
|
2274
2270
|
*
|
|
2275
2271
|
* **Example** (Defining a direction enum)
|
|
2276
2272
|
*
|
|
2277
|
-
* ```ts
|
|
2273
|
+
* ```ts import.meta.vitest
|
|
2278
2274
|
* import { Schema } from "effect"
|
|
2279
2275
|
*
|
|
2280
2276
|
* enum Direction {
|
|
@@ -2283,7 +2279,7 @@ export interface Enum<A extends {
|
|
|
2283
2279
|
* }
|
|
2284
2280
|
*
|
|
2285
2281
|
* const schema = Schema.Enum(Direction)
|
|
2286
|
-
* //
|
|
2282
|
+
* Schema.decodeSync(schema)(Direction.Up) // => "Up"
|
|
2287
2283
|
* ```
|
|
2288
2284
|
*
|
|
2289
2285
|
* @category constructors
|
|
@@ -2431,7 +2427,7 @@ export interface Boolean extends Bottom<boolean, boolean, never, never, SchemaAS
|
|
|
2431
2427
|
*
|
|
2432
2428
|
* @see {@link BooleanFromBit} for a schema that decodes bit literals `0` or `1` into a boolean
|
|
2433
2429
|
*
|
|
2434
|
-
* @category
|
|
2430
|
+
* @category schemas
|
|
2435
2431
|
* @since 4.0.0
|
|
2436
2432
|
*/
|
|
2437
2433
|
export declare const Boolean: Boolean;
|
|
@@ -2530,11 +2526,12 @@ export interface UniqueSymbol<sym extends symbol> extends Bottom<sym, sym, never
|
|
|
2530
2526
|
*
|
|
2531
2527
|
* **Example** (Defining a specific symbol)
|
|
2532
2528
|
*
|
|
2533
|
-
* ```ts
|
|
2529
|
+
* ```ts import.meta.vitest
|
|
2534
2530
|
* import { Schema } from "effect"
|
|
2535
2531
|
*
|
|
2536
2532
|
* const mySymbol = Symbol.for("mySymbol")
|
|
2537
2533
|
* const schema = Schema.UniqueSymbol(mySymbol)
|
|
2534
|
+
* Schema.decodeSync(schema)(mySymbol) === mySymbol // => true
|
|
2538
2535
|
* ```
|
|
2539
2536
|
*
|
|
2540
2537
|
* @see {@link Symbol} for a schema that accepts any symbol.
|
|
@@ -2667,7 +2664,7 @@ export declare namespace Struct {
|
|
|
2667
2664
|
type ReadonlyMakeIn<F extends Fields> = {
|
|
2668
2665
|
readonly [K in keyof F]: F[K]["~type.make"];
|
|
2669
2666
|
};
|
|
2670
|
-
type MakeInView<F extends Fields, O extends keyof F = TypeOptionalKeys<F> | TypeConstructorDefaultedKeys<F>> = [O] extends [never] ? ReadonlyMakeIn<F
|
|
2667
|
+
type MakeInView<F extends Fields, O extends keyof F = TypeOptionalKeys<F> | TypeConstructorDefaultedKeys<F>> = [O] extends [never] ? Simplify<ReadonlyMakeIn<F>> : Simplify<SetOptional<ReadonlyMakeIn<F>, O>>;
|
|
2671
2668
|
/**
|
|
2672
2669
|
* Computes the input object type accepted when constructing a struct value.
|
|
2673
2670
|
*
|
|
@@ -2701,7 +2698,7 @@ export interface Struct<Fields extends Struct.Fields> extends BottomLazy<SchemaA
|
|
|
2701
2698
|
*
|
|
2702
2699
|
* **Example** (Reusing fields across structs)
|
|
2703
2700
|
*
|
|
2704
|
-
* ```ts
|
|
2701
|
+
* ```ts import.meta.vitest
|
|
2705
2702
|
* import { Schema } from "effect"
|
|
2706
2703
|
*
|
|
2707
2704
|
* const Timestamped = Schema.Struct({
|
|
@@ -2714,6 +2711,7 @@ export interface Struct<Fields extends Struct.Fields> extends BottomLazy<SchemaA
|
|
|
2714
2711
|
* name: Schema.String,
|
|
2715
2712
|
* email: Schema.String
|
|
2716
2713
|
* })
|
|
2714
|
+
* Object.keys(User.fields) // => ["createdAt", "updatedAt", "name", "email"]
|
|
2717
2715
|
* ```
|
|
2718
2716
|
*/
|
|
2719
2717
|
readonly fields: Fields;
|
|
@@ -2750,7 +2748,7 @@ export interface Struct<Fields extends Struct.Fields> extends BottomLazy<SchemaA
|
|
|
2750
2748
|
*
|
|
2751
2749
|
* **Example** (Defining a basic struct)
|
|
2752
2750
|
*
|
|
2753
|
-
* ```ts
|
|
2751
|
+
* ```ts import.meta.vitest
|
|
2754
2752
|
* import { Schema } from "effect"
|
|
2755
2753
|
*
|
|
2756
2754
|
* const Person = Schema.Struct({
|
|
@@ -2762,9 +2760,7 @@ export interface Struct<Fields extends Struct.Fields> extends BottomLazy<SchemaA
|
|
|
2762
2760
|
* // { readonly name: string; readonly age: number; readonly email?: string }
|
|
2763
2761
|
* type Person = typeof Person.Type
|
|
2764
2762
|
*
|
|
2765
|
-
*
|
|
2766
|
-
* console.log(alice)
|
|
2767
|
-
* // { name: 'Alice', age: 30 }
|
|
2763
|
+
* Schema.decodeUnknownSync(Person)({ name: "Alice", age: 30 }) // => { name: "Alice", age: 30 }
|
|
2768
2764
|
* ```
|
|
2769
2765
|
*
|
|
2770
2766
|
* @category constructors
|
|
@@ -2789,7 +2785,7 @@ interface fieldsAssign<NewFields extends Struct.Fields> extends Lambda {
|
|
|
2789
2785
|
*
|
|
2790
2786
|
* **Example** (Adding fields to a union of structs)
|
|
2791
2787
|
*
|
|
2792
|
-
* ```ts
|
|
2788
|
+
* ```ts import.meta.vitest
|
|
2793
2789
|
* import { Schema, Tuple } from "effect"
|
|
2794
2790
|
*
|
|
2795
2791
|
* // Add a new field to all members of a union of structs
|
|
@@ -2797,6 +2793,7 @@ interface fieldsAssign<NewFields extends Struct.Fields> extends Lambda {
|
|
|
2797
2793
|
* Schema.Struct({ a: Schema.String }),
|
|
2798
2794
|
* Schema.Struct({ b: Schema.Number })
|
|
2799
2795
|
* ]).mapMembers(Tuple.map(Schema.fieldsAssign({ c: Schema.Number })))
|
|
2796
|
+
* Schema.decodeSync(schema)({ a: "a", c: 1 }) // => { a: "a", c: 1 }
|
|
2800
2797
|
* ```
|
|
2801
2798
|
*
|
|
2802
2799
|
* @category combinators
|
|
@@ -2830,16 +2827,14 @@ export interface encodeKeys<S extends Constraint & {
|
|
|
2830
2827
|
*
|
|
2831
2828
|
* **Example** (Renaming `name` to `full_name` in the encoded form)
|
|
2832
2829
|
*
|
|
2833
|
-
* ```ts
|
|
2830
|
+
* ```ts import.meta.vitest
|
|
2834
2831
|
* import { Schema } from "effect"
|
|
2835
2832
|
*
|
|
2836
2833
|
* const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
|
|
2837
2834
|
* const Encoded = Person.pipe(Schema.encodeKeys({ name: "full_name" }))
|
|
2838
2835
|
*
|
|
2839
2836
|
* // Decodes { full_name: "Alice", age: 30 } → { name: "Alice", age: 30 }
|
|
2840
|
-
*
|
|
2841
|
-
* console.log(alice)
|
|
2842
|
-
* // { name: 'Alice', age: 30 }
|
|
2837
|
+
* Schema.decodeUnknownSync(Encoded)({ full_name: "Alice", age: 30 }) // => { name: "Alice", age: 30 }
|
|
2843
2838
|
* ```
|
|
2844
2839
|
*
|
|
2845
2840
|
* @category transforming
|
|
@@ -2862,7 +2857,7 @@ export declare function encodeKeys<S extends Constraint & {
|
|
|
2862
2857
|
*
|
|
2863
2858
|
* **Example** (Adding a computed `fullName` field)
|
|
2864
2859
|
*
|
|
2865
|
-
* ```ts
|
|
2860
|
+
* ```ts import.meta.vitest
|
|
2866
2861
|
* import { Option, Schema } from "effect"
|
|
2867
2862
|
*
|
|
2868
2863
|
* const Person = Schema.Struct({ first: Schema.String, last: Schema.String })
|
|
@@ -2874,8 +2869,7 @@ export declare function encodeKeys<S extends Constraint & {
|
|
|
2874
2869
|
* )
|
|
2875
2870
|
*
|
|
2876
2871
|
* const alice = Schema.decodeUnknownSync(Extended)({ first: "Alice", last: "Smith" })
|
|
2877
|
-
*
|
|
2878
|
-
* // Alice Smith
|
|
2872
|
+
* alice.fullName // => "Alice Smith"
|
|
2879
2873
|
* ```
|
|
2880
2874
|
*
|
|
2881
2875
|
* @category transforming
|
|
@@ -3067,9 +3061,16 @@ export interface $Record<Key extends Record.Key, Value extends Constraint> exten
|
|
|
3067
3061
|
* For transformed key schemas, property selection is based on encoded property
|
|
3068
3062
|
* names before the selected key is decoded.
|
|
3069
3063
|
*
|
|
3064
|
+
* **Gotchas**
|
|
3065
|
+
*
|
|
3066
|
+
* When decoded or encoded key transformations produce the same property key,
|
|
3067
|
+
* sequential parsing applies selected own properties in selection order, so
|
|
3068
|
+
* the later selected property overwrites the earlier value. With concurrency
|
|
3069
|
+
* greater than `1`, completion order determines which value is retained.
|
|
3070
|
+
*
|
|
3070
3071
|
* **Example** (Defining a string-keyed record of numbers)
|
|
3071
3072
|
*
|
|
3072
|
-
* ```ts
|
|
3073
|
+
* ```ts import.meta.vitest
|
|
3073
3074
|
* import { Schema } from "effect"
|
|
3074
3075
|
*
|
|
3075
3076
|
* const schema = Schema.Record(Schema.String, Schema.Number)
|
|
@@ -3077,20 +3078,13 @@ export interface $Record<Key extends Record.Key, Value extends Constraint> exten
|
|
|
3077
3078
|
* // { readonly [x: string]: number }
|
|
3078
3079
|
* type R = typeof schema.Type
|
|
3079
3080
|
*
|
|
3080
|
-
*
|
|
3081
|
-
* console.log(result)
|
|
3082
|
-
* // { a: 1, b: 2 }
|
|
3081
|
+
* Schema.decodeUnknownSync(schema)({ a: 1, b: 2 }) // => { a: 1, b: 2 }
|
|
3083
3082
|
* ```
|
|
3084
3083
|
*
|
|
3085
3084
|
* @category constructors
|
|
3086
3085
|
* @since 3.10.0
|
|
3087
3086
|
*/
|
|
3088
|
-
export declare function Record<Key extends Record.Key, Value extends Constraint>(key: Key, value: Value,
|
|
3089
|
-
readonly keyValueCombiner: {
|
|
3090
|
-
readonly decode?: Combiner.Combiner<readonly [Key["Type"], Value["Type"]]> | undefined;
|
|
3091
|
-
readonly encode?: Combiner.Combiner<readonly [Key["Encoded"], Value["Encoded"]]> | undefined;
|
|
3092
|
-
};
|
|
3093
|
-
}): $Record<Key, Value>;
|
|
3087
|
+
export declare function Record<Key extends Record.Key, Value extends Constraint>(key: Key, value: Value): $Record<Key, Value>;
|
|
3094
3088
|
/**
|
|
3095
3089
|
* Namespace for `StructWithRest` type utilities.
|
|
3096
3090
|
*
|
|
@@ -3194,7 +3188,7 @@ export declare namespace StructWithRest {
|
|
|
3194
3188
|
*
|
|
3195
3189
|
* **Example** (Checking record compatibility)
|
|
3196
3190
|
*
|
|
3197
|
-
* ```ts
|
|
3191
|
+
* ```ts import.meta.vitest
|
|
3198
3192
|
* import { Schema } from "effect"
|
|
3199
3193
|
*
|
|
3200
3194
|
* const user = Schema.Struct({ id: Schema.String })
|
|
@@ -3251,7 +3245,7 @@ export interface StructWithRest<S extends StructWithRest.Objects, Records extend
|
|
|
3251
3245
|
*
|
|
3252
3246
|
* **Example** (Defining structs with string-indexed extra keys)
|
|
3253
3247
|
*
|
|
3254
|
-
* ```ts
|
|
3248
|
+
* ```ts import.meta.vitest
|
|
3255
3249
|
* import { Schema } from "effect"
|
|
3256
3250
|
*
|
|
3257
3251
|
* const schema = Schema.StructWithRest(
|
|
@@ -3411,14 +3405,12 @@ export interface Tuple<Elements extends Tuple.Elements> extends BottomLazy<Schem
|
|
|
3411
3405
|
*
|
|
3412
3406
|
* **Example** (Defining a pair of string and number)
|
|
3413
3407
|
*
|
|
3414
|
-
* ```ts
|
|
3408
|
+
* ```ts import.meta.vitest
|
|
3415
3409
|
* import { Schema } from "effect"
|
|
3416
3410
|
*
|
|
3417
3411
|
* const schema = Schema.Tuple([Schema.String, Schema.Number])
|
|
3418
3412
|
*
|
|
3419
|
-
*
|
|
3420
|
-
* console.log(pair)
|
|
3421
|
-
* // [ 'hello', 42 ]
|
|
3413
|
+
* Schema.decodeUnknownSync(schema)(["hello", 42]) // => ["hello", 42]
|
|
3422
3414
|
* ```
|
|
3423
3415
|
*
|
|
3424
3416
|
* @category constructors
|
|
@@ -3571,7 +3563,7 @@ export interface TupleWithRest<S extends TupleWithRest.TupleType, Rest extends T
|
|
|
3571
3563
|
*
|
|
3572
3564
|
* **Example** (Defining tuples with rest elements)
|
|
3573
3565
|
*
|
|
3574
|
-
* ```ts
|
|
3566
|
+
* ```ts import.meta.vitest
|
|
3575
3567
|
* import { Schema } from "effect"
|
|
3576
3568
|
*
|
|
3577
3569
|
* // [string, number, ...boolean[]]
|
|
@@ -3580,9 +3572,7 @@ export interface TupleWithRest<S extends TupleWithRest.TupleType, Rest extends T
|
|
|
3580
3572
|
* [Schema.Boolean]
|
|
3581
3573
|
* )
|
|
3582
3574
|
*
|
|
3583
|
-
*
|
|
3584
|
-
* console.log(result)
|
|
3585
|
-
* // [ 'hello', 1, true, false ]
|
|
3575
|
+
* Schema.decodeUnknownSync(schema)(["hello", 1, true, false]) // => ["hello", 1, true, false]
|
|
3586
3576
|
* ```
|
|
3587
3577
|
*
|
|
3588
3578
|
* @category constructors
|
|
@@ -3620,14 +3610,12 @@ export {
|
|
|
3620
3610
|
*
|
|
3621
3611
|
* **Example** (Defining an array of strings)
|
|
3622
3612
|
*
|
|
3623
|
-
* ```ts
|
|
3613
|
+
* ```ts import.meta.vitest
|
|
3624
3614
|
* import { Schema } from "effect"
|
|
3625
3615
|
*
|
|
3626
3616
|
* const schema = Schema.Array(Schema.String)
|
|
3627
3617
|
*
|
|
3628
|
-
*
|
|
3629
|
-
* console.log(result)
|
|
3630
|
-
* // [ 'a', 'b', 'c' ]
|
|
3618
|
+
* Schema.decodeUnknownSync(schema)(["a", "b", "c"]) // => ["a", "b", "c"]
|
|
3631
3619
|
* ```
|
|
3632
3620
|
*
|
|
3633
3621
|
* @category constructors
|
|
@@ -3660,13 +3648,12 @@ interface NonEmptyArrayLambda extends Lambda {
|
|
|
3660
3648
|
*
|
|
3661
3649
|
* **Example** (Defining a non-empty array of numbers)
|
|
3662
3650
|
*
|
|
3663
|
-
* ```ts
|
|
3651
|
+
* ```ts import.meta.vitest
|
|
3664
3652
|
* import { Schema } from "effect"
|
|
3665
3653
|
*
|
|
3666
3654
|
* const schema = Schema.NonEmptyArray(Schema.Number)
|
|
3667
3655
|
*
|
|
3668
|
-
* Schema.decodeUnknownSync(schema)([1, 2, 3])
|
|
3669
|
-
* Schema.decodeUnknownSync(schema)([]) // throws
|
|
3656
|
+
* Schema.decodeUnknownSync(schema)([1, 2, 3]) // => [1, 2, 3]
|
|
3670
3657
|
* ```
|
|
3671
3658
|
*
|
|
3672
3659
|
* @category constructors
|
|
@@ -3761,13 +3748,16 @@ interface mutableLambda extends Lambda {
|
|
|
3761
3748
|
*
|
|
3762
3749
|
* **Example** (Defining mutable arrays)
|
|
3763
3750
|
*
|
|
3764
|
-
* ```ts
|
|
3751
|
+
* ```ts import.meta.vitest
|
|
3765
3752
|
* import { Schema } from "effect"
|
|
3766
3753
|
*
|
|
3767
3754
|
* const schema = Schema.mutable(Schema.Array(Schema.Number))
|
|
3768
3755
|
*
|
|
3769
3756
|
* // number[] (mutable)
|
|
3770
3757
|
* type T = typeof schema.Type
|
|
3758
|
+
* const value: T = [1, 2]
|
|
3759
|
+
* value.push(3)
|
|
3760
|
+
* value // => [1, 2, 3]
|
|
3771
3761
|
* ```
|
|
3772
3762
|
*
|
|
3773
3763
|
* @category transforming
|
|
@@ -3837,13 +3827,13 @@ export interface Union<Members extends ReadonlyArray<Constraint>> extends Bottom
|
|
|
3837
3827
|
*
|
|
3838
3828
|
* **Example** (Defining a string or number union)
|
|
3839
3829
|
*
|
|
3840
|
-
* ```ts
|
|
3830
|
+
* ```ts import.meta.vitest
|
|
3841
3831
|
* import { Schema } from "effect"
|
|
3842
3832
|
*
|
|
3843
3833
|
* const schema = Schema.Union([Schema.String, Schema.Number])
|
|
3844
3834
|
*
|
|
3845
|
-
* Schema.decodeUnknownSync(schema)("hello") // "hello"
|
|
3846
|
-
* Schema.decodeUnknownSync(schema)(42)
|
|
3835
|
+
* Schema.decodeUnknownSync(schema)("hello") // => "hello"
|
|
3836
|
+
* Schema.decodeUnknownSync(schema)(42) // => 42
|
|
3847
3837
|
* ```
|
|
3848
3838
|
*
|
|
3849
3839
|
* @category constructors
|
|
@@ -3879,11 +3869,11 @@ export interface Literals<L extends ReadonlyArray<SchemaAST.LiteralValue>> exten
|
|
|
3879
3869
|
*
|
|
3880
3870
|
* **Example** (Defining status codes)
|
|
3881
3871
|
*
|
|
3882
|
-
* ```ts
|
|
3872
|
+
* ```ts import.meta.vitest
|
|
3883
3873
|
* import { Schema } from "effect"
|
|
3884
3874
|
*
|
|
3885
3875
|
* const schema = Schema.Literals(["active", "inactive", "pending"])
|
|
3886
|
-
*
|
|
3876
|
+
* Schema.decodeSync(schema)("active") // => "active"
|
|
3887
3877
|
* ```
|
|
3888
3878
|
*
|
|
3889
3879
|
* @see {@link Literal} for a schema that represents a single literal.
|
|
@@ -3973,7 +3963,7 @@ export interface suspend<S extends Constraint> extends BottomLazy<SchemaAST.Susp
|
|
|
3973
3963
|
*
|
|
3974
3964
|
* **Example** (Defining recursive tree schemas)
|
|
3975
3965
|
*
|
|
3976
|
-
* ```ts
|
|
3966
|
+
* ```ts import.meta.vitest
|
|
3977
3967
|
* import { Schema } from "effect"
|
|
3978
3968
|
*
|
|
3979
3969
|
* interface Tree {
|
|
@@ -3985,6 +3975,7 @@ export interface suspend<S extends Constraint> extends BottomLazy<SchemaAST.Susp
|
|
|
3985
3975
|
* value: Schema.Number,
|
|
3986
3976
|
* children: Schema.Array(Schema.suspend((): Schema.Codec<Tree> => Tree))
|
|
3987
3977
|
* })
|
|
3978
|
+
* Schema.decodeSync(Tree)({ value: 1, children: [] }) // => { value: 1, children: [] }
|
|
3988
3979
|
* ```
|
|
3989
3980
|
*
|
|
3990
3981
|
* @category constructors
|
|
@@ -3997,12 +3988,14 @@ export declare function suspend<S extends Constraint>(f: () => S): suspend<S>;
|
|
|
3997
3988
|
*
|
|
3998
3989
|
* **Example** (Adding checks to a schema)
|
|
3999
3990
|
*
|
|
4000
|
-
* ```ts
|
|
3991
|
+
* ```ts import.meta.vitest
|
|
4001
3992
|
* import { Schema } from "effect"
|
|
4002
3993
|
*
|
|
4003
3994
|
* const AgeSchema = Schema.Finite.pipe(
|
|
4004
3995
|
* Schema.check(Schema.isGreaterThanOrEqualTo(0), Schema.isLessThanOrEqualTo(120))
|
|
4005
3996
|
* )
|
|
3997
|
+
* Schema.is(AgeSchema)(42) // => true
|
|
3998
|
+
* Schema.is(AgeSchema)(121) // => false
|
|
4006
3999
|
* ```
|
|
4007
4000
|
*
|
|
4008
4001
|
* @category filtering
|
|
@@ -4116,14 +4109,17 @@ export interface middlewareDecoding<S extends Constraint, RD> extends BottomLazy
|
|
|
4116
4109
|
*
|
|
4117
4110
|
* **Example** (Logging decode failures)
|
|
4118
4111
|
*
|
|
4119
|
-
* ```ts
|
|
4112
|
+
* ```ts import.meta.vitest
|
|
4120
4113
|
* import { Effect, Schema } from "effect"
|
|
4121
4114
|
*
|
|
4115
|
+
* const events: Array<string> = []
|
|
4122
4116
|
* const Logged = Schema.String.pipe(
|
|
4123
4117
|
* Schema.middlewareDecoding((effect) =>
|
|
4124
|
-
* Effect.tapError(effect, (
|
|
4118
|
+
* Effect.tapError(effect, () => Effect.sync(() => events.push("decode failed")))
|
|
4125
4119
|
* )
|
|
4126
4120
|
* )
|
|
4121
|
+
* Effect.runSync(Effect.result(Schema.decodeUnknownEffect(Logged)(42)))
|
|
4122
|
+
* events // => ["decode failed"]
|
|
4127
4123
|
* ```
|
|
4128
4124
|
*
|
|
4129
4125
|
* @see {@link catchDecoding} for a simpler error-recovery variant
|
|
@@ -4158,14 +4154,17 @@ export interface middlewareEncoding<S extends Constraint, RE> extends BottomLazy
|
|
|
4158
4154
|
*
|
|
4159
4155
|
* **Example** (Logging encode failures)
|
|
4160
4156
|
*
|
|
4161
|
-
* ```ts
|
|
4157
|
+
* ```ts import.meta.vitest
|
|
4162
4158
|
* import { Effect, Schema } from "effect"
|
|
4163
4159
|
*
|
|
4160
|
+
* const events: Array<string> = []
|
|
4164
4161
|
* const Logged = Schema.String.pipe(
|
|
4165
4162
|
* Schema.middlewareEncoding((effect) =>
|
|
4166
|
-
* Effect.tapError(effect, (
|
|
4163
|
+
* Effect.tapError(effect, () => Effect.sync(() => events.push("encode failed")))
|
|
4167
4164
|
* )
|
|
4168
4165
|
* )
|
|
4166
|
+
* Effect.runSync(Effect.result(Schema.encodeUnknownEffect(Logged)(42)))
|
|
4167
|
+
* events // => ["encode failed"]
|
|
4169
4168
|
* ```
|
|
4170
4169
|
*
|
|
4171
4170
|
* @see {@link catchEncoding} for a simpler error-recovery variant
|
|
@@ -4183,12 +4182,13 @@ export declare function middlewareEncoding<S extends Constraint, RE>(encode: (ef
|
|
|
4183
4182
|
*
|
|
4184
4183
|
* **Example** (Returning a default on decode failure)
|
|
4185
4184
|
*
|
|
4186
|
-
* ```ts
|
|
4185
|
+
* ```ts import.meta.vitest
|
|
4187
4186
|
* import { Effect, Option, Schema } from "effect"
|
|
4188
4187
|
*
|
|
4189
4188
|
* const schema = Schema.Number.pipe(
|
|
4190
4189
|
* Schema.catchDecoding((_issue) => Effect.succeed(Option.some(0)))
|
|
4191
4190
|
* )
|
|
4191
|
+
* Effect.runSync(Schema.decodeUnknownEffect(schema)("invalid")) // => 0
|
|
4192
4192
|
* ```
|
|
4193
4193
|
*
|
|
4194
4194
|
* @see {@link catchDecodingWithContext} to add service requirements to the handler
|
|
@@ -4304,7 +4304,7 @@ export interface compose<To extends Constraint, From extends Constraint> extends
|
|
|
4304
4304
|
*
|
|
4305
4305
|
* **Example** (Transforming strings to numbers with a schema transformation)
|
|
4306
4306
|
*
|
|
4307
|
-
* ```ts
|
|
4307
|
+
* ```ts import.meta.vitest
|
|
4308
4308
|
* import { Schema, SchemaGetter } from "effect"
|
|
4309
4309
|
*
|
|
4310
4310
|
* const NumberFromString = Schema.String.pipe(
|
|
@@ -4317,8 +4317,7 @@ export interface compose<To extends Constraint, From extends Constraint> extends
|
|
|
4317
4317
|
* )
|
|
4318
4318
|
* )
|
|
4319
4319
|
*
|
|
4320
|
-
*
|
|
4321
|
-
* // result: 123
|
|
4320
|
+
* Schema.decodeUnknownSync(NumberFromString)("123") // => 123
|
|
4322
4321
|
* ```
|
|
4323
4322
|
*
|
|
4324
4323
|
* @category transforming
|
|
@@ -4355,7 +4354,7 @@ export declare function decodeTo<To extends Constraint, From extends Constraint,
|
|
|
4355
4354
|
*
|
|
4356
4355
|
* **Example** (Trimming string values during encoding/decoding)
|
|
4357
4356
|
*
|
|
4358
|
-
* ```ts
|
|
4357
|
+
* ```ts import.meta.vitest
|
|
4359
4358
|
* import { Schema, SchemaGetter } from "effect"
|
|
4360
4359
|
*
|
|
4361
4360
|
* const Trimmed = Schema.String.pipe(
|
|
@@ -4365,8 +4364,7 @@ export declare function decodeTo<To extends Constraint, From extends Constraint,
|
|
|
4365
4364
|
* })
|
|
4366
4365
|
* )
|
|
4367
4366
|
*
|
|
4368
|
-
*
|
|
4369
|
-
* // result: "hello"
|
|
4367
|
+
* Schema.decodeUnknownSync(Trimmed)(" hello ") // => "hello"
|
|
4370
4368
|
* ```
|
|
4371
4369
|
*
|
|
4372
4370
|
* @category transforming
|
|
@@ -4391,7 +4389,7 @@ export declare function decode<S extends Constraint, RD = never, RE = never>(tra
|
|
|
4391
4389
|
*
|
|
4392
4390
|
* **Example** (Encoding a number back to a string)
|
|
4393
4391
|
*
|
|
4394
|
-
* ```ts
|
|
4392
|
+
* ```ts import.meta.vitest
|
|
4395
4393
|
* import { Schema, SchemaGetter } from "effect"
|
|
4396
4394
|
*
|
|
4397
4395
|
* const NumberFromString = Schema.Number.pipe(
|
|
@@ -4400,6 +4398,7 @@ export declare function decode<S extends Constraint, RD = never, RE = never>(tra
|
|
|
4400
4398
|
* encode: SchemaGetter.transform((n: number) => String(n))
|
|
4401
4399
|
* })
|
|
4402
4400
|
* )
|
|
4401
|
+
* Schema.decodeSync(NumberFromString)("42") // => 42
|
|
4403
4402
|
* ```
|
|
4404
4403
|
*
|
|
4405
4404
|
* @category transforming
|
|
@@ -4421,7 +4420,7 @@ export declare function encodeTo<To extends Constraint, From extends Constraint,
|
|
|
4421
4420
|
*
|
|
4422
4421
|
* **Example** (Upper-casing encoded strings)
|
|
4423
4422
|
*
|
|
4424
|
-
* ```ts
|
|
4423
|
+
* ```ts import.meta.vitest
|
|
4425
4424
|
* import { Schema, SchemaGetter } from "effect"
|
|
4426
4425
|
*
|
|
4427
4426
|
* const UpperFromLower = Schema.String.pipe(
|
|
@@ -4430,6 +4429,7 @@ export declare function encodeTo<To extends Constraint, From extends Constraint,
|
|
|
4430
4429
|
* encode: SchemaGetter.transform((s: string) => s.toUpperCase())
|
|
4431
4430
|
* })
|
|
4432
4431
|
* )
|
|
4432
|
+
* Schema.encodeSync(UpperFromLower)("hello") // => "HELLO"
|
|
4433
4433
|
* ```
|
|
4434
4434
|
*
|
|
4435
4435
|
* @category transforming
|
|
@@ -4478,7 +4478,7 @@ export interface withConstructorDefault<S extends Constraint & WithoutConstructo
|
|
|
4478
4478
|
*
|
|
4479
4479
|
* **Example** (Defining an optional field with a static default)
|
|
4480
4480
|
*
|
|
4481
|
-
* ```ts
|
|
4481
|
+
* ```ts import.meta.vitest
|
|
4482
4482
|
* import { Effect, Schema } from "effect"
|
|
4483
4483
|
*
|
|
4484
4484
|
* const MySchema = Schema.Struct({
|
|
@@ -4488,8 +4488,7 @@ export interface withConstructorDefault<S extends Constraint & WithoutConstructo
|
|
|
4488
4488
|
* )
|
|
4489
4489
|
* })
|
|
4490
4490
|
*
|
|
4491
|
-
*
|
|
4492
|
-
* // value: { name: "anonymous" }
|
|
4491
|
+
* MySchema.make({}).name // => "anonymous"
|
|
4493
4492
|
* ```
|
|
4494
4493
|
*
|
|
4495
4494
|
* @category constructors
|
|
@@ -4538,15 +4537,14 @@ export type DecodingDefaultOptions = {
|
|
|
4538
4537
|
*
|
|
4539
4538
|
* **Example** (Providing a default for a missing struct key)
|
|
4540
4539
|
*
|
|
4541
|
-
* ```ts
|
|
4540
|
+
* ```ts import.meta.vitest
|
|
4542
4541
|
* import { Effect, Schema } from "effect"
|
|
4543
4542
|
*
|
|
4544
4543
|
* const MySchema = Schema.Struct({
|
|
4545
4544
|
* name: Schema.String.pipe(Schema.withDecodingDefaultKey(Effect.succeed("anonymous")))
|
|
4546
4545
|
* })
|
|
4547
4546
|
*
|
|
4548
|
-
*
|
|
4549
|
-
* // result: { name: "anonymous" }
|
|
4547
|
+
* Schema.decodeUnknownSync(MySchema)({}).name // => "anonymous"
|
|
4550
4548
|
* ```
|
|
4551
4549
|
*
|
|
4552
4550
|
* @see {@link withDecodingDefault} for the value-level variant (key absent **or** `undefined`)
|
|
@@ -4619,15 +4617,14 @@ export interface withDecodingDefault<S extends Constraint, R = never> extends de
|
|
|
4619
4617
|
*
|
|
4620
4618
|
* **Example** (Providing a default for an optional field value)
|
|
4621
4619
|
*
|
|
4622
|
-
* ```ts
|
|
4620
|
+
* ```ts import.meta.vitest
|
|
4623
4621
|
* import { Effect, Schema } from "effect"
|
|
4624
4622
|
*
|
|
4625
4623
|
* const MySchema = Schema.Struct({
|
|
4626
4624
|
* name: Schema.String.pipe(Schema.optional, Schema.withDecodingDefault(Effect.succeed("anonymous")))
|
|
4627
4625
|
* })
|
|
4628
4626
|
*
|
|
4629
|
-
*
|
|
4630
|
-
* // result: { name: "anonymous" }
|
|
4627
|
+
* Schema.decodeUnknownSync(MySchema)({ name: undefined }).name // => "anonymous"
|
|
4631
4628
|
* ```
|
|
4632
4629
|
*
|
|
4633
4630
|
* @see {@link withDecodingDefaultKey} for the key-level variant (key absent only, not `undefined`)
|
|
@@ -4688,14 +4685,14 @@ export interface tag<Tag extends SchemaAST.LiteralValue> extends withConstructor
|
|
|
4688
4685
|
*
|
|
4689
4686
|
* **Example** (Defining a discriminated union tag)
|
|
4690
4687
|
*
|
|
4691
|
-
* ```ts
|
|
4688
|
+
* ```ts import.meta.vitest
|
|
4692
4689
|
* import { Schema } from "effect"
|
|
4693
4690
|
*
|
|
4694
4691
|
* const A = Schema.Struct({ _tag: Schema.tag("A"), value: Schema.Number })
|
|
4695
4692
|
*
|
|
4696
4693
|
* // _tag is optional in make, auto-filled to "A"
|
|
4697
4694
|
* const a = A.make({ value: 42 })
|
|
4698
|
-
* //
|
|
4695
|
+
* a // => { _tag: "A", value: 42 }
|
|
4699
4696
|
* ```
|
|
4700
4697
|
*
|
|
4701
4698
|
* @see {@link tagDefaultOmit} to also omit the tag during encoding
|
|
@@ -4719,7 +4716,7 @@ export declare function tag<Tag extends SchemaAST.LiteralValue>(literal: Tag): t
|
|
|
4719
4716
|
*
|
|
4720
4717
|
* **Example** (Omitting tags during encoding)
|
|
4721
4718
|
*
|
|
4722
|
-
* ```ts
|
|
4719
|
+
* ```ts import.meta.vitest
|
|
4723
4720
|
* import { Schema } from "effect"
|
|
4724
4721
|
*
|
|
4725
4722
|
* const A = Schema.Struct({
|
|
@@ -4728,8 +4725,7 @@ export declare function tag<Tag extends SchemaAST.LiteralValue>(literal: Tag): t
|
|
|
4728
4725
|
* })
|
|
4729
4726
|
*
|
|
4730
4727
|
* // Encode strips the _tag field
|
|
4731
|
-
*
|
|
4732
|
-
* // encoded: { value: 1 }
|
|
4728
|
+
* Schema.encodeUnknownSync(A)({ _tag: "A", value: 1 }) // => { value: 1 }
|
|
4733
4729
|
* ```
|
|
4734
4730
|
*
|
|
4735
4731
|
* @see {@link tag} for the variant that keeps the tag during encoding
|
|
@@ -4761,7 +4757,7 @@ export type TaggedStruct<Tag extends SchemaAST.LiteralValue, Fields extends Stru
|
|
|
4761
4757
|
*
|
|
4762
4758
|
* **Example** (Defining a tagged struct shorthand)
|
|
4763
4759
|
*
|
|
4764
|
-
* ```ts
|
|
4760
|
+
* ```ts import.meta.vitest
|
|
4765
4761
|
* import { Schema } from "effect"
|
|
4766
4762
|
*
|
|
4767
4763
|
* // Defines a struct with a fixed `_tag` field
|
|
@@ -4774,19 +4770,20 @@ export type TaggedStruct<Tag extends SchemaAST.LiteralValue, Fields extends Stru
|
|
|
4774
4770
|
* _tag: Schema.tag("A"),
|
|
4775
4771
|
* a: Schema.String
|
|
4776
4772
|
* })
|
|
4773
|
+
* void tagged
|
|
4774
|
+
* void equivalent
|
|
4777
4775
|
* ```
|
|
4778
4776
|
*
|
|
4779
4777
|
* **Example** (Accessing the literal value of the tag)
|
|
4780
4778
|
*
|
|
4781
|
-
* ```ts
|
|
4779
|
+
* ```ts import.meta.vitest
|
|
4782
4780
|
* import { Schema } from "effect"
|
|
4783
4781
|
*
|
|
4784
4782
|
* const tagged = Schema.TaggedStruct("A", {
|
|
4785
4783
|
* a: Schema.String
|
|
4786
4784
|
* })
|
|
4787
4785
|
*
|
|
4788
|
-
* //
|
|
4789
|
-
* const literal = tagged.fields._tag.schema.literal
|
|
4786
|
+
* tagged.fields._tag.schema.literal // => "A"
|
|
4790
4787
|
* ```
|
|
4791
4788
|
*
|
|
4792
4789
|
* @category constructors
|
|
@@ -4851,7 +4848,7 @@ export type toTaggedUnion<Tag extends PropertyKey, Members extends ReadonlyArray
|
|
|
4851
4848
|
*
|
|
4852
4849
|
* **Example** (Adding tagged-union utilities to an existing union)
|
|
4853
4850
|
*
|
|
4854
|
-
* ```ts
|
|
4851
|
+
* ```ts import.meta.vitest
|
|
4855
4852
|
* import { Schema } from "effect"
|
|
4856
4853
|
*
|
|
4857
4854
|
* const A = Schema.TaggedStruct("A", { value: Schema.Number })
|
|
@@ -4864,6 +4861,7 @@ export type toTaggedUnion<Tag extends PropertyKey, Members extends ReadonlyArray
|
|
|
4864
4861
|
* A: (a) => `number: ${a.value}`,
|
|
4865
4862
|
* B: (b) => `name: ${b.name}`
|
|
4866
4863
|
* })
|
|
4864
|
+
* result // => "number: 1"
|
|
4867
4865
|
* ```
|
|
4868
4866
|
*
|
|
4869
4867
|
* @see {@link TaggedUnion} for a shorthand that builds the union from scratch
|
|
@@ -4924,7 +4922,7 @@ export interface TaggedUnion<Cases extends Record<string, Constraint>> extends B
|
|
|
4924
4922
|
*
|
|
4925
4923
|
* **Example** (Pattern matching a discriminated union)
|
|
4926
4924
|
*
|
|
4927
|
-
* ```ts
|
|
4925
|
+
* ```ts import.meta.vitest
|
|
4928
4926
|
* import { Schema } from "effect"
|
|
4929
4927
|
*
|
|
4930
4928
|
* const Shape = Schema.TaggedUnion({
|
|
@@ -4937,6 +4935,7 @@ export interface TaggedUnion<Cases extends Record<string, Constraint>> extends B
|
|
|
4937
4935
|
* Circle: (c) => Math.PI * c.radius ** 2,
|
|
4938
4936
|
* Rectangle: (r) => r.width * r.height
|
|
4939
4937
|
* })
|
|
4938
|
+
* Math.round(area * 100) / 100 // => 78.54
|
|
4940
4939
|
* ```
|
|
4941
4940
|
*
|
|
4942
4941
|
* @see {@link toTaggedUnion} to augment an existing union instead
|
|
@@ -4969,7 +4968,7 @@ export interface Opaque<Self, S extends Top, Brand> extends BottomLazyWithoutNew
|
|
|
4969
4968
|
*
|
|
4970
4969
|
* **Example** (Defining opaque structs)
|
|
4971
4970
|
*
|
|
4972
|
-
* ```ts
|
|
4971
|
+
* ```ts import.meta.vitest
|
|
4973
4972
|
* import { Schema } from "effect"
|
|
4974
4973
|
*
|
|
4975
4974
|
* class Person extends Schema.Opaque<Person>()(
|
|
@@ -4980,7 +4979,7 @@ export interface Opaque<Self, S extends Top, Brand> extends BottomLazyWithoutNew
|
|
|
4980
4979
|
*
|
|
4981
4980
|
* // Decoded value is Person, not { name: string }
|
|
4982
4981
|
* const person = Schema.decodeUnknownSync(Person)({ name: "Alice" })
|
|
4983
|
-
* //
|
|
4982
|
+
* person.name // => "Alice"
|
|
4984
4983
|
* ```
|
|
4985
4984
|
*
|
|
4986
4985
|
* @category constructors
|
|
@@ -5002,13 +5001,13 @@ export interface instanceOf<T, Iso = T> extends declare<T, Iso> {
|
|
|
5002
5001
|
*
|
|
5003
5002
|
* **Example** (Defining a schema for a built-in class)
|
|
5004
5003
|
*
|
|
5005
|
-
* ```ts
|
|
5004
|
+
* ```ts import.meta.vitest
|
|
5006
5005
|
* import { Schema } from "effect"
|
|
5007
5006
|
*
|
|
5008
5007
|
* const DateSchema = Schema.instanceOf(Date)
|
|
5009
5008
|
*
|
|
5010
5009
|
* const decoded = Schema.decodeUnknownSync(DateSchema)(new Date("2024-01-01"))
|
|
5011
|
-
* //
|
|
5010
|
+
* decoded.toISOString() // => "2024-01-01T00:00:00.000Z"
|
|
5012
5011
|
* ```
|
|
5013
5012
|
*
|
|
5014
5013
|
* @category constructors
|
|
@@ -5042,8 +5041,8 @@ export declare function link<T>(): <To extends Constraint>(encodeTo: To, transfo
|
|
|
5042
5041
|
*
|
|
5043
5042
|
* **Example** (Reporting failure at a nested path)
|
|
5044
5043
|
*
|
|
5045
|
-
* ```ts
|
|
5046
|
-
* import { Schema } from "effect"
|
|
5044
|
+
* ```ts import.meta.vitest
|
|
5045
|
+
* import { Result, Schema } from "effect"
|
|
5047
5046
|
*
|
|
5048
5047
|
* const schema = Schema.Struct({ password: Schema.String, confirmPassword: Schema.String }).check(
|
|
5049
5048
|
* Schema.makeFilter((o) =>
|
|
@@ -5053,15 +5052,16 @@ export declare function link<T>(): <To extends Constraint>(encodeTo: To, transfo
|
|
|
5053
5052
|
* )
|
|
5054
5053
|
* )
|
|
5055
5054
|
*
|
|
5056
|
-
*
|
|
5057
|
-
*
|
|
5058
|
-
* //
|
|
5055
|
+
* const result = Schema.decodeUnknownResult(schema)({ password: "123456", confirmPassword: "1234567" })
|
|
5056
|
+
* if (Result.isFailure(result) && result.failure.issue._tag === "Filter" && result.failure.issue.issue._tag === "Pointer") {
|
|
5057
|
+
* result.failure.issue.issue.path // => ["password"]
|
|
5058
|
+
* }
|
|
5059
5059
|
* ```
|
|
5060
5060
|
*
|
|
5061
5061
|
* **Example** (Reporting multiple failures at once)
|
|
5062
5062
|
*
|
|
5063
|
-
* ```ts
|
|
5064
|
-
* import { Schema } from "effect"
|
|
5063
|
+
* ```ts import.meta.vitest
|
|
5064
|
+
* import { Result, Schema } from "effect"
|
|
5065
5065
|
*
|
|
5066
5066
|
* const schema = Schema.Struct({ a: Schema.Finite, b: Schema.Finite, c: Schema.Finite }).check(
|
|
5067
5067
|
* Schema.makeFilter((o) => {
|
|
@@ -5074,11 +5074,10 @@ export declare function link<T>(): <To extends Constraint>(encodeTo: To, transfo
|
|
|
5074
5074
|
* })
|
|
5075
5075
|
* )
|
|
5076
5076
|
*
|
|
5077
|
-
*
|
|
5078
|
-
*
|
|
5079
|
-
* //
|
|
5080
|
-
*
|
|
5081
|
-
* // at ["c"])]))
|
|
5077
|
+
* const result = Schema.decodeUnknownResult(schema)({ a: 1, b: 0, c: 0 })
|
|
5078
|
+
* if (Result.isFailure(result) && result.failure.issue._tag === "Filter" && result.failure.issue.issue._tag === "Composite") {
|
|
5079
|
+
* result.failure.issue.issue.issues.map((issue) => issue._tag === "Pointer" ? issue.path : []) // => [["b"], ["c"]]
|
|
5080
|
+
* }
|
|
5082
5081
|
* ```
|
|
5083
5082
|
*
|
|
5084
5083
|
* @category constructors
|
|
@@ -5092,8 +5091,8 @@ export declare const makeFilter: <T>(filter: (input: T, ast: SchemaAST.AST, opti
|
|
|
5092
5091
|
* **Details**
|
|
5093
5092
|
*
|
|
5094
5093
|
* - `string`: failure with that string as the message. Produces an
|
|
5095
|
-
* {@link SchemaIssue.InvalidValue}
|
|
5096
|
-
*
|
|
5094
|
+
* {@link SchemaIssue.InvalidValue} with the string used as the issue's
|
|
5095
|
+
* `message` annotation.
|
|
5097
5096
|
* - {@link SchemaIssue.Issue}: a fully-formed issue, returned as-is.
|
|
5098
5097
|
* - `{ path, issue }`: failure attached to a nested path. `issue` is either
|
|
5099
5098
|
* a `string` (wrapped in an {@link SchemaIssue.InvalidValue}) or a full
|
|
@@ -5118,8 +5117,8 @@ export type FilterIssue = string | SchemaIssue.Issue | {
|
|
|
5118
5117
|
* - `undefined`: success. The input satisfies the filter.
|
|
5119
5118
|
* - `true`: success. Equivalent to `undefined`, useful when the predicate is
|
|
5120
5119
|
* a plain boolean expression.
|
|
5121
|
-
* - `false`: generic failure. Produces an {@link SchemaIssue.InvalidValue}
|
|
5122
|
-
*
|
|
5120
|
+
* - `false`: generic failure. Produces an {@link SchemaIssue.InvalidValue}
|
|
5121
|
+
* with no custom message.
|
|
5123
5122
|
* - {@link FilterIssue}: a single failure. See {@link FilterIssue} for the
|
|
5124
5123
|
* shapes (`string`, {@link SchemaIssue.Issue}, or `{ path, issue }`).
|
|
5125
5124
|
* - `ReadonlyArray<FilterIssue>`: several failures reported together. An
|
|
@@ -5154,7 +5153,7 @@ export declare function makeFilterGroup<T>(checks: readonly [SchemaAST.Check<T>,
|
|
|
5154
5153
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5155
5154
|
* constraint to ensure generated strings match the trimmed pattern.
|
|
5156
5155
|
*
|
|
5157
|
-
* @category
|
|
5156
|
+
* @category validation
|
|
5158
5157
|
* @since 4.0.0
|
|
5159
5158
|
*/
|
|
5160
5159
|
export declare function isTrimmed(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5167,7 +5166,7 @@ export declare function isTrimmed(annotations?: Annotations.Filter): SchemaAST.F
|
|
|
5167
5166
|
*
|
|
5168
5167
|
* @see {@link isTrimmed} for creating the corresponding check
|
|
5169
5168
|
*
|
|
5170
|
-
* @category
|
|
5169
|
+
* @category validation
|
|
5171
5170
|
* @since 4.0.0
|
|
5172
5171
|
*/
|
|
5173
5172
|
export declare const isTrimmedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5185,7 +5184,7 @@ export declare const isTrimmedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
|
5185
5184
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5186
5185
|
* constraint to ensure generated strings match the specified RegExp pattern.
|
|
5187
5186
|
*
|
|
5188
|
-
* @category
|
|
5187
|
+
* @category validation
|
|
5189
5188
|
* @since 4.0.0
|
|
5190
5189
|
*/
|
|
5191
5190
|
export declare function isPattern(regExp: globalThis.RegExp, annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5198,7 +5197,7 @@ export declare function isPattern(regExp: globalThis.RegExp, annotations?: Annot
|
|
|
5198
5197
|
*
|
|
5199
5198
|
* @see {@link isPattern} for creating the corresponding check
|
|
5200
5199
|
*
|
|
5201
|
-
* @category
|
|
5200
|
+
* @category validation
|
|
5202
5201
|
* @since 4.0.0
|
|
5203
5202
|
*/
|
|
5204
5203
|
export declare const isPatternReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5220,7 +5219,7 @@ export declare const isPatternReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5220
5219
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5221
5220
|
* constraint to ensure generated strings match the number string pattern.
|
|
5222
5221
|
*
|
|
5223
|
-
* @category
|
|
5222
|
+
* @category validation
|
|
5224
5223
|
* @since 4.0.0
|
|
5225
5224
|
*/
|
|
5226
5225
|
export declare function isStringFinite(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5233,7 +5232,7 @@ export declare function isStringFinite(annotations?: Annotations.Filter): Schema
|
|
|
5233
5232
|
*
|
|
5234
5233
|
* @see {@link isStringFinite} for creating the corresponding check
|
|
5235
5234
|
*
|
|
5236
|
-
* @category
|
|
5235
|
+
* @category validation
|
|
5237
5236
|
* @since 4.0.0
|
|
5238
5237
|
*/
|
|
5239
5238
|
export declare const isStringFiniteReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5251,7 +5250,7 @@ export declare const isStringFiniteReviver: SchemaRepresentation.FilterReviver<n
|
|
|
5251
5250
|
* This check corresponds to a `pattern` constraint with the same signed
|
|
5252
5251
|
* base-10 integer pattern.
|
|
5253
5252
|
*
|
|
5254
|
-
* @category
|
|
5253
|
+
* @category validation
|
|
5255
5254
|
* @since 4.0.0
|
|
5256
5255
|
*/
|
|
5257
5256
|
export declare function isStringBigInt(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5264,7 +5263,7 @@ export declare function isStringBigInt(annotations?: Annotations.Filter): Schema
|
|
|
5264
5263
|
*
|
|
5265
5264
|
* @see {@link isStringBigInt} for creating the corresponding check
|
|
5266
5265
|
*
|
|
5267
|
-
* @category
|
|
5266
|
+
* @category validation
|
|
5268
5267
|
* @since 4.0.0
|
|
5269
5268
|
*/
|
|
5270
5269
|
export declare const isStringBigIntReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5277,7 +5276,7 @@ export declare const isStringBigIntReviver: SchemaRepresentation.FilterReviver<n
|
|
|
5277
5276
|
* The check uses the pattern `^Symbol\((.*)\)$`. It is not a general test for
|
|
5278
5277
|
* whether a string can be passed to JavaScript's `Symbol()` function.
|
|
5279
5278
|
*
|
|
5280
|
-
* @category
|
|
5279
|
+
* @category validation
|
|
5281
5280
|
* @since 4.0.0
|
|
5282
5281
|
*/
|
|
5283
5282
|
export declare function isStringSymbol(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5290,7 +5289,7 @@ export declare function isStringSymbol(annotations?: Annotations.Filter): Schema
|
|
|
5290
5289
|
*
|
|
5291
5290
|
* @see {@link isStringSymbol} for creating the corresponding check
|
|
5292
5291
|
*
|
|
5293
|
-
* @category
|
|
5292
|
+
* @category validation
|
|
5294
5293
|
* @since 4.0.0
|
|
5295
5294
|
*/
|
|
5296
5295
|
export declare const isStringSymbolReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5321,7 +5320,7 @@ export declare const isStringSymbolReviver: SchemaRepresentation.FilterReviver<n
|
|
|
5321
5320
|
* constraint to ensure generated strings match the UUID pattern.
|
|
5322
5321
|
*
|
|
5323
5322
|
* @see {@link isGUID} for shape-only GUID validation.
|
|
5324
|
-
* @category
|
|
5323
|
+
* @category validation
|
|
5325
5324
|
* @since 4.0.0
|
|
5326
5325
|
*/
|
|
5327
5326
|
export declare function isUUID(version?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8, annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5334,7 +5333,7 @@ export declare function isUUID(version?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8, annotati
|
|
|
5334
5333
|
*
|
|
5335
5334
|
* @see {@link isUUID} for creating the corresponding check
|
|
5336
5335
|
*
|
|
5337
|
-
* @category
|
|
5336
|
+
* @category validation
|
|
5338
5337
|
* @since 4.0.0
|
|
5339
5338
|
*/
|
|
5340
5339
|
export declare const isUUIDReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5361,7 +5360,7 @@ export declare const isUUIDReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5361
5360
|
* constraint to ensure generated strings match the GUID pattern.
|
|
5362
5361
|
*
|
|
5363
5362
|
* @see {@link isUUID} for strict UUID validation.
|
|
5364
|
-
* @category
|
|
5363
|
+
* @category validation
|
|
5365
5364
|
* @since 4.0.0
|
|
5366
5365
|
*/
|
|
5367
5366
|
export declare function isGUID(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5374,7 +5373,7 @@ export declare function isGUID(annotations?: Annotations.Filter): SchemaAST.Filt
|
|
|
5374
5373
|
*
|
|
5375
5374
|
* @see {@link isGUID} for creating the corresponding check
|
|
5376
5375
|
*
|
|
5377
|
-
* @category
|
|
5376
|
+
* @category validation
|
|
5378
5377
|
* @since 4.0.0
|
|
5379
5378
|
*/
|
|
5380
5379
|
export declare const isGUIDReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5394,7 +5393,7 @@ export declare const isGUIDReviver: SchemaRepresentation.FilterReviver<null>;
|
|
|
5394
5393
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5395
5394
|
* constraint to ensure generated strings match the ULID pattern.
|
|
5396
5395
|
*
|
|
5397
|
-
* @category
|
|
5396
|
+
* @category validation
|
|
5398
5397
|
* @since 4.0.0
|
|
5399
5398
|
*/
|
|
5400
5399
|
export declare function isULID(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5407,7 +5406,7 @@ export declare function isULID(annotations?: Annotations.Filter): SchemaAST.Filt
|
|
|
5407
5406
|
*
|
|
5408
5407
|
* @see {@link isULID} for creating the corresponding check
|
|
5409
5408
|
*
|
|
5410
|
-
* @category
|
|
5409
|
+
* @category validation
|
|
5411
5410
|
* @since 4.0.0
|
|
5412
5411
|
*/
|
|
5413
5412
|
export declare const isULIDReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5426,7 +5425,7 @@ export declare const isULIDReviver: SchemaRepresentation.FilterReviver<null>;
|
|
|
5426
5425
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5427
5426
|
* constraint to ensure generated strings match the Base64 pattern.
|
|
5428
5427
|
*
|
|
5429
|
-
* @category
|
|
5428
|
+
* @category validation
|
|
5430
5429
|
* @since 4.0.0
|
|
5431
5430
|
*/
|
|
5432
5431
|
export declare function isBase64(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5439,7 +5438,7 @@ export declare function isBase64(annotations?: Annotations.Filter): SchemaAST.Fi
|
|
|
5439
5438
|
*
|
|
5440
5439
|
* @see {@link isBase64} for creating the corresponding check
|
|
5441
5440
|
*
|
|
5442
|
-
* @category
|
|
5441
|
+
* @category validation
|
|
5443
5442
|
* @since 4.0.0
|
|
5444
5443
|
*/
|
|
5445
5444
|
export declare const isBase64Reviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5459,7 +5458,7 @@ export declare const isBase64Reviver: SchemaRepresentation.FilterReviver<null>;
|
|
|
5459
5458
|
* When generating test data with fast-check, this applies a `patterns`
|
|
5460
5459
|
* constraint to ensure generated strings match the Base64URL pattern.
|
|
5461
5460
|
*
|
|
5462
|
-
* @category
|
|
5461
|
+
* @category validation
|
|
5463
5462
|
* @since 4.0.0
|
|
5464
5463
|
*/
|
|
5465
5464
|
export declare function isBase64Url(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5472,7 +5471,7 @@ export declare function isBase64Url(annotations?: Annotations.Filter): SchemaAST
|
|
|
5472
5471
|
*
|
|
5473
5472
|
* @see {@link isBase64Url} for creating the corresponding check
|
|
5474
5473
|
*
|
|
5475
|
-
* @category
|
|
5474
|
+
* @category validation
|
|
5476
5475
|
* @since 4.0.0
|
|
5477
5476
|
*/
|
|
5478
5477
|
export declare const isBase64UrlReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5484,7 +5483,7 @@ export declare const isBase64UrlReviver: SchemaRepresentation.FilterReviver<null
|
|
|
5484
5483
|
* RegExp metacharacters in the prefix are escaped in JSON Schema and arbitrary
|
|
5485
5484
|
* metadata so that the generated patterns retain literal `startsWith` semantics.
|
|
5486
5485
|
*
|
|
5487
|
-
* @category
|
|
5486
|
+
* @category validation
|
|
5488
5487
|
* @since 4.0.0
|
|
5489
5488
|
*/
|
|
5490
5489
|
export declare function isStartsWith(startsWith: string, annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5497,7 +5496,7 @@ export declare function isStartsWith(startsWith: string, annotations?: Annotatio
|
|
|
5497
5496
|
*
|
|
5498
5497
|
* @see {@link isStartsWith} for creating the corresponding check
|
|
5499
5498
|
*
|
|
5500
|
-
* @category
|
|
5499
|
+
* @category validation
|
|
5501
5500
|
* @since 4.0.0
|
|
5502
5501
|
*/
|
|
5503
5502
|
export declare const isStartsWithReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5511,7 +5510,7 @@ export declare const isStartsWithReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5511
5510
|
* RegExp metacharacters in the suffix are escaped in JSON Schema and arbitrary
|
|
5512
5511
|
* metadata so that the generated patterns retain literal `endsWith` semantics.
|
|
5513
5512
|
*
|
|
5514
|
-
* @category
|
|
5513
|
+
* @category validation
|
|
5515
5514
|
* @since 4.0.0
|
|
5516
5515
|
*/
|
|
5517
5516
|
export declare function isEndsWith(endsWith: string, annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5524,7 +5523,7 @@ export declare function isEndsWith(endsWith: string, annotations?: Annotations.F
|
|
|
5524
5523
|
*
|
|
5525
5524
|
* @see {@link isEndsWith} for creating the corresponding check
|
|
5526
5525
|
*
|
|
5527
|
-
* @category
|
|
5526
|
+
* @category validation
|
|
5528
5527
|
* @since 4.0.0
|
|
5529
5528
|
*/
|
|
5530
5529
|
export declare const isEndsWithReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5539,7 +5538,7 @@ export declare const isEndsWithReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5539
5538
|
* arbitrary metadata so that the generated patterns retain literal `includes`
|
|
5540
5539
|
* semantics.
|
|
5541
5540
|
*
|
|
5542
|
-
* @category
|
|
5541
|
+
* @category validation
|
|
5543
5542
|
* @since 4.0.0
|
|
5544
5543
|
*/
|
|
5545
5544
|
export declare function isIncludes(includes: string, annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5552,7 +5551,7 @@ export declare function isIncludes(includes: string, annotations?: Annotations.F
|
|
|
5552
5551
|
*
|
|
5553
5552
|
* @see {@link isIncludes} for creating the corresponding check
|
|
5554
5553
|
*
|
|
5555
|
-
* @category
|
|
5554
|
+
* @category validation
|
|
5556
5555
|
* @since 4.0.0
|
|
5557
5556
|
*/
|
|
5558
5557
|
export declare const isIncludesReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5567,7 +5566,7 @@ export declare const isIncludesReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5567
5566
|
* such as digits, punctuation, and whitespace. It rejects strings that would
|
|
5568
5567
|
* change when uppercased.
|
|
5569
5568
|
*
|
|
5570
|
-
* @category
|
|
5569
|
+
* @category validation
|
|
5571
5570
|
* @since 4.0.0
|
|
5572
5571
|
*/
|
|
5573
5572
|
export declare function isUppercased(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5580,7 +5579,7 @@ export declare function isUppercased(annotations?: Annotations.Filter): SchemaAS
|
|
|
5580
5579
|
*
|
|
5581
5580
|
* @see {@link isUppercased} for creating the corresponding check
|
|
5582
5581
|
*
|
|
5583
|
-
* @category
|
|
5582
|
+
* @category validation
|
|
5584
5583
|
* @since 4.0.0
|
|
5585
5584
|
*/
|
|
5586
5585
|
export declare const isUppercasedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5593,7 +5592,7 @@ export declare const isUppercasedReviver: SchemaRepresentation.FilterReviver<nul
|
|
|
5593
5592
|
* such as digits, punctuation, and whitespace. It rejects strings that would
|
|
5594
5593
|
* change when lowercased.
|
|
5595
5594
|
*
|
|
5596
|
-
* @category
|
|
5595
|
+
* @category validation
|
|
5597
5596
|
* @since 4.0.0
|
|
5598
5597
|
*/
|
|
5599
5598
|
export declare function isLowercased(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5606,7 +5605,7 @@ export declare function isLowercased(annotations?: Annotations.Filter): SchemaAS
|
|
|
5606
5605
|
*
|
|
5607
5606
|
* @see {@link isLowercased} for creating the corresponding check
|
|
5608
5607
|
*
|
|
5609
|
-
* @category
|
|
5608
|
+
* @category validation
|
|
5610
5609
|
* @since 4.0.0
|
|
5611
5610
|
*/
|
|
5612
5611
|
export declare const isLowercasedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5619,7 +5618,7 @@ export declare const isLowercasedReviver: SchemaRepresentation.FilterReviver<nul
|
|
|
5619
5618
|
* Empty strings pass. Strings whose first character has no lowercase form, such
|
|
5620
5619
|
* as a digit, punctuation mark, or whitespace, also pass.
|
|
5621
5620
|
*
|
|
5622
|
-
* @category
|
|
5621
|
+
* @category validation
|
|
5623
5622
|
* @since 4.0.0
|
|
5624
5623
|
*/
|
|
5625
5624
|
export declare function isCapitalized(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5632,7 +5631,7 @@ export declare function isCapitalized(annotations?: Annotations.Filter): SchemaA
|
|
|
5632
5631
|
*
|
|
5633
5632
|
* @see {@link isCapitalized} for creating the corresponding check
|
|
5634
5633
|
*
|
|
5635
|
-
* @category
|
|
5634
|
+
* @category validation
|
|
5636
5635
|
* @since 4.0.0
|
|
5637
5636
|
*/
|
|
5638
5637
|
export declare const isCapitalizedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5645,7 +5644,7 @@ export declare const isCapitalizedReviver: SchemaRepresentation.FilterReviver<nu
|
|
|
5645
5644
|
* Empty strings pass. Strings whose first character has no uppercase form, such
|
|
5646
5645
|
* as a digit, punctuation mark, or whitespace, also pass.
|
|
5647
5646
|
*
|
|
5648
|
-
* @category
|
|
5647
|
+
* @category validation
|
|
5649
5648
|
* @since 4.0.0
|
|
5650
5649
|
*/
|
|
5651
5650
|
export declare function isUncapitalized(annotations?: Annotations.Filter): SchemaAST.Filter<string>;
|
|
@@ -5658,14 +5657,14 @@ export declare function isUncapitalized(annotations?: Annotations.Filter): Schem
|
|
|
5658
5657
|
*
|
|
5659
5658
|
* @see {@link isUncapitalized} for creating the corresponding check
|
|
5660
5659
|
*
|
|
5661
|
-
* @category
|
|
5660
|
+
* @category validation
|
|
5662
5661
|
* @since 4.0.0
|
|
5663
5662
|
*/
|
|
5664
5663
|
export declare const isUncapitalizedReviver: SchemaRepresentation.FilterReviver<null>;
|
|
5665
5664
|
/**
|
|
5666
5665
|
* Type-level representation of {@link Finite}.
|
|
5667
5666
|
*
|
|
5668
|
-
* @category
|
|
5667
|
+
* @category models
|
|
5669
5668
|
* @since 3.10.0
|
|
5670
5669
|
*/
|
|
5671
5670
|
export interface Finite extends Number {
|
|
@@ -5674,7 +5673,7 @@ export interface Finite extends Number {
|
|
|
5674
5673
|
/**
|
|
5675
5674
|
* Schema for finite numbers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
5676
5675
|
*
|
|
5677
|
-
* @category
|
|
5676
|
+
* @category schemas
|
|
5678
5677
|
* @since 3.10.0
|
|
5679
5678
|
*/
|
|
5680
5679
|
export declare const Finite: Finite;
|
|
@@ -5693,7 +5692,7 @@ export declare const Finite: Finite;
|
|
|
5693
5692
|
* When generating test data with fast-check, this applies `noNaN: true` and
|
|
5694
5693
|
* `noInfinity: true` constraints to ensure generated numbers are finite.
|
|
5695
5694
|
*
|
|
5696
|
-
* @category
|
|
5695
|
+
* @category validation
|
|
5697
5696
|
* @since 4.0.0
|
|
5698
5697
|
*/
|
|
5699
5698
|
export declare const isFinite: (annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -5706,7 +5705,7 @@ export declare const isFinite: (annotations?: Annotations.Filter) => SchemaAST.F
|
|
|
5706
5705
|
*
|
|
5707
5706
|
* @see {@link isFinite} for creating the corresponding check
|
|
5708
5707
|
*
|
|
5709
|
-
* @category
|
|
5708
|
+
* @category validation
|
|
5710
5709
|
* @since 4.0.0
|
|
5711
5710
|
*/
|
|
5712
5711
|
export declare const isFiniteReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -5714,7 +5713,7 @@ export declare const isFiniteReviver: SchemaRepresentation.FilterReviver<null>;
|
|
|
5714
5713
|
* Creates a greater-than (`>`) check for any ordered type from an
|
|
5715
5714
|
* `Order.Order` instance.
|
|
5716
5715
|
*
|
|
5717
|
-
* @category
|
|
5716
|
+
* @category validation
|
|
5718
5717
|
* @since 4.0.0
|
|
5719
5718
|
*/
|
|
5720
5719
|
export declare function makeIsGreaterThan<T>(options: {
|
|
@@ -5726,7 +5725,7 @@ export declare function makeIsGreaterThan<T>(options: {
|
|
|
5726
5725
|
* Creates a greater-than-or-equal-to (`>=`) check for any ordered type from an
|
|
5727
5726
|
* `Order.Order` instance.
|
|
5728
5727
|
*
|
|
5729
|
-
* @category
|
|
5728
|
+
* @category validation
|
|
5730
5729
|
* @since 4.0.0
|
|
5731
5730
|
*/
|
|
5732
5731
|
export declare function makeIsGreaterThanOrEqualTo<T>(options: {
|
|
@@ -5738,7 +5737,7 @@ export declare function makeIsGreaterThanOrEqualTo<T>(options: {
|
|
|
5738
5737
|
* Creates a less-than (`<`) check for any ordered type from an `Order.Order`
|
|
5739
5738
|
* instance.
|
|
5740
5739
|
*
|
|
5741
|
-
* @category
|
|
5740
|
+
* @category validation
|
|
5742
5741
|
* @since 4.0.0
|
|
5743
5742
|
*/
|
|
5744
5743
|
export declare function makeIsLessThan<T>(options: {
|
|
@@ -5750,7 +5749,7 @@ export declare function makeIsLessThan<T>(options: {
|
|
|
5750
5749
|
* Creates a less-than-or-equal-to (`<=`) check for any ordered type from an
|
|
5751
5750
|
* `Order.Order` instance.
|
|
5752
5751
|
*
|
|
5753
|
-
* @category
|
|
5752
|
+
* @category validation
|
|
5754
5753
|
* @since 4.0.0
|
|
5755
5754
|
*/
|
|
5756
5755
|
export declare function makeIsLessThanOrEqualTo<T>(options: {
|
|
@@ -5762,7 +5761,7 @@ export declare function makeIsLessThanOrEqualTo<T>(options: {
|
|
|
5762
5761
|
* Creates an inclusive or exclusive range check for any ordered type from an
|
|
5763
5762
|
* `Order.Order` instance.
|
|
5764
5763
|
*
|
|
5765
|
-
* @category
|
|
5764
|
+
* @category validation
|
|
5766
5765
|
* @since 4.0.0
|
|
5767
5766
|
*/
|
|
5768
5767
|
export declare function makeIsBetween<T>(deriveOptions: {
|
|
@@ -5784,7 +5783,7 @@ export declare function makeIsBetween<T>(deriveOptions: {
|
|
|
5784
5783
|
* Creates a divisibility check for any numeric type from a remainder function
|
|
5785
5784
|
* and a zero value.
|
|
5786
5785
|
*
|
|
5787
|
-
* @category
|
|
5786
|
+
* @category validation
|
|
5788
5787
|
* @since 4.0.0
|
|
5789
5788
|
*/
|
|
5790
5789
|
export declare function makeIsMultipleOf<T>(options: {
|
|
@@ -5808,7 +5807,7 @@ export declare function makeIsMultipleOf<T>(options: {
|
|
|
5808
5807
|
* `exclusiveMinimum` constraint to ensure generated numbers are greater than
|
|
5809
5808
|
* the specified value.
|
|
5810
5809
|
*
|
|
5811
|
-
* @category
|
|
5810
|
+
* @category validation
|
|
5812
5811
|
* @since 4.0.0
|
|
5813
5812
|
*/
|
|
5814
5813
|
export declare const isGreaterThan: (exclusiveMinimum: number, annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -5821,7 +5820,7 @@ export declare const isGreaterThan: (exclusiveMinimum: number, annotations?: Ann
|
|
|
5821
5820
|
*
|
|
5822
5821
|
* @see {@link isGreaterThan} for creating the corresponding check
|
|
5823
5822
|
*
|
|
5824
|
-
* @category
|
|
5823
|
+
* @category validation
|
|
5825
5824
|
* @since 4.0.0
|
|
5826
5825
|
*/
|
|
5827
5826
|
export declare const isGreaterThanReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5842,7 +5841,7 @@ export declare const isGreaterThanReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5842
5841
|
* When generating test data with fast-check, this applies a `minimum` constraint
|
|
5843
5842
|
* to ensure generated numbers are greater than or equal to the specified value.
|
|
5844
5843
|
*
|
|
5845
|
-
* @category
|
|
5844
|
+
* @category validation
|
|
5846
5845
|
* @since 4.0.0
|
|
5847
5846
|
*/
|
|
5848
5847
|
export declare const isGreaterThanOrEqualTo: (minimum: number, annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -5855,7 +5854,7 @@ export declare const isGreaterThanOrEqualTo: (minimum: number, annotations?: Ann
|
|
|
5855
5854
|
*
|
|
5856
5855
|
* @see {@link isGreaterThanOrEqualTo} for creating the corresponding check
|
|
5857
5856
|
*
|
|
5858
|
-
* @category
|
|
5857
|
+
* @category validation
|
|
5859
5858
|
* @since 4.0.0
|
|
5860
5859
|
*/
|
|
5861
5860
|
export declare const isGreaterThanOrEqualToReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5876,7 +5875,7 @@ export declare const isGreaterThanOrEqualToReviver: SchemaRepresentation.FilterR
|
|
|
5876
5875
|
* `exclusiveMaximum` constraint to ensure generated numbers are less than the
|
|
5877
5876
|
* specified value.
|
|
5878
5877
|
*
|
|
5879
|
-
* @category
|
|
5878
|
+
* @category validation
|
|
5880
5879
|
* @since 4.0.0
|
|
5881
5880
|
*/
|
|
5882
5881
|
export declare const isLessThan: (exclusiveMaximum: number, annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -5889,7 +5888,7 @@ export declare const isLessThan: (exclusiveMaximum: number, annotations?: Annota
|
|
|
5889
5888
|
*
|
|
5890
5889
|
* @see {@link isLessThan} for creating the corresponding check
|
|
5891
5890
|
*
|
|
5892
|
-
* @category
|
|
5891
|
+
* @category validation
|
|
5893
5892
|
* @since 4.0.0
|
|
5894
5893
|
*/
|
|
5895
5894
|
export declare const isLessThanReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5910,7 +5909,7 @@ export declare const isLessThanReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5910
5909
|
* When generating test data with fast-check, this applies a `maximum` constraint
|
|
5911
5910
|
* to ensure generated numbers are less than or equal to the specified value.
|
|
5912
5911
|
*
|
|
5913
|
-
* @category
|
|
5912
|
+
* @category validation
|
|
5914
5913
|
* @since 4.0.0
|
|
5915
5914
|
*/
|
|
5916
5915
|
export declare const isLessThanOrEqualTo: (maximum: number, annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -5923,7 +5922,7 @@ export declare const isLessThanOrEqualTo: (maximum: number, annotations?: Annota
|
|
|
5923
5922
|
*
|
|
5924
5923
|
* @see {@link isLessThanOrEqualTo} for creating the corresponding check
|
|
5925
5924
|
*
|
|
5926
|
-
* @category
|
|
5925
|
+
* @category validation
|
|
5927
5926
|
* @since 4.0.0
|
|
5928
5927
|
*/
|
|
5929
5928
|
export declare const isLessThanOrEqualToReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5947,7 +5946,7 @@ export declare const isLessThanOrEqualToReviver: SchemaRepresentation.FilterRevi
|
|
|
5947
5946
|
* `exclusiveMaximum` flags to ensure generated numbers fall within the
|
|
5948
5947
|
* specified range.
|
|
5949
5948
|
*
|
|
5950
|
-
* @category
|
|
5949
|
+
* @category validation
|
|
5951
5950
|
* @since 4.0.0
|
|
5952
5951
|
*/
|
|
5953
5952
|
export declare const isBetween: (options: {
|
|
@@ -5965,7 +5964,7 @@ export declare const isBetween: (options: {
|
|
|
5965
5964
|
*
|
|
5966
5965
|
* @see {@link isBetween} for creating the corresponding check
|
|
5967
5966
|
*
|
|
5968
|
-
* @category
|
|
5967
|
+
* @category validation
|
|
5969
5968
|
* @since 4.0.0
|
|
5970
5969
|
*/
|
|
5971
5970
|
export declare const isBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -5988,7 +5987,7 @@ export declare const isBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
|
5988
5987
|
* When generating test data with fast-check, this applies constraints to ensure
|
|
5989
5988
|
* generated numbers are multiples of the specified divisor.
|
|
5990
5989
|
*
|
|
5991
|
-
* @category
|
|
5990
|
+
* @category validation
|
|
5992
5991
|
* @since 4.0.0
|
|
5993
5992
|
*/
|
|
5994
5993
|
export declare const isMultipleOf: (divisor: number, annotations?: Annotations.Filter) => SchemaAST.Filter<number>;
|
|
@@ -6001,7 +6000,7 @@ export declare const isMultipleOf: (divisor: number, annotations?: Annotations.F
|
|
|
6001
6000
|
*
|
|
6002
6001
|
* @see {@link isMultipleOf} for creating the corresponding check
|
|
6003
6002
|
*
|
|
6004
|
-
* @category
|
|
6003
|
+
* @category validation
|
|
6005
6004
|
* @since 4.0.0
|
|
6006
6005
|
*/
|
|
6007
6006
|
export declare const isMultipleOfReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6022,7 +6021,7 @@ export declare const isMultipleOfReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6022
6021
|
* When generating test data with fast-check, this applies an `integer: true`
|
|
6023
6022
|
* constraint to ensure generated numbers are integers.
|
|
6024
6023
|
*
|
|
6025
|
-
* @category
|
|
6024
|
+
* @category validation
|
|
6026
6025
|
* @since 4.0.0
|
|
6027
6026
|
*/
|
|
6028
6027
|
export declare function isInt(annotations?: Annotations.Filter): SchemaAST.Filter<number>;
|
|
@@ -6035,14 +6034,14 @@ export declare function isInt(annotations?: Annotations.Filter): SchemaAST.Filte
|
|
|
6035
6034
|
*
|
|
6036
6035
|
* @see {@link isInt} for creating the corresponding check
|
|
6037
6036
|
*
|
|
6038
|
-
* @category
|
|
6037
|
+
* @category validation
|
|
6039
6038
|
* @since 4.0.0
|
|
6040
6039
|
*/
|
|
6041
6040
|
export declare const isIntReviver: SchemaRepresentation.FilterReviver<null>;
|
|
6042
6041
|
/**
|
|
6043
6042
|
* Type-level representation of {@link Int}.
|
|
6044
6043
|
*
|
|
6045
|
-
* @category
|
|
6044
|
+
* @category models
|
|
6046
6045
|
* @since 3.10.0
|
|
6047
6046
|
*/
|
|
6048
6047
|
export interface Int extends Number {
|
|
@@ -6051,14 +6050,14 @@ export interface Int extends Number {
|
|
|
6051
6050
|
/**
|
|
6052
6051
|
* Schema for integers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
6053
6052
|
*
|
|
6054
|
-
* @category
|
|
6053
|
+
* @category schemas
|
|
6055
6054
|
* @since 3.10.0
|
|
6056
6055
|
*/
|
|
6057
6056
|
export declare const Int: Int;
|
|
6058
6057
|
/**
|
|
6059
6058
|
* Type-level representation of {@link Natural}.
|
|
6060
6059
|
*
|
|
6061
|
-
* @category
|
|
6060
|
+
* @category models
|
|
6062
6061
|
* @since 4.0.0
|
|
6063
6062
|
*/
|
|
6064
6063
|
export interface Natural extends Int {
|
|
@@ -6073,7 +6072,7 @@ export interface Natural extends Int {
|
|
|
6073
6072
|
*
|
|
6074
6073
|
* @see {@link Int} for safe integers that may be negative
|
|
6075
6074
|
*
|
|
6076
|
-
* @category
|
|
6075
|
+
* @category schemas
|
|
6077
6076
|
* @since 4.0.0
|
|
6078
6077
|
*/
|
|
6079
6078
|
export declare const Natural: Natural;
|
|
@@ -6093,7 +6092,7 @@ export declare const Natural: Natural;
|
|
|
6093
6092
|
* When generating test data with fast-check, this applies integer and range
|
|
6094
6093
|
* constraints to ensure generated numbers are 32-bit signed integers.
|
|
6095
6094
|
*
|
|
6096
|
-
* @category
|
|
6095
|
+
* @category validation
|
|
6097
6096
|
* @since 4.0.0
|
|
6098
6097
|
*/
|
|
6099
6098
|
export declare function isInt32(annotations?: Annotations.Filter): SchemaAST.FilterGroup<number>;
|
|
@@ -6113,7 +6112,7 @@ export declare function isInt32(annotations?: Annotations.Filter): SchemaAST.Fil
|
|
|
6113
6112
|
* When generating test data with fast-check, this applies integer and range
|
|
6114
6113
|
* constraints to ensure generated numbers are 32-bit unsigned integers.
|
|
6115
6114
|
*
|
|
6116
|
-
* @category
|
|
6115
|
+
* @category validation
|
|
6117
6116
|
* @since 4.0.0
|
|
6118
6117
|
*/
|
|
6119
6118
|
export declare function isUint32(annotations?: Annotations.Filter): SchemaAST.FilterGroup<number>;
|
|
@@ -6128,7 +6127,7 @@ export declare function isUint32(annotations?: Annotations.Filter): SchemaAST.Fi
|
|
|
6128
6127
|
* one millisecond after the specified value to ensure generated Date objects are
|
|
6129
6128
|
* greater than it.
|
|
6130
6129
|
*
|
|
6131
|
-
* @category
|
|
6130
|
+
* @category validation
|
|
6132
6131
|
* @since 4.0.0
|
|
6133
6132
|
*/
|
|
6134
6133
|
export declare const isGreaterThanDate: (exclusiveMinimum: globalThis.Date, annotations?: Annotations.Filter) => SchemaAST.Filter<globalThis.Date>;
|
|
@@ -6149,7 +6148,7 @@ export declare const isGreaterThanDate: (exclusiveMinimum: globalThis.Date, anno
|
|
|
6149
6148
|
* to ensure generated Date objects are greater than or equal to the specified
|
|
6150
6149
|
* date.
|
|
6151
6150
|
*
|
|
6152
|
-
* @category
|
|
6151
|
+
* @category validation
|
|
6153
6152
|
* @since 4.0.0
|
|
6154
6153
|
*/
|
|
6155
6154
|
export declare const isGreaterThanOrEqualToDate: (minimum: globalThis.Date, annotations?: Annotations.Filter) => SchemaAST.Filter<globalThis.Date>;
|
|
@@ -6164,7 +6163,7 @@ export declare const isGreaterThanOrEqualToDate: (minimum: globalThis.Date, anno
|
|
|
6164
6163
|
* one millisecond before the specified value to ensure generated Date objects
|
|
6165
6164
|
* are less than it.
|
|
6166
6165
|
*
|
|
6167
|
-
* @category
|
|
6166
|
+
* @category validation
|
|
6168
6167
|
* @since 4.0.0
|
|
6169
6168
|
*/
|
|
6170
6169
|
export declare const isLessThanDate: (exclusiveMaximum: globalThis.Date, annotations?: Annotations.Filter) => SchemaAST.Filter<globalThis.Date>;
|
|
@@ -6185,7 +6184,7 @@ export declare const isLessThanDate: (exclusiveMaximum: globalThis.Date, annotat
|
|
|
6185
6184
|
* to ensure generated Date objects are less than or equal to the specified
|
|
6186
6185
|
* date.
|
|
6187
6186
|
*
|
|
6188
|
-
* @category
|
|
6187
|
+
* @category validation
|
|
6189
6188
|
* @since 4.0.0
|
|
6190
6189
|
*/
|
|
6191
6190
|
export declare const isLessThanOrEqualToDate: (maximum: globalThis.Date, annotations?: Annotations.Filter) => SchemaAST.Filter<globalThis.Date>;
|
|
@@ -6206,7 +6205,7 @@ export declare const isLessThanOrEqualToDate: (maximum: globalThis.Date, annotat
|
|
|
6206
6205
|
* constraints to ensure generated Date objects fall within the specified range,
|
|
6207
6206
|
* shifting exclusive bounds by one millisecond.
|
|
6208
6207
|
*
|
|
6209
|
-
* @category
|
|
6208
|
+
* @category validation
|
|
6210
6209
|
* @since 4.0.0
|
|
6211
6210
|
*/
|
|
6212
6211
|
export declare const isBetweenDate: (options: {
|
|
@@ -6226,7 +6225,7 @@ export declare const isBetweenDate: (options: {
|
|
|
6226
6225
|
* `exclusiveMinimum + 1n` to ensure generated BigInts are greater than the
|
|
6227
6226
|
* specified value.
|
|
6228
6227
|
*
|
|
6229
|
-
* @category
|
|
6228
|
+
* @category validation
|
|
6230
6229
|
* @since 4.0.0
|
|
6231
6230
|
*/
|
|
6232
6231
|
export declare const isGreaterThanBigInt: (exclusiveMinimum: bigint, annotations?: Annotations.Filter) => SchemaAST.Filter<bigint>;
|
|
@@ -6242,7 +6241,7 @@ export declare const isGreaterThanBigInt: (exclusiveMinimum: bigint, annotations
|
|
|
6242
6241
|
* to ensure generated BigInt values are greater than or equal to the specified
|
|
6243
6242
|
* value.
|
|
6244
6243
|
*
|
|
6245
|
-
* @category
|
|
6244
|
+
* @category validation
|
|
6246
6245
|
* @since 4.0.0
|
|
6247
6246
|
*/
|
|
6248
6247
|
export declare const isGreaterThanOrEqualToBigInt: (minimum: bigint, annotations?: Annotations.Filter) => SchemaAST.Filter<bigint>;
|
|
@@ -6257,7 +6256,7 @@ export declare const isGreaterThanOrEqualToBigInt: (minimum: bigint, annotations
|
|
|
6257
6256
|
* `exclusiveMaximum - 1n` to ensure generated BigInts are less than the
|
|
6258
6257
|
* specified value.
|
|
6259
6258
|
*
|
|
6260
|
-
* @category
|
|
6259
|
+
* @category validation
|
|
6261
6260
|
* @since 4.0.0
|
|
6262
6261
|
*/
|
|
6263
6262
|
export declare const isLessThanBigInt: (exclusiveMaximum: bigint, annotations?: Annotations.Filter) => SchemaAST.Filter<bigint>;
|
|
@@ -6273,7 +6272,7 @@ export declare const isLessThanBigInt: (exclusiveMaximum: bigint, annotations?:
|
|
|
6273
6272
|
* to ensure generated BigInt values are less than or equal to the specified
|
|
6274
6273
|
* value.
|
|
6275
6274
|
*
|
|
6276
|
-
* @category
|
|
6275
|
+
* @category validation
|
|
6277
6276
|
* @since 4.0.0
|
|
6278
6277
|
*/
|
|
6279
6278
|
export declare const isLessThanOrEqualToBigInt: (maximum: bigint, annotations?: Annotations.Filter) => SchemaAST.Filter<bigint>;
|
|
@@ -6289,7 +6288,7 @@ export declare const isLessThanOrEqualToBigInt: (maximum: bigint, annotations?:
|
|
|
6289
6288
|
* constraints to ensure generated BigInt values fall within the specified
|
|
6290
6289
|
* range.
|
|
6291
6290
|
*
|
|
6292
|
-
* @category
|
|
6291
|
+
* @category validation
|
|
6293
6292
|
* @since 4.0.0
|
|
6294
6293
|
*/
|
|
6295
6294
|
export declare const isBetweenBigInt: (options: {
|
|
@@ -6301,7 +6300,7 @@ export declare const isBetweenBigInt: (options: {
|
|
|
6301
6300
|
/**
|
|
6302
6301
|
* Validates that a BigDecimal is greater than the specified value (exclusive).
|
|
6303
6302
|
*
|
|
6304
|
-
* @category
|
|
6303
|
+
* @category validation
|
|
6305
6304
|
* @since 4.0.0
|
|
6306
6305
|
*/
|
|
6307
6306
|
export declare const isGreaterThanBigDecimal: (exclusiveMinimum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => SchemaAST.Filter<BigDecimal_.BigDecimal>;
|
|
@@ -6309,14 +6308,14 @@ export declare const isGreaterThanBigDecimal: (exclusiveMinimum: BigDecimal_.Big
|
|
|
6309
6308
|
* Validates that a BigDecimal is greater than or equal to the specified value
|
|
6310
6309
|
* (inclusive).
|
|
6311
6310
|
*
|
|
6312
|
-
* @category
|
|
6311
|
+
* @category validation
|
|
6313
6312
|
* @since 4.0.0
|
|
6314
6313
|
*/
|
|
6315
6314
|
export declare const isGreaterThanOrEqualToBigDecimal: (minimum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => SchemaAST.Filter<BigDecimal_.BigDecimal>;
|
|
6316
6315
|
/**
|
|
6317
6316
|
* Validates that a BigDecimal is less than the specified value (exclusive).
|
|
6318
6317
|
*
|
|
6319
|
-
* @category
|
|
6318
|
+
* @category validation
|
|
6320
6319
|
* @since 4.0.0
|
|
6321
6320
|
*/
|
|
6322
6321
|
export declare const isLessThanBigDecimal: (exclusiveMaximum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => SchemaAST.Filter<BigDecimal_.BigDecimal>;
|
|
@@ -6324,7 +6323,7 @@ export declare const isLessThanBigDecimal: (exclusiveMaximum: BigDecimal_.BigDec
|
|
|
6324
6323
|
* Validates that a BigDecimal is less than or equal to the specified value
|
|
6325
6324
|
* (inclusive).
|
|
6326
6325
|
*
|
|
6327
|
-
* @category
|
|
6326
|
+
* @category validation
|
|
6328
6327
|
* @since 4.0.0
|
|
6329
6328
|
*/
|
|
6330
6329
|
export declare const isLessThanOrEqualToBigDecimal: (maximum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => SchemaAST.Filter<BigDecimal_.BigDecimal>;
|
|
@@ -6336,7 +6335,7 @@ export declare const isLessThanOrEqualToBigDecimal: (maximum: BigDecimal_.BigDec
|
|
|
6336
6335
|
* The minimum and maximum boundaries are inclusive by default. Pass
|
|
6337
6336
|
* `exclusiveMinimum` or `exclusiveMaximum` to exclude either boundary.
|
|
6338
6337
|
*
|
|
6339
|
-
* @category
|
|
6338
|
+
* @category validation
|
|
6340
6339
|
* @since 4.0.0
|
|
6341
6340
|
*/
|
|
6342
6341
|
export declare const isBetweenBigDecimal: (options: {
|
|
@@ -6364,14 +6363,16 @@ export declare const isBetweenBigDecimal: (options: {
|
|
|
6364
6363
|
*
|
|
6365
6364
|
* **Example** (Checking minimum length)
|
|
6366
6365
|
*
|
|
6367
|
-
* ```ts
|
|
6366
|
+
* ```ts import.meta.vitest
|
|
6368
6367
|
* import { Schema } from "effect"
|
|
6369
6368
|
*
|
|
6370
6369
|
* const NonEmptyStringSchema = Schema.String.check(Schema.isMinLength(1))
|
|
6371
6370
|
* const NonEmptyArraySchema = Schema.Array(Schema.Number).check(Schema.isMinLength(1))
|
|
6371
|
+
* Schema.is(NonEmptyStringSchema)("a") // => true
|
|
6372
|
+
* Schema.is(NonEmptyArraySchema)([1]) // => true
|
|
6372
6373
|
* ```
|
|
6373
6374
|
*
|
|
6374
|
-
* @category
|
|
6375
|
+
* @category validation
|
|
6375
6376
|
* @since 4.0.0
|
|
6376
6377
|
*/
|
|
6377
6378
|
export declare function isMinLength(minLength: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6386,7 +6387,7 @@ export declare function isMinLength(minLength: number, annotations?: Annotations
|
|
|
6386
6387
|
*
|
|
6387
6388
|
* @see {@link isMinLength} for creating the corresponding check
|
|
6388
6389
|
*
|
|
6389
|
-
* @category
|
|
6390
|
+
* @category validation
|
|
6390
6391
|
* @since 4.0.0
|
|
6391
6392
|
*/
|
|
6392
6393
|
export declare const isMinLengthReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6408,7 +6409,7 @@ export declare const isMinLengthReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6408
6409
|
* When generating test data with fast-check, this applies a `minLength: 1`
|
|
6409
6410
|
* constraint to ensure generated strings or arrays are non-empty.
|
|
6410
6411
|
*
|
|
6411
|
-
* @category
|
|
6412
|
+
* @category validation
|
|
6412
6413
|
* @since 4.0.0
|
|
6413
6414
|
*/
|
|
6414
6415
|
export declare function isNonEmpty(annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6431,7 +6432,7 @@ export declare function isNonEmpty(annotations?: Annotations.Filter): SchemaAST.
|
|
|
6431
6432
|
* constraint to ensure generated strings or arrays have at most the required
|
|
6432
6433
|
* length.
|
|
6433
6434
|
*
|
|
6434
|
-
* @category
|
|
6435
|
+
* @category validation
|
|
6435
6436
|
* @since 4.0.0
|
|
6436
6437
|
*/
|
|
6437
6438
|
export declare function isMaxLength(maxLength: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6446,7 +6447,7 @@ export declare function isMaxLength(maxLength: number, annotations?: Annotations
|
|
|
6446
6447
|
*
|
|
6447
6448
|
* @see {@link isMaxLength} for creating the corresponding check
|
|
6448
6449
|
*
|
|
6449
|
-
* @category
|
|
6450
|
+
* @category validation
|
|
6450
6451
|
* @since 4.0.0
|
|
6451
6452
|
*/
|
|
6452
6453
|
export declare const isMaxLengthReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6469,7 +6470,7 @@ export declare const isMaxLengthReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6469
6470
|
* `maxLength` constraints to ensure generated strings or arrays have a length
|
|
6470
6471
|
* within the specified range.
|
|
6471
6472
|
*
|
|
6472
|
-
* @category
|
|
6473
|
+
* @category validation
|
|
6473
6474
|
* @since 4.0.0
|
|
6474
6475
|
*/
|
|
6475
6476
|
export declare function isLengthBetween(minimum: number, maximum: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6484,7 +6485,7 @@ export declare function isLengthBetween(minimum: number, maximum: number, annota
|
|
|
6484
6485
|
*
|
|
6485
6486
|
* @see {@link isLengthBetween} for creating the corresponding check
|
|
6486
6487
|
*
|
|
6487
|
-
* @category
|
|
6488
|
+
* @category validation
|
|
6488
6489
|
* @since 4.0.0
|
|
6489
6490
|
*/
|
|
6490
6491
|
export declare const isLengthBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6508,7 +6509,7 @@ export declare const isLengthBetweenReviver: SchemaRepresentation.FilterReviver<
|
|
|
6508
6509
|
* `minLength` constraint. Generators for values with a final `.size`, such as
|
|
6509
6510
|
* sets and maps, interpret it as final cardinality.
|
|
6510
6511
|
*
|
|
6511
|
-
* @category
|
|
6512
|
+
* @category validation
|
|
6512
6513
|
* @since 4.0.0
|
|
6513
6514
|
*/
|
|
6514
6515
|
export declare function isMinSize(minSize: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6523,7 +6524,7 @@ export declare function isMinSize(minSize: number, annotations?: Annotations.Fil
|
|
|
6523
6524
|
*
|
|
6524
6525
|
* @see {@link isMinSize} for creating the corresponding check
|
|
6525
6526
|
*
|
|
6526
|
-
* @category
|
|
6527
|
+
* @category validation
|
|
6527
6528
|
* @since 4.0.0
|
|
6528
6529
|
*/
|
|
6529
6530
|
export declare const isMinSizeReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6546,7 +6547,7 @@ export declare const isMinSizeReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6546
6547
|
* `maxLength` constraint. Generators for values with a final `.size`, such as
|
|
6547
6548
|
* sets and maps, interpret it as final cardinality.
|
|
6548
6549
|
*
|
|
6549
|
-
* @category
|
|
6550
|
+
* @category validation
|
|
6550
6551
|
* @since 4.0.0
|
|
6551
6552
|
*/
|
|
6552
6553
|
export declare function isMaxSize(maxSize: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6561,7 +6562,7 @@ export declare function isMaxSize(maxSize: number, annotations?: Annotations.Fil
|
|
|
6561
6562
|
*
|
|
6562
6563
|
* @see {@link isMaxSize} for creating the corresponding check
|
|
6563
6564
|
*
|
|
6564
|
-
* @category
|
|
6565
|
+
* @category validation
|
|
6565
6566
|
* @since 4.0.0
|
|
6566
6567
|
*/
|
|
6567
6568
|
export declare const isMaxSizeReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6584,7 +6585,7 @@ export declare const isMaxSizeReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6584
6585
|
* `minLength` and `maxLength` constraints. Generators for values with a final
|
|
6585
6586
|
* `.size`, such as sets and maps, interpret them as final cardinality.
|
|
6586
6587
|
*
|
|
6587
|
-
* @category
|
|
6588
|
+
* @category validation
|
|
6588
6589
|
* @since 4.0.0
|
|
6589
6590
|
*/
|
|
6590
6591
|
export declare function isSizeBetween(minimum: number, maximum: number, annotations?: Annotations.Filter): SchemaAST.Filter<{
|
|
@@ -6599,7 +6600,7 @@ export declare function isSizeBetween(minimum: number, maximum: number, annotati
|
|
|
6599
6600
|
*
|
|
6600
6601
|
* @see {@link isSizeBetween} for creating the corresponding check
|
|
6601
6602
|
*
|
|
6602
|
-
* @category
|
|
6603
|
+
* @category validation
|
|
6603
6604
|
* @since 4.0.0
|
|
6604
6605
|
*/
|
|
6605
6606
|
export declare const isSizeBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6623,7 +6624,7 @@ export declare const isSizeBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
|
6623
6624
|
* `minLength` constraint. Object generators interpret it as the final number
|
|
6624
6625
|
* of own properties.
|
|
6625
6626
|
*
|
|
6626
|
-
* @category
|
|
6627
|
+
* @category validation
|
|
6627
6628
|
* @since 4.0.0
|
|
6628
6629
|
*/
|
|
6629
6630
|
export declare function isMinProperties(minProperties: number, annotations?: Annotations.Filter): SchemaAST.Filter<object>;
|
|
@@ -6636,7 +6637,7 @@ export declare function isMinProperties(minProperties: number, annotations?: Ann
|
|
|
6636
6637
|
*
|
|
6637
6638
|
* @see {@link isMinProperties} for creating the corresponding check
|
|
6638
6639
|
*
|
|
6639
|
-
* @category
|
|
6640
|
+
* @category validation
|
|
6640
6641
|
* @since 4.0.0
|
|
6641
6642
|
*/
|
|
6642
6643
|
export declare const isMinPropertiesReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6658,7 +6659,7 @@ export declare const isMinPropertiesReviver: SchemaRepresentation.FilterReviver<
|
|
|
6658
6659
|
* `maxLength` constraint. Object generators interpret it as the final number
|
|
6659
6660
|
* of own properties.
|
|
6660
6661
|
*
|
|
6661
|
-
* @category
|
|
6662
|
+
* @category validation
|
|
6662
6663
|
* @since 4.0.0
|
|
6663
6664
|
*/
|
|
6664
6665
|
export declare function isMaxProperties(maxProperties: number, annotations?: Annotations.Filter): SchemaAST.Filter<object>;
|
|
@@ -6671,7 +6672,7 @@ export declare function isMaxProperties(maxProperties: number, annotations?: Ann
|
|
|
6671
6672
|
*
|
|
6672
6673
|
* @see {@link isMaxProperties} for creating the corresponding check
|
|
6673
6674
|
*
|
|
6674
|
-
* @category
|
|
6675
|
+
* @category validation
|
|
6675
6676
|
* @since 4.0.0
|
|
6676
6677
|
*/
|
|
6677
6678
|
export declare const isMaxPropertiesReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6694,7 +6695,7 @@ export declare const isMaxPropertiesReviver: SchemaRepresentation.FilterReviver<
|
|
|
6694
6695
|
* `minLength` and `maxLength` constraints. Object generators interpret them as
|
|
6695
6696
|
* the final number of own properties.
|
|
6696
6697
|
*
|
|
6697
|
-
* @category
|
|
6698
|
+
* @category validation
|
|
6698
6699
|
* @since 4.0.0
|
|
6699
6700
|
*/
|
|
6700
6701
|
export declare function isPropertiesLengthBetween(minimum: number, maximum: number, annotations?: Annotations.Filter): SchemaAST.Filter<object>;
|
|
@@ -6707,7 +6708,7 @@ export declare function isPropertiesLengthBetween(minimum: number, maximum: numb
|
|
|
6707
6708
|
*
|
|
6708
6709
|
* @see {@link isPropertiesLengthBetween} for creating the corresponding check
|
|
6709
6710
|
*
|
|
6710
|
-
* @category
|
|
6711
|
+
* @category validation
|
|
6711
6712
|
* @since 4.0.0
|
|
6712
6713
|
*/
|
|
6713
6714
|
export declare const isPropertiesLengthBetweenReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -6727,7 +6728,7 @@ export declare const isPropertiesLengthBetweenReviver: SchemaRepresentation.Filt
|
|
|
6727
6728
|
* For string property names, this corresponds to the `propertyNames` constraint
|
|
6728
6729
|
* in JSON Schema.
|
|
6729
6730
|
*
|
|
6730
|
-
* @category
|
|
6731
|
+
* @category validation
|
|
6731
6732
|
* @since 4.0.0
|
|
6732
6733
|
*/
|
|
6733
6734
|
export declare function isPropertyNames(keySchema: Constraint, annotations?: Annotations.Filter): SchemaAST.Filter<object>;
|
|
@@ -6740,7 +6741,7 @@ export declare function isPropertyNames(keySchema: Constraint, annotations?: Ann
|
|
|
6740
6741
|
*
|
|
6741
6742
|
* @see {@link isPropertyNames} for creating the corresponding check
|
|
6742
6743
|
*
|
|
6743
|
-
* @category
|
|
6744
|
+
* @category validation
|
|
6744
6745
|
* @since 4.0.0
|
|
6745
6746
|
*/
|
|
6746
6747
|
export declare const isPropertyNamesReviver: SchemaRepresentation.FilterReviver<null>;
|
|
@@ -6757,7 +6758,7 @@ export declare const isPropertyNamesReviver: SchemaRepresentation.FilterReviver<
|
|
|
6757
6758
|
* `unique: true` constraint. Array generators translate it to `fast-check`
|
|
6758
6759
|
* `uniqueArray` using Effect equality.
|
|
6759
6760
|
*
|
|
6760
|
-
* @category
|
|
6761
|
+
* @category validation
|
|
6761
6762
|
* @since 4.0.0
|
|
6762
6763
|
*/
|
|
6763
6764
|
export declare function isUnique<T>(annotations?: Annotations.Filter): SchemaAST.Filter<readonly T[]>;
|
|
@@ -6770,14 +6771,14 @@ export declare function isUnique<T>(annotations?: Annotations.Filter): SchemaAST
|
|
|
6770
6771
|
*
|
|
6771
6772
|
* @see {@link isUnique} for creating the corresponding check
|
|
6772
6773
|
*
|
|
6773
|
-
* @category
|
|
6774
|
+
* @category validation
|
|
6774
6775
|
* @since 4.0.0
|
|
6775
6776
|
*/
|
|
6776
6777
|
export declare const isUniqueReviver: SchemaRepresentation.FilterReviver<null>;
|
|
6777
6778
|
/**
|
|
6778
6779
|
* Type-level representation of {@link NonEmptyString}.
|
|
6779
6780
|
*
|
|
6780
|
-
* @category
|
|
6781
|
+
* @category models
|
|
6781
6782
|
* @since 3.10.0
|
|
6782
6783
|
*/
|
|
6783
6784
|
export interface NonEmptyString extends String {
|
|
@@ -6787,14 +6788,14 @@ export interface NonEmptyString extends String {
|
|
|
6787
6788
|
* Schema for non-empty strings. Validates that a string has at least one
|
|
6788
6789
|
* character.
|
|
6789
6790
|
*
|
|
6790
|
-
* @category
|
|
6791
|
+
* @category schemas
|
|
6791
6792
|
* @since 3.10.0
|
|
6792
6793
|
*/
|
|
6793
6794
|
export declare const NonEmptyString: NonEmptyString;
|
|
6794
6795
|
/**
|
|
6795
6796
|
* Type-level representation of {@link Char}.
|
|
6796
6797
|
*
|
|
6797
|
-
* @category
|
|
6798
|
+
* @category models
|
|
6798
6799
|
* @since 3.10.0
|
|
6799
6800
|
*/
|
|
6800
6801
|
export interface Char extends String {
|
|
@@ -6816,14 +6817,14 @@ export interface Char extends String {
|
|
|
6816
6817
|
* @see {@link NonEmptyString} for strings with length greater than zero
|
|
6817
6818
|
* @see {@link isLengthBetween} for the underlying length check
|
|
6818
6819
|
*
|
|
6819
|
-
* @category
|
|
6820
|
+
* @category schemas
|
|
6820
6821
|
* @since 3.10.0
|
|
6821
6822
|
*/
|
|
6822
6823
|
export declare const Char: Char;
|
|
6823
6824
|
/**
|
|
6824
6825
|
* Type-level representation returned by {@link Option}.
|
|
6825
6826
|
*
|
|
6826
|
-
* @category
|
|
6827
|
+
* @category models
|
|
6827
6828
|
* @since 3.10.0
|
|
6828
6829
|
*/
|
|
6829
6830
|
export interface Option<A extends Constraint> extends declareConstructor<Option_.Option<A["Type"]>, Option_.Option<A["Encoded"]>, readonly [A], OptionIso<A>> {
|
|
@@ -6838,7 +6839,7 @@ export interface Option<A extends Constraint> extends declareConstructor<Option_
|
|
|
6838
6839
|
* `None` is represented as `{ _tag: "None" }`, while `Some` is represented as
|
|
6839
6840
|
* `{ _tag: "Some", value }` using the wrapped schema's `Iso` type.
|
|
6840
6841
|
*
|
|
6841
|
-
* @category
|
|
6842
|
+
* @category utility types
|
|
6842
6843
|
* @since 4.0.0
|
|
6843
6844
|
*/
|
|
6844
6845
|
export type OptionIso<A extends Constraint> = {
|
|
@@ -6850,7 +6851,7 @@ export type OptionIso<A extends Constraint> = {
|
|
|
6850
6851
|
/**
|
|
6851
6852
|
* Schema for `Option<A>` values.
|
|
6852
6853
|
*
|
|
6853
|
-
* @category
|
|
6854
|
+
* @category schemas
|
|
6854
6855
|
* @since 3.10.0
|
|
6855
6856
|
*/
|
|
6856
6857
|
export declare function Option<A extends Constraint>(value: A): Option<A>;
|
|
@@ -6863,14 +6864,14 @@ export declare function Option<A extends Constraint>(value: A): Option<A>;
|
|
|
6863
6864
|
*
|
|
6864
6865
|
* @see {@link Option} for creating the corresponding schema
|
|
6865
6866
|
*
|
|
6866
|
-
* @category
|
|
6867
|
+
* @category schemas
|
|
6867
6868
|
* @since 4.0.0
|
|
6868
6869
|
*/
|
|
6869
6870
|
export declare const OptionReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
6870
6871
|
/**
|
|
6871
6872
|
* Type-level representation returned by {@link OptionFromNullOr}.
|
|
6872
6873
|
*
|
|
6873
|
-
* @category
|
|
6874
|
+
* @category models
|
|
6874
6875
|
* @since 3.10.0
|
|
6875
6876
|
*/
|
|
6876
6877
|
export interface OptionFromNullOr<S extends Constraint> extends decodeTo<Option<toType<S>>, NullOr<S>> {
|
|
@@ -6884,14 +6885,14 @@ export interface OptionFromNullOr<S extends Constraint> extends decodeTo<Option<
|
|
|
6884
6885
|
* Decoding maps `null` to `None` and all other values to `Some`. Encoding maps
|
|
6885
6886
|
* `None` to `null` and maps `Some` to its value.
|
|
6886
6887
|
*
|
|
6887
|
-
* @category
|
|
6888
|
+
* @category schemas
|
|
6888
6889
|
* @since 3.10.0
|
|
6889
6890
|
*/
|
|
6890
6891
|
export declare function OptionFromNullOr<S extends Constraint>(schema: S): OptionFromNullOr<S>;
|
|
6891
6892
|
/**
|
|
6892
6893
|
* Type-level representation returned by {@link OptionFromUndefinedOr}.
|
|
6893
6894
|
*
|
|
6894
|
-
* @category
|
|
6895
|
+
* @category models
|
|
6895
6896
|
* @since 3.10.0
|
|
6896
6897
|
*/
|
|
6897
6898
|
export interface OptionFromUndefinedOr<S extends Constraint> extends decodeTo<Option<toType<S>>, UndefinedOr<S>> {
|
|
@@ -6906,14 +6907,14 @@ export interface OptionFromUndefinedOr<S extends Constraint> extends decodeTo<Op
|
|
|
6906
6907
|
* Decoding maps `undefined` to `None` and all other values to `Some`. Encoding
|
|
6907
6908
|
* maps `None` to `undefined` and maps `Some` to its value.
|
|
6908
6909
|
*
|
|
6909
|
-
* @category
|
|
6910
|
+
* @category schemas
|
|
6910
6911
|
* @since 3.10.0
|
|
6911
6912
|
*/
|
|
6912
6913
|
export declare function OptionFromUndefinedOr<S extends Constraint>(schema: S): OptionFromUndefinedOr<S>;
|
|
6913
6914
|
/**
|
|
6914
6915
|
* Type-level representation returned by {@link OptionFromNullishOr}.
|
|
6915
6916
|
*
|
|
6916
|
-
* @category
|
|
6917
|
+
* @category models
|
|
6917
6918
|
* @since 3.10.0
|
|
6918
6919
|
*/
|
|
6919
6920
|
export interface OptionFromNullishOr<S extends Constraint> extends decodeTo<Option<toType<S>>, NullishOr<S>> {
|
|
@@ -6929,7 +6930,7 @@ export interface OptionFromNullishOr<S extends Constraint> extends decodeTo<Opti
|
|
|
6929
6930
|
* `options.onNoneEncoding`, which defaults to `undefined`, and maps `Some` to
|
|
6930
6931
|
* its value.
|
|
6931
6932
|
*
|
|
6932
|
-
* @category
|
|
6933
|
+
* @category schemas
|
|
6933
6934
|
* @since 3.10.0
|
|
6934
6935
|
*/
|
|
6935
6936
|
export declare function OptionFromNullishOr<S extends Constraint>(schema: S, options?: {
|
|
@@ -6938,7 +6939,7 @@ export declare function OptionFromNullishOr<S extends Constraint>(schema: S, opt
|
|
|
6938
6939
|
/**
|
|
6939
6940
|
* Type-level representation returned by {@link OptionFromOptionalKey}.
|
|
6940
6941
|
*
|
|
6941
|
-
* @category
|
|
6942
|
+
* @category models
|
|
6942
6943
|
* @since 4.0.0
|
|
6943
6944
|
*/
|
|
6944
6945
|
export interface OptionFromOptionalKey<S extends Constraint> extends decodeTo<Option<toType<S>>, optionalKey<S>> {
|
|
@@ -6952,14 +6953,14 @@ export interface OptionFromOptionalKey<S extends Constraint> extends decodeTo<Op
|
|
|
6952
6953
|
* Decoding maps a missing key to `None` and a present value to `Some`.
|
|
6953
6954
|
* Encoding maps `None` to a missing key and maps `Some` to its value.
|
|
6954
6955
|
*
|
|
6955
|
-
* @category
|
|
6956
|
+
* @category schemas
|
|
6956
6957
|
* @since 4.0.0
|
|
6957
6958
|
*/
|
|
6958
6959
|
export declare function OptionFromOptionalKey<S extends Constraint>(schema: S): OptionFromOptionalKey<S>;
|
|
6959
6960
|
/**
|
|
6960
6961
|
* Type-level representation returned by {@link OptionFromOptional}.
|
|
6961
6962
|
*
|
|
6962
|
-
* @category
|
|
6963
|
+
* @category models
|
|
6963
6964
|
* @since 4.0.0
|
|
6964
6965
|
*/
|
|
6965
6966
|
export interface OptionFromOptional<S extends Constraint> extends decodeTo<Option<toType<S>>, optional<S>> {
|
|
@@ -6975,14 +6976,14 @@ export interface OptionFromOptional<S extends Constraint> extends decodeTo<Optio
|
|
|
6975
6976
|
* maps all other values to `Some`. Encoding maps `None` to a missing key and
|
|
6976
6977
|
* maps `Some` to its value.
|
|
6977
6978
|
*
|
|
6978
|
-
* @category
|
|
6979
|
+
* @category schemas
|
|
6979
6980
|
* @since 4.0.0
|
|
6980
6981
|
*/
|
|
6981
6982
|
export declare function OptionFromOptional<S extends Constraint>(schema: S): OptionFromOptional<S>;
|
|
6982
6983
|
/**
|
|
6983
6984
|
* Type-level representation returned by {@link OptionFromOptionalNullOr}.
|
|
6984
6985
|
*
|
|
6985
|
-
* @category
|
|
6986
|
+
* @category models
|
|
6986
6987
|
* @since 4.0.0
|
|
6987
6988
|
*/
|
|
6988
6989
|
export interface OptionFromOptionalNullOr<S extends Constraint> extends decodeTo<Option<toType<S>>, optional<NullOr<S>>> {
|
|
@@ -6999,7 +7000,7 @@ export interface OptionFromOptionalNullOr<S extends Constraint> extends decodeTo
|
|
|
6999
7000
|
* according to `options.onNoneEncoding`: `"omit"` encodes a missing key,
|
|
7000
7001
|
* `null` encodes `null`, and `undefined` encodes `undefined`.
|
|
7001
7002
|
*
|
|
7002
|
-
* @category
|
|
7003
|
+
* @category schemas
|
|
7003
7004
|
* @since 4.0.0
|
|
7004
7005
|
*/
|
|
7005
7006
|
export declare function OptionFromOptionalNullOr<S extends Constraint>(schema: S, options?: {
|
|
@@ -7008,7 +7009,7 @@ export declare function OptionFromOptionalNullOr<S extends Constraint>(schema: S
|
|
|
7008
7009
|
/**
|
|
7009
7010
|
* Type-level representation returned by {@link Result}.
|
|
7010
7011
|
*
|
|
7011
|
-
* @category
|
|
7012
|
+
* @category models
|
|
7012
7013
|
* @since 4.0.0
|
|
7013
7014
|
*/
|
|
7014
7015
|
export interface Result<A extends Constraint, E extends Constraint> extends declareConstructor<Result_.Result<A["Type"], E["Type"]>, Result_.Result<A["Encoded"], E["Encoded"]>, readonly [A, E], ResultIso<A, E>> {
|
|
@@ -7024,7 +7025,7 @@ export interface Result<A extends Constraint, E extends Constraint> extends decl
|
|
|
7024
7025
|
* Successful results are represented as `{ _tag: "Success", success }`, while
|
|
7025
7026
|
* failed results are represented as `{ _tag: "Failure", failure }`.
|
|
7026
7027
|
*
|
|
7027
|
-
* @category
|
|
7028
|
+
* @category utility types
|
|
7028
7029
|
* @since 4.0.0
|
|
7029
7030
|
*/
|
|
7030
7031
|
export type ResultIso<A extends Constraint, E extends Constraint> = {
|
|
@@ -7057,7 +7058,7 @@ export declare const ResultReviver: SchemaRepresentation.DeclarationReviver<null
|
|
|
7057
7058
|
/**
|
|
7058
7059
|
* Type-level representation returned by {@link Redacted}.
|
|
7059
7060
|
*
|
|
7060
|
-
* @category
|
|
7061
|
+
* @category models
|
|
7061
7062
|
* @since 3.10.0
|
|
7062
7063
|
*/
|
|
7063
7064
|
export interface Redacted<S extends Constraint> extends declareConstructor<Redacted_.Redacted<S["Type"]>, Redacted_.Redacted<S["Encoded"]>, readonly [S]> {
|
|
@@ -7071,13 +7072,7 @@ type RedactedRepresentationOptions = {
|
|
|
7071
7072
|
type RedactedRepresentationPayload = RedactedRepresentationOptions | null;
|
|
7072
7073
|
declare const RedactedRepresentationPayload: Decoder<RedactedRepresentationPayload>;
|
|
7073
7074
|
/**
|
|
7074
|
-
* Schema for values
|
|
7075
|
-
* inspection.
|
|
7076
|
-
*
|
|
7077
|
-
* **Details**
|
|
7078
|
-
*
|
|
7079
|
-
* If the wrapped schema fails, the issue will be redacted to prevent both
|
|
7080
|
-
* the actual value and the schema details from being exposed.
|
|
7075
|
+
* Schema for `Redacted` values, which hide their contents from inspection.
|
|
7081
7076
|
*
|
|
7082
7077
|
* Options:
|
|
7083
7078
|
*
|
|
@@ -7091,7 +7086,7 @@ declare const RedactedRepresentationPayload: Decoder<RedactedRepresentationPaylo
|
|
|
7091
7086
|
* sensitive and should not be exposed in JSON.
|
|
7092
7087
|
*
|
|
7093
7088
|
* @see {@link RedactedFromValue} for decoding raw values and wrapping them in `Redacted`.
|
|
7094
|
-
* @category
|
|
7089
|
+
* @category schemas
|
|
7095
7090
|
* @since 3.10.0
|
|
7096
7091
|
*/
|
|
7097
7092
|
export declare function Redacted<S extends Constraint>(value: S, options?: {
|
|
@@ -7107,34 +7102,26 @@ export declare function Redacted<S extends Constraint>(value: S, options?: {
|
|
|
7107
7102
|
*
|
|
7108
7103
|
* @see {@link Redacted} for creating the corresponding schema
|
|
7109
7104
|
*
|
|
7110
|
-
* @category
|
|
7105
|
+
* @category schemas
|
|
7111
7106
|
* @since 4.0.0
|
|
7112
7107
|
*/
|
|
7113
7108
|
export declare const RedactedReviver: SchemaRepresentation.DeclarationReviver<RedactedRepresentationPayload>;
|
|
7114
7109
|
/**
|
|
7115
7110
|
* Type-level representation returned by {@link RedactedFromValue}.
|
|
7116
7111
|
*
|
|
7117
|
-
* @category
|
|
7112
|
+
* @category models
|
|
7118
7113
|
* @since 4.0.0
|
|
7119
7114
|
*/
|
|
7120
|
-
export interface RedactedFromValue<S extends Constraint> extends decodeTo<Redacted<toType<S>>,
|
|
7115
|
+
export interface RedactedFromValue<S extends Constraint> extends decodeTo<Redacted<toType<S>>, S> {
|
|
7121
7116
|
readonly "Rebuild": RedactedFromValue<S>;
|
|
7122
7117
|
}
|
|
7123
|
-
/**
|
|
7124
|
-
* Middleware that wraps decoded errors in `Redacted`, preventing sensitive
|
|
7125
|
-
* schema details from leaking in error messages.
|
|
7126
|
-
*
|
|
7127
|
-
* @category Redacted
|
|
7128
|
-
* @since 4.0.0
|
|
7129
|
-
*/
|
|
7130
|
-
export declare function redact<S extends Constraint>(schema: S): middlewareDecoding<S, S["DecodingServices"]>;
|
|
7131
7118
|
/**
|
|
7132
7119
|
* Decodes a value and wraps it in `Redacted<A>`. Unlike {@link Redacted} which
|
|
7133
7120
|
* expects the input to already be a `Redacted` instance, this schema decodes
|
|
7134
7121
|
* the raw value and wraps it.
|
|
7135
7122
|
*
|
|
7136
7123
|
* @see {@link Redacted} for schemas whose input is already a `Redacted` value.
|
|
7137
|
-
* @category
|
|
7124
|
+
* @category schemas
|
|
7138
7125
|
* @since 4.0.0
|
|
7139
7126
|
*/
|
|
7140
7127
|
export declare function RedactedFromValue<S extends Constraint>(value: S, options?: {
|
|
@@ -7144,7 +7131,7 @@ export declare function RedactedFromValue<S extends Constraint>(value: S, option
|
|
|
7144
7131
|
/**
|
|
7145
7132
|
* Type-level representation returned by {@link CauseReason}.
|
|
7146
7133
|
*
|
|
7147
|
-
* @category
|
|
7134
|
+
* @category models
|
|
7148
7135
|
* @since 4.0.0
|
|
7149
7136
|
*/
|
|
7150
7137
|
export interface CauseReason<E extends Constraint, D extends Constraint> extends declareConstructor<Cause_.Reason<E["Type"]>, Cause_.Reason<E["Encoded"]>, readonly [E, D], CauseReasonIso<E, D>> {
|
|
@@ -7160,7 +7147,7 @@ export interface CauseReason<E extends Constraint, D extends Constraint> extends
|
|
|
7160
7147
|
* Failures are represented with a `Fail` tag and encoded error, defects with a
|
|
7161
7148
|
* `Die` tag and encoded defect, and interrupts with an optional `fiberId`.
|
|
7162
7149
|
*
|
|
7163
|
-
* @category
|
|
7150
|
+
* @category utility types
|
|
7164
7151
|
* @since 4.0.0
|
|
7165
7152
|
*/
|
|
7166
7153
|
export type CauseReasonIso<E extends Constraint, D extends Constraint> = {
|
|
@@ -7190,7 +7177,7 @@ export type CauseReasonIso<E extends Constraint, D extends Constraint> = {
|
|
|
7190
7177
|
* @see {@link Cause} for constructing schemas for full Cause values
|
|
7191
7178
|
* @see {@link CauseReasonIso} for the ISO shape of each cause reason
|
|
7192
7179
|
*
|
|
7193
|
-
* @category
|
|
7180
|
+
* @category schemas
|
|
7194
7181
|
* @since 4.0.0
|
|
7195
7182
|
*/
|
|
7196
7183
|
export declare function CauseReason<E extends Constraint, D extends Constraint>(error: E, defect: D): CauseReason<E, D>;
|
|
@@ -7203,14 +7190,14 @@ export declare function CauseReason<E extends Constraint, D extends Constraint>(
|
|
|
7203
7190
|
*
|
|
7204
7191
|
* @see {@link CauseReason} for creating the corresponding schema
|
|
7205
7192
|
*
|
|
7206
|
-
* @category
|
|
7193
|
+
* @category schemas
|
|
7207
7194
|
* @since 4.0.0
|
|
7208
7195
|
*/
|
|
7209
7196
|
export declare const CauseReasonReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7210
7197
|
/**
|
|
7211
7198
|
* Type-level representation returned by {@link Cause}.
|
|
7212
7199
|
*
|
|
7213
|
-
* @category
|
|
7200
|
+
* @category models
|
|
7214
7201
|
* @since 3.10.0
|
|
7215
7202
|
*/
|
|
7216
7203
|
export interface Cause<E extends Constraint, D extends Constraint> extends declareConstructor<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, readonly [E, D], CauseIso<E, D>> {
|
|
@@ -7230,7 +7217,7 @@ export interface Cause<E extends Constraint, D extends Constraint> extends decla
|
|
|
7230
7217
|
* @see {@link Cause} for constructing schemas for full Cause values
|
|
7231
7218
|
* @see {@link CauseReasonIso} for the ISO shape of each array element
|
|
7232
7219
|
*
|
|
7233
|
-
* @category
|
|
7220
|
+
* @category utility types
|
|
7234
7221
|
* @since 4.0.0
|
|
7235
7222
|
*/
|
|
7236
7223
|
export type CauseIso<E extends Constraint, D extends Constraint> = ReadonlyArray<CauseReasonIso<E, D>>;
|
|
@@ -7252,7 +7239,7 @@ export type CauseIso<E extends Constraint, D extends Constraint> = ReadonlyArray
|
|
|
7252
7239
|
* @see {@link CauseReason} for the schema used by each individual cause reason
|
|
7253
7240
|
* @see {@link CauseIso} for the ordered array representation used by the schema ISO
|
|
7254
7241
|
*
|
|
7255
|
-
* @category
|
|
7242
|
+
* @category schemas
|
|
7256
7243
|
* @since 3.10.0
|
|
7257
7244
|
*/
|
|
7258
7245
|
export declare function Cause<E extends Constraint, D extends Constraint>(error: E, defect: D): Cause<E, D>;
|
|
@@ -7265,14 +7252,14 @@ export declare function Cause<E extends Constraint, D extends Constraint>(error:
|
|
|
7265
7252
|
*
|
|
7266
7253
|
* @see {@link Cause} for creating the corresponding schema
|
|
7267
7254
|
*
|
|
7268
|
-
* @category
|
|
7255
|
+
* @category schemas
|
|
7269
7256
|
* @since 4.0.0
|
|
7270
7257
|
*/
|
|
7271
7258
|
export declare const CauseReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7272
7259
|
/**
|
|
7273
7260
|
* Type-level representation of {@link Error}.
|
|
7274
7261
|
*
|
|
7275
|
-
* @category
|
|
7262
|
+
* @category models
|
|
7276
7263
|
* @since 4.0.0
|
|
7277
7264
|
*/
|
|
7278
7265
|
export interface Error extends instanceOf<globalThis.Error> {
|
|
@@ -7317,7 +7304,7 @@ declare const ErrorRepresentationPayload: Decoder<ErrorRepresentationPayload>;
|
|
|
7317
7304
|
* traces are omitted by default for security. Pass `{ includeStack: true }` to
|
|
7318
7305
|
* include stack traces, or `{ excludeCause: true }` to omit causes.
|
|
7319
7306
|
*
|
|
7320
|
-
* @category
|
|
7307
|
+
* @category schemas
|
|
7321
7308
|
* @since 4.0.0
|
|
7322
7309
|
*/
|
|
7323
7310
|
export declare function Error(options?: ErrorOptions): Error;
|
|
@@ -7330,14 +7317,14 @@ export declare function Error(options?: ErrorOptions): Error;
|
|
|
7330
7317
|
*
|
|
7331
7318
|
* @see {@link Error} for creating the corresponding schema
|
|
7332
7319
|
*
|
|
7333
|
-
* @category
|
|
7320
|
+
* @category schemas
|
|
7334
7321
|
* @since 4.0.0
|
|
7335
7322
|
*/
|
|
7336
7323
|
export declare const ErrorReviver: SchemaRepresentation.DeclarationReviver<ErrorRepresentationPayload>;
|
|
7337
7324
|
/**
|
|
7338
7325
|
* Type-level representation of {@link Defect}.
|
|
7339
7326
|
*
|
|
7340
|
-
* @category
|
|
7327
|
+
* @category models
|
|
7341
7328
|
* @since 3.10.0
|
|
7342
7329
|
*/
|
|
7343
7330
|
export interface Defect extends decodeTo<Unknown, typeof Json> {
|
|
@@ -7381,14 +7368,14 @@ export interface Defect extends decodeTo<Unknown, typeof Json> {
|
|
|
7381
7368
|
* string representation.
|
|
7382
7369
|
*
|
|
7383
7370
|
* @see {@link Error} for a schema that only accepts JavaScript `Error` values.
|
|
7384
|
-
* @category
|
|
7371
|
+
* @category schemas
|
|
7385
7372
|
* @since 4.0.0
|
|
7386
7373
|
*/
|
|
7387
7374
|
export declare function Defect(options?: ErrorOptions): Defect;
|
|
7388
7375
|
/**
|
|
7389
7376
|
* Type-level representation returned by {@link Exit}.
|
|
7390
7377
|
*
|
|
7391
|
-
* @category
|
|
7378
|
+
* @category models
|
|
7392
7379
|
* @since 3.10.0
|
|
7393
7380
|
*/
|
|
7394
7381
|
export interface Exit<A extends Constraint, E extends Constraint, D extends Constraint> extends declareConstructor<Exit_.Exit<A["Type"], E["Type"]>, Exit_.Exit<A["Encoded"], E["Encoded"]>, readonly [A, E, D], ExitIso<A, E, D>> {
|
|
@@ -7405,7 +7392,7 @@ export interface Exit<A extends Constraint, E extends Constraint, D extends Cons
|
|
|
7405
7392
|
* Successful exits are represented as `{ _tag: "Success", value }`, while failed
|
|
7406
7393
|
* exits are represented as `{ _tag: "Failure", cause }`.
|
|
7407
7394
|
*
|
|
7408
|
-
* @category
|
|
7395
|
+
* @category utility types
|
|
7409
7396
|
* @since 4.0.0
|
|
7410
7397
|
*/
|
|
7411
7398
|
export type ExitIso<A extends Constraint, E extends Constraint, D extends Constraint> = {
|
|
@@ -7424,7 +7411,7 @@ export type ExitIso<A extends Constraint, E extends Constraint, D extends Constr
|
|
|
7424
7411
|
* Use when serializing or validating an effect outcome where success, typed
|
|
7425
7412
|
* failure, and defects each need their own schema.
|
|
7426
7413
|
*
|
|
7427
|
-
* @category
|
|
7414
|
+
* @category schemas
|
|
7428
7415
|
* @since 3.10.0
|
|
7429
7416
|
*/
|
|
7430
7417
|
export declare function Exit<A extends Constraint, E extends Constraint, D extends Constraint>(value: A, error: E, defect: D): Exit<A, E, D>;
|
|
@@ -7437,14 +7424,14 @@ export declare function Exit<A extends Constraint, E extends Constraint, D exten
|
|
|
7437
7424
|
*
|
|
7438
7425
|
* @see {@link Exit} for creating the corresponding schema
|
|
7439
7426
|
*
|
|
7440
|
-
* @category
|
|
7427
|
+
* @category schemas
|
|
7441
7428
|
* @since 4.0.0
|
|
7442
7429
|
*/
|
|
7443
7430
|
export declare const ExitReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7444
7431
|
/**
|
|
7445
7432
|
* Type-level representation returned by {@link ReadonlyMap}.
|
|
7446
7433
|
*
|
|
7447
|
-
* @category
|
|
7434
|
+
* @category models
|
|
7448
7435
|
* @since 4.0.0
|
|
7449
7436
|
*/
|
|
7450
7437
|
export interface $ReadonlyMap<Key extends Constraint, Value extends Constraint> extends declareConstructor<globalThis.ReadonlyMap<Key["Type"], Value["Type"]>, globalThis.ReadonlyMap<Key["Encoded"], Value["Encoded"]>, readonly [Key, Value], ReadonlyMapIso<Key, Value>> {
|
|
@@ -7456,7 +7443,7 @@ export interface $ReadonlyMap<Key extends Constraint, Value extends Constraint>
|
|
|
7456
7443
|
* Iso representation used for `ReadonlyMap` schemas: an array of readonly
|
|
7457
7444
|
* `[key, value]` tuples using each entry schema's `Iso` type.
|
|
7458
7445
|
*
|
|
7459
|
-
* @category
|
|
7446
|
+
* @category utility types
|
|
7460
7447
|
* @since 4.0.0
|
|
7461
7448
|
*/
|
|
7462
7449
|
export type ReadonlyMapIso<Key extends Constraint, Value extends Constraint> = ReadonlyArray<readonly [Key["Iso"], Value["Iso"]]>;
|
|
@@ -7464,7 +7451,7 @@ export type ReadonlyMapIso<Key extends Constraint, Value extends Constraint> = R
|
|
|
7464
7451
|
* Schema for readonly maps whose keys and values conform to the provided
|
|
7465
7452
|
* schemas.
|
|
7466
7453
|
*
|
|
7467
|
-
* @category
|
|
7454
|
+
* @category schemas
|
|
7468
7455
|
* @since 3.10.0
|
|
7469
7456
|
*/
|
|
7470
7457
|
export declare function ReadonlyMap<Key extends Constraint, Value extends Constraint>(key: Key, value: Value): $ReadonlyMap<Key, Value>;
|
|
@@ -7477,14 +7464,14 @@ export declare function ReadonlyMap<Key extends Constraint, Value extends Constr
|
|
|
7477
7464
|
*
|
|
7478
7465
|
* @see {@link ReadonlyMap} for creating the corresponding schema
|
|
7479
7466
|
*
|
|
7480
|
-
* @category
|
|
7467
|
+
* @category schemas
|
|
7481
7468
|
* @since 4.0.0
|
|
7482
7469
|
*/
|
|
7483
7470
|
export declare const ReadonlyMapReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7484
7471
|
/**
|
|
7485
7472
|
* Type-level representation returned by {@link HashMap}.
|
|
7486
7473
|
*
|
|
7487
|
-
* @category
|
|
7474
|
+
* @category models
|
|
7488
7475
|
* @since 3.10.0
|
|
7489
7476
|
*/
|
|
7490
7477
|
export interface HashMap<Key extends Constraint, Value extends Constraint> extends declareConstructor<HashMap_.HashMap<Key["Type"], Value["Type"]>, HashMap_.HashMap<Key["Encoded"], Value["Encoded"]>, readonly [Key, Value], HashMapIso<Key, Value>> {
|
|
@@ -7496,14 +7483,14 @@ export interface HashMap<Key extends Constraint, Value extends Constraint> exten
|
|
|
7496
7483
|
* Iso representation used for `HashMap` schemas: an array of readonly
|
|
7497
7484
|
* `[key, value]` tuples using each entry schema's `Iso` type.
|
|
7498
7485
|
*
|
|
7499
|
-
* @category
|
|
7486
|
+
* @category utility types
|
|
7500
7487
|
* @since 4.0.0
|
|
7501
7488
|
*/
|
|
7502
7489
|
export type HashMapIso<Key extends Constraint, Value extends Constraint> = ReadonlyArray<readonly [Key["Iso"], Value["Iso"]]>;
|
|
7503
7490
|
/**
|
|
7504
7491
|
* Schema for hash maps whose keys and values conform to the provided schemas.
|
|
7505
7492
|
*
|
|
7506
|
-
* @category
|
|
7493
|
+
* @category schemas
|
|
7507
7494
|
* @since 3.10.0
|
|
7508
7495
|
*/
|
|
7509
7496
|
export declare function HashMap<Key extends Constraint, Value extends Constraint>(key: Key, value: Value): HashMap<Key, Value>;
|
|
@@ -7516,14 +7503,14 @@ export declare function HashMap<Key extends Constraint, Value extends Constraint
|
|
|
7516
7503
|
*
|
|
7517
7504
|
* @see {@link HashMap} for creating the corresponding schema
|
|
7518
7505
|
*
|
|
7519
|
-
* @category
|
|
7506
|
+
* @category schemas
|
|
7520
7507
|
* @since 4.0.0
|
|
7521
7508
|
*/
|
|
7522
7509
|
export declare const HashMapReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7523
7510
|
/**
|
|
7524
7511
|
* Type-level representation returned by {@link ReadonlySet}.
|
|
7525
7512
|
*
|
|
7526
|
-
* @category
|
|
7513
|
+
* @category models
|
|
7527
7514
|
* @since 4.0.0
|
|
7528
7515
|
*/
|
|
7529
7516
|
export interface $ReadonlySet<Value extends Constraint> extends declareConstructor<globalThis.ReadonlySet<Value["Type"]>, globalThis.ReadonlySet<Value["Encoded"]>, readonly [Value], ReadonlySetIso<Value>> {
|
|
@@ -7534,14 +7521,14 @@ export interface $ReadonlySet<Value extends Constraint> extends declareConstruct
|
|
|
7534
7521
|
* Iso representation used for `ReadonlySet` schemas: an array of element values
|
|
7535
7522
|
* using the element schema's `Iso` type.
|
|
7536
7523
|
*
|
|
7537
|
-
* @category
|
|
7524
|
+
* @category utility types
|
|
7538
7525
|
* @since 4.0.0
|
|
7539
7526
|
*/
|
|
7540
7527
|
export type ReadonlySetIso<Value extends Constraint> = ReadonlyArray<Value["Iso"]>;
|
|
7541
7528
|
/**
|
|
7542
7529
|
* Schema for readonly sets whose values conform to the provided element schema.
|
|
7543
7530
|
*
|
|
7544
|
-
* @category
|
|
7531
|
+
* @category schemas
|
|
7545
7532
|
* @since 3.10.0
|
|
7546
7533
|
*/
|
|
7547
7534
|
export declare function ReadonlySet<Value extends Constraint>(value: Value): $ReadonlySet<Value>;
|
|
@@ -7554,14 +7541,14 @@ export declare function ReadonlySet<Value extends Constraint>(value: Value): $Re
|
|
|
7554
7541
|
*
|
|
7555
7542
|
* @see {@link ReadonlySet} for creating the corresponding schema
|
|
7556
7543
|
*
|
|
7557
|
-
* @category
|
|
7544
|
+
* @category schemas
|
|
7558
7545
|
* @since 4.0.0
|
|
7559
7546
|
*/
|
|
7560
7547
|
export declare const ReadonlySetReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7561
7548
|
/**
|
|
7562
7549
|
* Type-level representation returned by {@link HashSet}.
|
|
7563
7550
|
*
|
|
7564
|
-
* @category
|
|
7551
|
+
* @category models
|
|
7565
7552
|
* @since 3.10.0
|
|
7566
7553
|
*/
|
|
7567
7554
|
export interface HashSet<Value extends Constraint> extends declareConstructor<HashSet_.HashSet<Value["Type"]>, HashSet_.HashSet<Value["Encoded"]>, readonly [Value], HashSetIso<Value>> {
|
|
@@ -7572,14 +7559,14 @@ export interface HashSet<Value extends Constraint> extends declareConstructor<Ha
|
|
|
7572
7559
|
* Iso representation used for `HashSet` schemas: an array of element values
|
|
7573
7560
|
* using the element schema's `Iso` type.
|
|
7574
7561
|
*
|
|
7575
|
-
* @category
|
|
7562
|
+
* @category utility types
|
|
7576
7563
|
* @since 4.0.0
|
|
7577
7564
|
*/
|
|
7578
7565
|
export type HashSetIso<Value extends Constraint> = ReadonlyArray<Value["Iso"]>;
|
|
7579
7566
|
/**
|
|
7580
7567
|
* Schema for hash sets whose values conform to the provided element schema.
|
|
7581
7568
|
*
|
|
7582
|
-
* @category
|
|
7569
|
+
* @category schemas
|
|
7583
7570
|
* @since 3.10.0
|
|
7584
7571
|
*/
|
|
7585
7572
|
export declare function HashSet<Value extends Constraint>(value: Value): HashSet<Value>;
|
|
@@ -7592,14 +7579,14 @@ export declare function HashSet<Value extends Constraint>(value: Value): HashSet
|
|
|
7592
7579
|
*
|
|
7593
7580
|
* @see {@link HashSet} for creating the corresponding schema
|
|
7594
7581
|
*
|
|
7595
|
-
* @category
|
|
7582
|
+
* @category schemas
|
|
7596
7583
|
* @since 4.0.0
|
|
7597
7584
|
*/
|
|
7598
7585
|
export declare const HashSetReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7599
7586
|
/**
|
|
7600
7587
|
* Type-level representation returned by {@link Chunk}.
|
|
7601
7588
|
*
|
|
7602
|
-
* @category
|
|
7589
|
+
* @category models
|
|
7603
7590
|
* @since 3.10.0
|
|
7604
7591
|
*/
|
|
7605
7592
|
export interface Chunk<Value extends Constraint> extends declareConstructor<Chunk_.Chunk<Value["Type"]>, Chunk_.Chunk<Value["Encoded"]>, readonly [Value], ChunkIso<Value>> {
|
|
@@ -7617,14 +7604,14 @@ export interface Chunk<Value extends Constraint> extends declareConstructor<Chun
|
|
|
7617
7604
|
*
|
|
7618
7605
|
* @see {@link Chunk} for the schema interface and constructor that use this ISO representation
|
|
7619
7606
|
*
|
|
7620
|
-
* @category
|
|
7607
|
+
* @category utility types
|
|
7621
7608
|
* @since 4.0.0
|
|
7622
7609
|
*/
|
|
7623
7610
|
export type ChunkIso<Value extends Constraint> = ReadonlyArray<Value["Iso"]>;
|
|
7624
7611
|
/**
|
|
7625
7612
|
* Schema for chunks whose values conform to the provided element schema.
|
|
7626
7613
|
*
|
|
7627
|
-
* @category
|
|
7614
|
+
* @category schemas
|
|
7628
7615
|
* @since 3.10.0
|
|
7629
7616
|
*/
|
|
7630
7617
|
export declare function Chunk<Value extends Constraint>(value: Value): Chunk<Value>;
|
|
@@ -7637,14 +7624,14 @@ export declare function Chunk<Value extends Constraint>(value: Value): Chunk<Val
|
|
|
7637
7624
|
*
|
|
7638
7625
|
* @see {@link Chunk} for creating the corresponding schema
|
|
7639
7626
|
*
|
|
7640
|
-
* @category
|
|
7627
|
+
* @category schemas
|
|
7641
7628
|
* @since 4.0.0
|
|
7642
7629
|
*/
|
|
7643
7630
|
export declare const ChunkReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7644
7631
|
/**
|
|
7645
7632
|
* Type-level representation of {@link RegExp}.
|
|
7646
7633
|
*
|
|
7647
|
-
* @category
|
|
7634
|
+
* @category models
|
|
7648
7635
|
* @since 4.0.0
|
|
7649
7636
|
*/
|
|
7650
7637
|
export interface RegExp extends instanceOf<globalThis.RegExp> {
|
|
@@ -7657,7 +7644,7 @@ export interface RegExp extends instanceOf<globalThis.RegExp> {
|
|
|
7657
7644
|
*
|
|
7658
7645
|
* The default JSON serializer encodes a `RegExp` as `{ source, flags }`.
|
|
7659
7646
|
*
|
|
7660
|
-
* @category
|
|
7647
|
+
* @category schemas
|
|
7661
7648
|
* @since 4.0.0
|
|
7662
7649
|
*/
|
|
7663
7650
|
export declare const RegExp: RegExp;
|
|
@@ -7670,14 +7657,14 @@ export declare const RegExp: RegExp;
|
|
|
7670
7657
|
*
|
|
7671
7658
|
* @see {@link RegExp} for the corresponding schema
|
|
7672
7659
|
*
|
|
7673
|
-
* @category
|
|
7660
|
+
* @category schemas
|
|
7674
7661
|
* @since 4.0.0
|
|
7675
7662
|
*/
|
|
7676
7663
|
export declare const RegExpReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7677
7664
|
/**
|
|
7678
7665
|
* Type-level representation of {@link URL}.
|
|
7679
7666
|
*
|
|
7680
|
-
* @category
|
|
7667
|
+
* @category models
|
|
7681
7668
|
* @since 4.0.0
|
|
7682
7669
|
*/
|
|
7683
7670
|
export interface URL extends instanceOf<globalThis.URL> {
|
|
@@ -7692,7 +7679,7 @@ export interface URL extends instanceOf<globalThis.URL> {
|
|
|
7692
7679
|
*
|
|
7693
7680
|
* - encodes `URL` as a `string`
|
|
7694
7681
|
*
|
|
7695
|
-
* @category
|
|
7682
|
+
* @category schemas
|
|
7696
7683
|
* @since 4.0.0
|
|
7697
7684
|
*/
|
|
7698
7685
|
export declare const URL: URL;
|
|
@@ -7705,14 +7692,14 @@ export declare const URL: URL;
|
|
|
7705
7692
|
*
|
|
7706
7693
|
* @see {@link URL} for the corresponding schema
|
|
7707
7694
|
*
|
|
7708
|
-
* @category
|
|
7695
|
+
* @category schemas
|
|
7709
7696
|
* @since 4.0.0
|
|
7710
7697
|
*/
|
|
7711
7698
|
export declare const URLReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7712
7699
|
/**
|
|
7713
7700
|
* Type-level representation of {@link URLFromString}.
|
|
7714
7701
|
*
|
|
7715
|
-
* @category
|
|
7702
|
+
* @category models
|
|
7716
7703
|
* @since 4.0.0
|
|
7717
7704
|
*/
|
|
7718
7705
|
export interface URLFromString extends decodeTo<URL, String> {
|
|
@@ -7729,14 +7716,14 @@ export interface URLFromString extends decodeTo<URL, String> {
|
|
|
7729
7716
|
* Encoding:
|
|
7730
7717
|
* - A `URL` is encoded as a `string`
|
|
7731
7718
|
*
|
|
7732
|
-
* @category
|
|
7719
|
+
* @category schemas
|
|
7733
7720
|
* @since 4.0.0
|
|
7734
7721
|
*/
|
|
7735
7722
|
export declare const URLFromString: URLFromString;
|
|
7736
7723
|
/**
|
|
7737
7724
|
* Type-level representation of {@link Date}.
|
|
7738
7725
|
*
|
|
7739
|
-
* @category
|
|
7726
|
+
* @category models
|
|
7740
7727
|
* @since 4.0.0
|
|
7741
7728
|
*/
|
|
7742
7729
|
export interface Date extends declare<globalThis.Date> {
|
|
@@ -7757,17 +7744,17 @@ export interface Date extends declare<globalThis.Date> {
|
|
|
7757
7744
|
*
|
|
7758
7745
|
* **Example** (Defining a Date schema)
|
|
7759
7746
|
*
|
|
7760
|
-
* ```ts
|
|
7747
|
+
* ```ts import.meta.vitest
|
|
7761
7748
|
* import { Schema } from "effect"
|
|
7762
7749
|
*
|
|
7763
|
-
* Schema.decodeUnknownSync(Schema.Date)(new Date("2024-01-01"))
|
|
7764
|
-
* // =>
|
|
7750
|
+
* const date = Schema.decodeUnknownSync(Schema.Date)(new Date("2024-01-01"))
|
|
7751
|
+
* date.toISOString() // => "2024-01-01T00:00:00.000Z"
|
|
7765
7752
|
* ```
|
|
7766
7753
|
*
|
|
7767
7754
|
* @see {@link DateFromString} for decoding strings into Date instances
|
|
7768
7755
|
* @see {@link DateFromMillis} for decoding epoch milliseconds into Date instances
|
|
7769
7756
|
*
|
|
7770
|
-
* @category
|
|
7757
|
+
* @category schemas
|
|
7771
7758
|
* @since 4.0.0
|
|
7772
7759
|
*/
|
|
7773
7760
|
export declare const Date: Date;
|
|
@@ -7780,14 +7767,14 @@ export declare const Date: Date;
|
|
|
7780
7767
|
*
|
|
7781
7768
|
* @see {@link Date} for the corresponding schema
|
|
7782
7769
|
*
|
|
7783
|
-
* @category
|
|
7770
|
+
* @category schemas
|
|
7784
7771
|
* @since 4.0.0
|
|
7785
7772
|
*/
|
|
7786
7773
|
export declare const DateReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7787
7774
|
/**
|
|
7788
7775
|
* Type-level representation of {@link DateFromString}.
|
|
7789
7776
|
*
|
|
7790
|
-
* @category
|
|
7777
|
+
* @category models
|
|
7791
7778
|
* @since 3.10.0
|
|
7792
7779
|
*/
|
|
7793
7780
|
export interface DateFromString extends decodeTo<Date, String> {
|
|
@@ -7815,14 +7802,14 @@ export interface DateFromString extends decodeTo<Date, String> {
|
|
|
7815
7802
|
* @see {@link DateTimeUtcFromString} for decoding date-time strings into UTC values
|
|
7816
7803
|
* @see {@link Date} for accepting Date instances directly
|
|
7817
7804
|
*
|
|
7818
|
-
* @category
|
|
7805
|
+
* @category schemas
|
|
7819
7806
|
* @since 3.10.0
|
|
7820
7807
|
*/
|
|
7821
7808
|
export declare const DateFromString: DateFromString;
|
|
7822
7809
|
/**
|
|
7823
7810
|
* Type-level representation of {@link DateFromMillis}.
|
|
7824
7811
|
*
|
|
7825
|
-
* @category
|
|
7812
|
+
* @category models
|
|
7826
7813
|
* @since 4.0.0
|
|
7827
7814
|
*/
|
|
7828
7815
|
export interface DateFromMillis extends decodeTo<Date, Int> {
|
|
@@ -7853,14 +7840,14 @@ export interface DateFromMillis extends decodeTo<Date, Int> {
|
|
|
7853
7840
|
* @see {@link DateFromString} for decoding string-encoded dates
|
|
7854
7841
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
7855
7842
|
*
|
|
7856
|
-
* @category
|
|
7843
|
+
* @category schemas
|
|
7857
7844
|
* @since 4.0.0
|
|
7858
7845
|
*/
|
|
7859
7846
|
export declare const DateFromMillis: DateFromMillis;
|
|
7860
7847
|
/**
|
|
7861
7848
|
* Type-level representation of {@link Duration}.
|
|
7862
7849
|
*
|
|
7863
|
-
* @category
|
|
7850
|
+
* @category models
|
|
7864
7851
|
* @since 3.10.0
|
|
7865
7852
|
*/
|
|
7866
7853
|
export interface Duration extends declare<Duration_.Duration> {
|
|
@@ -7876,14 +7863,13 @@ export interface Duration extends declare<Duration_.Duration> {
|
|
|
7876
7863
|
*
|
|
7877
7864
|
* **Example** (Defining a Duration schema)
|
|
7878
7865
|
*
|
|
7879
|
-
* ```ts
|
|
7866
|
+
* ```ts import.meta.vitest
|
|
7880
7867
|
* import { Duration, Schema } from "effect"
|
|
7881
7868
|
*
|
|
7882
|
-
* Schema.decodeUnknownSync(Schema.Duration)(Duration.seconds(5))
|
|
7883
|
-
* // => Duration(5s)
|
|
7869
|
+
* Schema.decodeUnknownSync(Schema.Duration)(Duration.seconds(5)) // => Duration.seconds(5)
|
|
7884
7870
|
* ```
|
|
7885
7871
|
*
|
|
7886
|
-
* @category
|
|
7872
|
+
* @category schemas
|
|
7887
7873
|
*
|
|
7888
7874
|
* @since 3.10.0
|
|
7889
7875
|
*/
|
|
@@ -7897,14 +7883,14 @@ export declare const Duration: Duration;
|
|
|
7897
7883
|
*
|
|
7898
7884
|
* @see {@link Duration} for the corresponding schema
|
|
7899
7885
|
*
|
|
7900
|
-
* @category
|
|
7886
|
+
* @category schemas
|
|
7901
7887
|
* @since 4.0.0
|
|
7902
7888
|
*/
|
|
7903
7889
|
export declare const DurationReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
7904
7890
|
/**
|
|
7905
7891
|
* Type-level representation of {@link DurationFromString}.
|
|
7906
7892
|
*
|
|
7907
|
-
* @category
|
|
7893
|
+
* @category models
|
|
7908
7894
|
* @since 4.0.0
|
|
7909
7895
|
*/
|
|
7910
7896
|
export interface DurationFromString extends decodeTo<Duration, String> {
|
|
@@ -7922,14 +7908,14 @@ export interface DurationFromString extends decodeTo<Duration, String> {
|
|
|
7922
7908
|
* Encoding:
|
|
7923
7909
|
* - A `Duration` is encoded as a parseable `string`.
|
|
7924
7910
|
*
|
|
7925
|
-
* @category
|
|
7911
|
+
* @category schemas
|
|
7926
7912
|
* @since 4.0.0
|
|
7927
7913
|
*/
|
|
7928
7914
|
export declare const DurationFromString: DurationFromString;
|
|
7929
7915
|
/**
|
|
7930
7916
|
* Type-level representation of {@link DurationFromNanos}.
|
|
7931
7917
|
*
|
|
7932
|
-
* @category
|
|
7918
|
+
* @category models
|
|
7933
7919
|
* @since 3.10.0
|
|
7934
7920
|
*/
|
|
7935
7921
|
export interface DurationFromNanos extends decodeTo<Duration, BigInt> {
|
|
@@ -7949,14 +7935,14 @@ export interface DurationFromNanos extends decodeTo<Duration, BigInt> {
|
|
|
7949
7935
|
* fails when the duration cannot be represented as nanoseconds, such as
|
|
7950
7936
|
* `Duration.infinity` or `Duration.negativeInfinity`.
|
|
7951
7937
|
*
|
|
7952
|
-
* @category
|
|
7938
|
+
* @category schemas
|
|
7953
7939
|
* @since 3.10.0
|
|
7954
7940
|
*/
|
|
7955
7941
|
export declare const DurationFromNanos: DurationFromNanos;
|
|
7956
7942
|
/**
|
|
7957
7943
|
* Type-level representation of {@link DurationFromMillis}.
|
|
7958
7944
|
*
|
|
7959
|
-
* @category
|
|
7945
|
+
* @category models
|
|
7960
7946
|
* @since 3.10.0
|
|
7961
7947
|
*/
|
|
7962
7948
|
export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
@@ -7978,14 +7964,14 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
|
7978
7964
|
*
|
|
7979
7965
|
* `NaN` is decoded as `Duration.zero`, matching `Duration.millis`.
|
|
7980
7966
|
*
|
|
7981
|
-
* @category
|
|
7967
|
+
* @category schemas
|
|
7982
7968
|
* @since 3.10.0
|
|
7983
7969
|
*/
|
|
7984
7970
|
export declare const DurationFromMillis: DurationFromMillis;
|
|
7985
7971
|
/**
|
|
7986
7972
|
* Type-level representation of {@link BigDecimal}.
|
|
7987
7973
|
*
|
|
7988
|
-
* @category
|
|
7974
|
+
* @category models
|
|
7989
7975
|
* @since 3.10.0
|
|
7990
7976
|
*/
|
|
7991
7977
|
export interface BigDecimal extends declare<BigDecimal_.BigDecimal> {
|
|
@@ -8007,7 +7993,7 @@ export interface BigDecimal extends declare<BigDecimal_.BigDecimal> {
|
|
|
8007
7993
|
*
|
|
8008
7994
|
* @see {@link BigDecimalFromString} for parsing string input into a BigDecimal
|
|
8009
7995
|
*
|
|
8010
|
-
* @category
|
|
7996
|
+
* @category schemas
|
|
8011
7997
|
* @since 3.10.0
|
|
8012
7998
|
*/
|
|
8013
7999
|
export declare const BigDecimal: BigDecimal;
|
|
@@ -8020,14 +8006,14 @@ export declare const BigDecimal: BigDecimal;
|
|
|
8020
8006
|
*
|
|
8021
8007
|
* @see {@link BigDecimal} for the corresponding schema
|
|
8022
8008
|
*
|
|
8023
|
-
* @category
|
|
8009
|
+
* @category schemas
|
|
8024
8010
|
* @since 4.0.0
|
|
8025
8011
|
*/
|
|
8026
8012
|
export declare const BigDecimalReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8027
8013
|
/**
|
|
8028
8014
|
* Type-level representation of {@link BigDecimalFromString}.
|
|
8029
8015
|
*
|
|
8030
|
-
* @category
|
|
8016
|
+
* @category models
|
|
8031
8017
|
* @since 4.0.0
|
|
8032
8018
|
*/
|
|
8033
8019
|
export interface BigDecimalFromString extends decodeTo<BigDecimal, String> {
|
|
@@ -8057,45 +8043,10 @@ export interface BigDecimalFromString extends decodeTo<BigDecimal, String> {
|
|
|
8057
8043
|
* @see {@link BigIntFromString} for parsing base-10 integer strings into bigint values
|
|
8058
8044
|
* @see {@link NumberFromString} for parsing JavaScript number strings
|
|
8059
8045
|
*
|
|
8060
|
-
* @category BigDecimal
|
|
8061
|
-
* @since 4.0.0
|
|
8062
|
-
*/
|
|
8063
|
-
export declare const BigDecimalFromString: BigDecimalFromString;
|
|
8064
|
-
/**
|
|
8065
|
-
* Type-level representation of {@link UnknownFromJsonString}.
|
|
8066
|
-
*
|
|
8067
|
-
* @category models
|
|
8068
|
-
* @since 4.0.0
|
|
8069
|
-
*/
|
|
8070
|
-
export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
8071
|
-
readonly "Rebuild": UnknownFromJsonString;
|
|
8072
|
-
}
|
|
8073
|
-
/**
|
|
8074
|
-
* Schema that decodes a JSON-encoded string into an `unknown` value.
|
|
8075
|
-
*
|
|
8076
|
-
* **Details**
|
|
8077
|
-
*
|
|
8078
|
-
* Decoding:
|
|
8079
|
-
* - A `string` is decoded as an `unknown` value.
|
|
8080
|
-
* - If the string is not valid JSON, decoding fails.
|
|
8081
|
-
*
|
|
8082
|
-
* Encoding:
|
|
8083
|
-
* - Any value is encoded as a JSON string using `JSON.stringify`.
|
|
8084
|
-
* - If the value is not a valid JSON value, encoding fails.
|
|
8085
|
-
*
|
|
8086
|
-
* **Example** (Decoding unknown JSON strings)
|
|
8087
|
-
*
|
|
8088
|
-
* ```ts
|
|
8089
|
-
* import { Schema } from "effect"
|
|
8090
|
-
*
|
|
8091
|
-
* Schema.decodeUnknownSync(Schema.UnknownFromJsonString)(`{"a":1,"b":2}`)
|
|
8092
|
-
* // => { a: 1, b: 2 }
|
|
8093
|
-
* ```
|
|
8094
|
-
*
|
|
8095
8046
|
* @category schemas
|
|
8096
8047
|
* @since 4.0.0
|
|
8097
8048
|
*/
|
|
8098
|
-
export declare const
|
|
8049
|
+
export declare const BigDecimalFromString: BigDecimalFromString;
|
|
8099
8050
|
/**
|
|
8100
8051
|
* Type-level representation returned by {@link fromJsonString}.
|
|
8101
8052
|
*
|
|
@@ -8114,29 +8065,35 @@ export interface fromJsonString<S extends Constraint> extends decodeTo<S, String
|
|
|
8114
8065
|
* This is useful when working with JSON-encoded strings where the actual
|
|
8115
8066
|
* structure of the value is known and described by an existing schema.
|
|
8116
8067
|
*
|
|
8117
|
-
*
|
|
8118
|
-
* provided schema on the
|
|
8068
|
+
* During decoding, the resulting schema first parses the input string as JSON,
|
|
8069
|
+
* using `reviver` when provided, and then runs the provided schema on the
|
|
8070
|
+
* parsed result. During encoding, it first encodes with the provided schema and
|
|
8071
|
+
* then passes the result to `JSON.stringify` with the optional `replacer` and
|
|
8072
|
+
* `space`.
|
|
8119
8073
|
*
|
|
8120
|
-
* **Example** (
|
|
8074
|
+
* **Example** (Formatting encoded JSON)
|
|
8121
8075
|
*
|
|
8122
|
-
* ```ts
|
|
8076
|
+
* ```ts import.meta.vitest
|
|
8123
8077
|
* import { Schema } from "effect"
|
|
8124
8078
|
*
|
|
8125
8079
|
* const schema = Schema.Struct({ a: Schema.Number })
|
|
8126
|
-
* const schemaFromJsonString = Schema.fromJsonString(schema)
|
|
8080
|
+
* const schemaFromJsonString = Schema.fromJsonString(schema, { space: 2 })
|
|
8127
8081
|
*
|
|
8128
|
-
* Schema.
|
|
8129
|
-
* // => { a: 1 }
|
|
8082
|
+
* Schema.encodeSync(schemaFromJsonString)({ a: 1 }) // => "{\n \"a\": 1\n}"
|
|
8130
8083
|
* ```
|
|
8131
8084
|
*
|
|
8132
|
-
* @category
|
|
8085
|
+
* @category schemas
|
|
8133
8086
|
* @since 4.0.0
|
|
8134
8087
|
*/
|
|
8135
|
-
export declare function fromJsonString<S extends Constraint>(schema: S
|
|
8088
|
+
export declare function fromJsonString<S extends Constraint>(schema: S, options?: {
|
|
8089
|
+
readonly reviver?: Parameters<typeof JSON.parse>[1] | undefined;
|
|
8090
|
+
readonly replacer?: SchemaGetter.JsonReplacer | undefined;
|
|
8091
|
+
readonly space?: Parameters<typeof JSON.stringify>[2] | undefined;
|
|
8092
|
+
}): fromJsonString<S>;
|
|
8136
8093
|
/**
|
|
8137
8094
|
* Type-level representation of {@link File}.
|
|
8138
8095
|
*
|
|
8139
|
-
* @category
|
|
8096
|
+
* @category models
|
|
8140
8097
|
* @since 4.0.0
|
|
8141
8098
|
*/
|
|
8142
8099
|
export interface File extends instanceOf<globalThis.File> {
|
|
@@ -8150,7 +8107,7 @@ export interface File extends instanceOf<globalThis.File> {
|
|
|
8150
8107
|
* The default JSON serializer encodes a `File` as `{ data, type, name, lastModified }`
|
|
8151
8108
|
* where `data` is base64-encoded.
|
|
8152
8109
|
*
|
|
8153
|
-
* @category
|
|
8110
|
+
* @category schemas
|
|
8154
8111
|
* @since 4.0.0
|
|
8155
8112
|
*/
|
|
8156
8113
|
export declare const File: File;
|
|
@@ -8163,14 +8120,14 @@ export declare const File: File;
|
|
|
8163
8120
|
*
|
|
8164
8121
|
* @see {@link File} for the corresponding schema
|
|
8165
8122
|
*
|
|
8166
|
-
* @category
|
|
8123
|
+
* @category schemas
|
|
8167
8124
|
* @since 4.0.0
|
|
8168
8125
|
*/
|
|
8169
8126
|
export declare const FileReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8170
8127
|
/**
|
|
8171
8128
|
* Type-level representation of {@link FormData}.
|
|
8172
8129
|
*
|
|
8173
|
-
* @category
|
|
8130
|
+
* @category models
|
|
8174
8131
|
* @since 4.0.0
|
|
8175
8132
|
*/
|
|
8176
8133
|
export interface FormData extends instanceOf<globalThis.FormData> {
|
|
@@ -8184,7 +8141,7 @@ export interface FormData extends instanceOf<globalThis.FormData> {
|
|
|
8184
8141
|
* The default JSON serializer encodes a `FormData` as an array of `[key, entry]`
|
|
8185
8142
|
* pairs where each entry is tagged as `"String"` or `"File"`.
|
|
8186
8143
|
*
|
|
8187
|
-
* @category
|
|
8144
|
+
* @category schemas
|
|
8188
8145
|
* @since 4.0.0
|
|
8189
8146
|
*/
|
|
8190
8147
|
export declare const FormData: FormData;
|
|
@@ -8197,14 +8154,14 @@ export declare const FormData: FormData;
|
|
|
8197
8154
|
*
|
|
8198
8155
|
* @see {@link FormData} for the corresponding schema
|
|
8199
8156
|
*
|
|
8200
|
-
* @category
|
|
8157
|
+
* @category schemas
|
|
8201
8158
|
* @since 4.0.0
|
|
8202
8159
|
*/
|
|
8203
8160
|
export declare const FormDataReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8204
8161
|
/**
|
|
8205
8162
|
* Type-level representation returned by {@link fromFormData}.
|
|
8206
8163
|
*
|
|
8207
|
-
* @category
|
|
8164
|
+
* @category models
|
|
8208
8165
|
* @since 4.0.0
|
|
8209
8166
|
*/
|
|
8210
8167
|
export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData> {
|
|
@@ -8231,7 +8188,7 @@ export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData
|
|
|
8231
8188
|
*
|
|
8232
8189
|
* **Example** (Decoding a flat structure)
|
|
8233
8190
|
*
|
|
8234
|
-
* ```ts
|
|
8191
|
+
* ```ts import.meta.vitest
|
|
8235
8192
|
* import { Schema } from "effect"
|
|
8236
8193
|
*
|
|
8237
8194
|
* const schema = Schema.fromFormData(
|
|
@@ -8244,13 +8201,12 @@ export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData
|
|
|
8244
8201
|
* formData.append("a", "1")
|
|
8245
8202
|
* formData.append("b", "2")
|
|
8246
8203
|
*
|
|
8247
|
-
*
|
|
8248
|
-
* // Success({"a":"1"})
|
|
8204
|
+
* Schema.decodeUnknownSync(schema)(formData) // => { a: "1" }
|
|
8249
8205
|
* ```
|
|
8250
8206
|
*
|
|
8251
8207
|
* **Example** (Decoding nested fields)
|
|
8252
8208
|
*
|
|
8253
|
-
* ```ts
|
|
8209
|
+
* ```ts import.meta.vitest
|
|
8254
8210
|
* import { Schema } from "effect"
|
|
8255
8211
|
*
|
|
8256
8212
|
* const schema = Schema.fromFormData(
|
|
@@ -8268,13 +8224,12 @@ export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData
|
|
|
8268
8224
|
* formData.append("b[c]", "2")
|
|
8269
8225
|
* formData.append("b[d]", "3")
|
|
8270
8226
|
*
|
|
8271
|
-
*
|
|
8272
|
-
* // Success({"a":"1","b":{"c":"2","d":"3"}})
|
|
8227
|
+
* Schema.decodeUnknownSync(schema)(formData) // => { a: "1", b: { c: "2", d: "3" } }
|
|
8273
8228
|
* ```
|
|
8274
8229
|
*
|
|
8275
8230
|
* **Example** (Parsing non-string values)
|
|
8276
8231
|
*
|
|
8277
|
-
* ```ts
|
|
8232
|
+
* ```ts import.meta.vitest
|
|
8278
8233
|
* import { Schema } from "effect"
|
|
8279
8234
|
*
|
|
8280
8235
|
* const schema = Schema.fromFormData(
|
|
@@ -8288,8 +8243,7 @@ export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData
|
|
|
8288
8243
|
* const formData = new FormData()
|
|
8289
8244
|
* formData.append("a", "1")
|
|
8290
8245
|
*
|
|
8291
|
-
*
|
|
8292
|
-
* // Success({"a":1}) // Note: the value is a number
|
|
8246
|
+
* Schema.decodeUnknownSync(schema)(formData) // => { a: 1 }
|
|
8293
8247
|
* ```
|
|
8294
8248
|
*
|
|
8295
8249
|
* @category decoding
|
|
@@ -8299,7 +8253,7 @@ export declare function fromFormData<S extends Constraint>(schema: S): fromFormD
|
|
|
8299
8253
|
/**
|
|
8300
8254
|
* Type-level representation of {@link URLSearchParams}.
|
|
8301
8255
|
*
|
|
8302
|
-
* @category
|
|
8256
|
+
* @category models
|
|
8303
8257
|
* @since 4.0.0
|
|
8304
8258
|
*/
|
|
8305
8259
|
export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams> {
|
|
@@ -8312,7 +8266,7 @@ export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams>
|
|
|
8312
8266
|
*
|
|
8313
8267
|
* The default JSON serializer encodes a `URLSearchParams` as a query string.
|
|
8314
8268
|
*
|
|
8315
|
-
* @category
|
|
8269
|
+
* @category schemas
|
|
8316
8270
|
* @since 4.0.0
|
|
8317
8271
|
*/
|
|
8318
8272
|
export declare const URLSearchParams: URLSearchParams;
|
|
@@ -8325,14 +8279,14 @@ export declare const URLSearchParams: URLSearchParams;
|
|
|
8325
8279
|
*
|
|
8326
8280
|
* @see {@link URLSearchParams} for the corresponding schema
|
|
8327
8281
|
*
|
|
8328
|
-
* @category
|
|
8282
|
+
* @category schemas
|
|
8329
8283
|
* @since 4.0.0
|
|
8330
8284
|
*/
|
|
8331
8285
|
export declare const URLSearchParamsReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8332
8286
|
/**
|
|
8333
8287
|
* Type-level representation returned by {@link fromURLSearchParams}.
|
|
8334
8288
|
*
|
|
8335
|
-
* @category
|
|
8289
|
+
* @category models
|
|
8336
8290
|
* @since 4.0.0
|
|
8337
8291
|
*/
|
|
8338
8292
|
export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, URLSearchParams> {
|
|
@@ -8360,7 +8314,7 @@ export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, U
|
|
|
8360
8314
|
*
|
|
8361
8315
|
* **Example** (Decoding a flat structure)
|
|
8362
8316
|
*
|
|
8363
|
-
* ```ts
|
|
8317
|
+
* ```ts import.meta.vitest
|
|
8364
8318
|
* import { Schema } from "effect"
|
|
8365
8319
|
*
|
|
8366
8320
|
* const schema = Schema.fromURLSearchParams(
|
|
@@ -8371,13 +8325,12 @@ export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, U
|
|
|
8371
8325
|
*
|
|
8372
8326
|
* const urlSearchParams = new URLSearchParams("a=1&b=2")
|
|
8373
8327
|
*
|
|
8374
|
-
*
|
|
8375
|
-
* // Success({"a":"1"})
|
|
8328
|
+
* Schema.decodeUnknownSync(schema)(urlSearchParams) // => { a: "1" }
|
|
8376
8329
|
* ```
|
|
8377
8330
|
*
|
|
8378
8331
|
* **Example** (Decoding nested fields)
|
|
8379
8332
|
*
|
|
8380
|
-
* ```ts
|
|
8333
|
+
* ```ts import.meta.vitest
|
|
8381
8334
|
* import { Schema } from "effect"
|
|
8382
8335
|
*
|
|
8383
8336
|
* const schema = Schema.fromURLSearchParams(
|
|
@@ -8392,13 +8345,12 @@ export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, U
|
|
|
8392
8345
|
*
|
|
8393
8346
|
* const urlSearchParams = new URLSearchParams("a=1&b[c]=2&b[d]=3")
|
|
8394
8347
|
*
|
|
8395
|
-
*
|
|
8396
|
-
* // Success({"a":"1","b":{"c":"2","d":"3"}})
|
|
8348
|
+
* Schema.decodeUnknownSync(schema)(urlSearchParams) // => { a: "1", b: { c: "2", d: "3" } }
|
|
8397
8349
|
* ```
|
|
8398
8350
|
*
|
|
8399
8351
|
* **Example** (Parsing non-string values)
|
|
8400
8352
|
*
|
|
8401
|
-
* ```ts
|
|
8353
|
+
* ```ts import.meta.vitest
|
|
8402
8354
|
* import { Schema } from "effect"
|
|
8403
8355
|
*
|
|
8404
8356
|
* const schema = Schema.fromURLSearchParams(
|
|
@@ -8411,8 +8363,7 @@ export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, U
|
|
|
8411
8363
|
*
|
|
8412
8364
|
* const urlSearchParams = new URLSearchParams("a=1&b=2")
|
|
8413
8365
|
*
|
|
8414
|
-
*
|
|
8415
|
-
* // Success({"a":1}) // Note: the value is a number
|
|
8366
|
+
* Schema.decodeUnknownSync(schema)(urlSearchParams) // => { a: 1 }
|
|
8416
8367
|
* ```
|
|
8417
8368
|
*
|
|
8418
8369
|
* @category decoding
|
|
@@ -8422,7 +8373,7 @@ export declare function fromURLSearchParams<S extends Constraint>(schema: S): fr
|
|
|
8422
8373
|
/**
|
|
8423
8374
|
* Type-level representation of {@link NumberFromString}.
|
|
8424
8375
|
*
|
|
8425
|
-
* @category
|
|
8376
|
+
* @category models
|
|
8426
8377
|
* @since 3.10.0
|
|
8427
8378
|
*/
|
|
8428
8379
|
export interface NumberFromString extends decodeTo<Number, String> {
|
|
@@ -8442,14 +8393,14 @@ export interface NumberFromString extends decodeTo<Number, String> {
|
|
|
8442
8393
|
* Encoding:
|
|
8443
8394
|
* A number is encoded as a `string`.
|
|
8444
8395
|
*
|
|
8445
|
-
* @category
|
|
8396
|
+
* @category schemas
|
|
8446
8397
|
* @since 3.10.0
|
|
8447
8398
|
*/
|
|
8448
8399
|
export declare const NumberFromString: NumberFromString;
|
|
8449
8400
|
/**
|
|
8450
8401
|
* Type-level representation of {@link FiniteFromString}.
|
|
8451
8402
|
*
|
|
8452
|
-
* @category
|
|
8403
|
+
* @category models
|
|
8453
8404
|
* @since 4.0.0
|
|
8454
8405
|
*/
|
|
8455
8406
|
export interface FiniteFromString extends decodeTo<Finite, String> {
|
|
@@ -8467,14 +8418,14 @@ export interface FiniteFromString extends decodeTo<Finite, String> {
|
|
|
8467
8418
|
* Encoding:
|
|
8468
8419
|
* - A finite number is encoded as a `string`.
|
|
8469
8420
|
*
|
|
8470
|
-
* @category
|
|
8421
|
+
* @category schemas
|
|
8471
8422
|
* @since 4.0.0
|
|
8472
8423
|
*/
|
|
8473
8424
|
export declare const FiniteFromString: FiniteFromString;
|
|
8474
8425
|
/**
|
|
8475
8426
|
* Type-level representation of {@link BigIntFromString}.
|
|
8476
8427
|
*
|
|
8477
|
-
* @category
|
|
8428
|
+
* @category models
|
|
8478
8429
|
* @since 4.0.0
|
|
8479
8430
|
*/
|
|
8480
8431
|
export interface BigIntFromString extends decodeTo<BigInt, String> {
|
|
@@ -8505,14 +8456,14 @@ export interface BigIntFromString extends decodeTo<BigInt, String> {
|
|
|
8505
8456
|
* @see {@link NumberFromString} for parsing JavaScript number strings, including non-finite values
|
|
8506
8457
|
* @see {@link BigDecimalFromString} for parsing decimal number strings
|
|
8507
8458
|
*
|
|
8508
|
-
* @category
|
|
8459
|
+
* @category schemas
|
|
8509
8460
|
* @since 4.0.0
|
|
8510
8461
|
*/
|
|
8511
8462
|
export declare const BigIntFromString: BigIntFromString;
|
|
8512
8463
|
/**
|
|
8513
8464
|
* Type-level representation of {@link Trimmed}.
|
|
8514
8465
|
*
|
|
8515
|
-
* @category
|
|
8466
|
+
* @category models
|
|
8516
8467
|
* @since 3.10.0
|
|
8517
8468
|
*/
|
|
8518
8469
|
export interface Trimmed extends String {
|
|
@@ -8521,14 +8472,14 @@ export interface Trimmed extends String {
|
|
|
8521
8472
|
/**
|
|
8522
8473
|
* Schema for strings that contains no leading or trailing whitespaces.
|
|
8523
8474
|
*
|
|
8524
|
-
* @category
|
|
8475
|
+
* @category schemas
|
|
8525
8476
|
* @since 3.10.0
|
|
8526
8477
|
*/
|
|
8527
8478
|
export declare const Trimmed: Trimmed;
|
|
8528
8479
|
/**
|
|
8529
8480
|
* Type-level representation of {@link Trim}.
|
|
8530
8481
|
*
|
|
8531
|
-
* @category
|
|
8482
|
+
* @category models
|
|
8532
8483
|
* @since 3.10.0
|
|
8533
8484
|
*/
|
|
8534
8485
|
export interface Trim extends decodeTo<Trimmed, String> {
|
|
@@ -8545,14 +8496,14 @@ export interface Trim extends decodeTo<Trimmed, String> {
|
|
|
8545
8496
|
* Encoding:
|
|
8546
8497
|
* - The trimmed string is encoded as is.
|
|
8547
8498
|
*
|
|
8548
|
-
* @category
|
|
8499
|
+
* @category schemas
|
|
8549
8500
|
* @since 3.10.0
|
|
8550
8501
|
*/
|
|
8551
8502
|
export declare const Trim: Trim;
|
|
8552
8503
|
/**
|
|
8553
8504
|
* Type-level representation of {@link StringFromBase64}.
|
|
8554
8505
|
*
|
|
8555
|
-
* @category
|
|
8506
|
+
* @category models
|
|
8556
8507
|
* @since 3.10.0
|
|
8557
8508
|
*/
|
|
8558
8509
|
export interface StringFromBase64 extends decodeTo<String, String> {
|
|
@@ -8569,14 +8520,14 @@ export interface StringFromBase64 extends decodeTo<String, String> {
|
|
|
8569
8520
|
* Encoding:
|
|
8570
8521
|
* - A `string` is encoded as a base64-encoded string.
|
|
8571
8522
|
*
|
|
8572
|
-
* @category
|
|
8523
|
+
* @category schemas
|
|
8573
8524
|
* @since 3.10.0
|
|
8574
8525
|
*/
|
|
8575
8526
|
export declare const StringFromBase64: StringFromBase64;
|
|
8576
8527
|
/**
|
|
8577
8528
|
* Type-level representation of {@link StringFromBase64Url}.
|
|
8578
8529
|
*
|
|
8579
|
-
* @category
|
|
8530
|
+
* @category models
|
|
8580
8531
|
* @since 3.10.0
|
|
8581
8532
|
*/
|
|
8582
8533
|
export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
@@ -8593,14 +8544,14 @@ export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
|
8593
8544
|
* Encoding:
|
|
8594
8545
|
* - A `string` is encoded as a base64 (URL) encoded string.
|
|
8595
8546
|
*
|
|
8596
|
-
* @category
|
|
8547
|
+
* @category schemas
|
|
8597
8548
|
* @since 3.10.0
|
|
8598
8549
|
*/
|
|
8599
8550
|
export declare const StringFromBase64Url: StringFromBase64Url;
|
|
8600
8551
|
/**
|
|
8601
8552
|
* Type-level representation of {@link StringFromHex}.
|
|
8602
8553
|
*
|
|
8603
|
-
* @category
|
|
8554
|
+
* @category models
|
|
8604
8555
|
* @since 3.10.0
|
|
8605
8556
|
*/
|
|
8606
8557
|
export interface StringFromHex extends decodeTo<String, String> {
|
|
@@ -8617,14 +8568,14 @@ export interface StringFromHex extends decodeTo<String, String> {
|
|
|
8617
8568
|
* Encoding:
|
|
8618
8569
|
* - A `string` is encoded as a hex string.
|
|
8619
8570
|
*
|
|
8620
|
-
* @category
|
|
8571
|
+
* @category schemas
|
|
8621
8572
|
* @since 3.10.0
|
|
8622
8573
|
*/
|
|
8623
8574
|
export declare const StringFromHex: StringFromHex;
|
|
8624
8575
|
/**
|
|
8625
8576
|
* Type-level representation of {@link StringFromUriComponent}.
|
|
8626
8577
|
*
|
|
8627
|
-
* @category
|
|
8578
|
+
* @category models
|
|
8628
8579
|
* @since 3.12.0
|
|
8629
8580
|
*/
|
|
8630
8581
|
export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
@@ -8644,7 +8595,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
8644
8595
|
*
|
|
8645
8596
|
* **Example** (Decoding URI component strings)
|
|
8646
8597
|
*
|
|
8647
|
-
* ```ts
|
|
8598
|
+
* ```ts import.meta.vitest
|
|
8648
8599
|
* import { Schema } from "effect"
|
|
8649
8600
|
*
|
|
8650
8601
|
* const PaginationSchema = Schema.Struct({
|
|
@@ -8656,11 +8607,10 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
8656
8607
|
* Schema.decodeTo(Schema.fromJsonString(PaginationSchema))
|
|
8657
8608
|
* )
|
|
8658
8609
|
*
|
|
8659
|
-
*
|
|
8660
|
-
* // %7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D
|
|
8610
|
+
* Schema.encodeSync(UrlSchema)({ maxItemPerPage: 10, page: 1 }) // => "%7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D"
|
|
8661
8611
|
* ```
|
|
8662
8612
|
*
|
|
8663
|
-
* @category
|
|
8613
|
+
* @category schemas
|
|
8664
8614
|
* @since 3.12.0
|
|
8665
8615
|
*/
|
|
8666
8616
|
export declare const StringFromUriComponent: StringFromUriComponent;
|
|
@@ -8668,7 +8618,7 @@ export declare const StringFromUriComponent: StringFromUriComponent;
|
|
|
8668
8618
|
* Schema for property keys accepted by Effect schemas: finite `number`,
|
|
8669
8619
|
* `symbol`, or `string`.
|
|
8670
8620
|
*
|
|
8671
|
-
* @category
|
|
8621
|
+
* @category schemas
|
|
8672
8622
|
* @since 4.0.0
|
|
8673
8623
|
*/
|
|
8674
8624
|
export declare const PropertyKey: Union<readonly [Finite, Symbol, String]>;
|
|
@@ -8680,7 +8630,7 @@ export declare const PropertyKey: Union<readonly [Finite, Symbol, String]>;
|
|
|
8680
8630
|
* The result contains an `issues` array where each issue has a message and an
|
|
8681
8631
|
* optional path made of property keys or keyed path segments.
|
|
8682
8632
|
*
|
|
8683
|
-
* @category
|
|
8633
|
+
* @category schemas
|
|
8684
8634
|
* @since 4.0.0
|
|
8685
8635
|
*/
|
|
8686
8636
|
export declare const StandardSchemaV1FailureResult: Struct<{
|
|
@@ -8694,7 +8644,7 @@ export declare const StandardSchemaV1FailureResult: Struct<{
|
|
|
8694
8644
|
/**
|
|
8695
8645
|
* Type-level representation of {@link BooleanFromBit}.
|
|
8696
8646
|
*
|
|
8697
|
-
* @category
|
|
8647
|
+
* @category models
|
|
8698
8648
|
* @since 4.0.0
|
|
8699
8649
|
*/
|
|
8700
8650
|
export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0, 1]>> {
|
|
@@ -8716,14 +8666,14 @@ export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0,
|
|
|
8716
8666
|
* @see {@link Boolean} for validating values that are already booleans
|
|
8717
8667
|
* @see {@link Literals} for keeping bit literals instead of decoding them
|
|
8718
8668
|
*
|
|
8719
|
-
* @category
|
|
8669
|
+
* @category schemas
|
|
8720
8670
|
* @since 4.0.0
|
|
8721
8671
|
*/
|
|
8722
8672
|
export declare const BooleanFromBit: BooleanFromBit;
|
|
8723
8673
|
/**
|
|
8724
8674
|
* Type-level representation of {@link Uint8Array}.
|
|
8725
8675
|
*
|
|
8726
|
-
* @category
|
|
8676
|
+
* @category models
|
|
8727
8677
|
* @since 4.0.0
|
|
8728
8678
|
*/
|
|
8729
8679
|
export interface Uint8Array extends instanceOf<globalThis.Uint8Array<ArrayBufferLike>> {
|
|
@@ -8738,7 +8688,7 @@ export interface Uint8Array extends instanceOf<globalThis.Uint8Array<ArrayBuffer
|
|
|
8738
8688
|
*
|
|
8739
8689
|
* The default JSON serializer encodes Uint8Array as a Base64 encoded string.
|
|
8740
8690
|
*
|
|
8741
|
-
* @category
|
|
8691
|
+
* @category schemas
|
|
8742
8692
|
* @since 4.0.0
|
|
8743
8693
|
*/
|
|
8744
8694
|
export declare const Uint8Array: Uint8Array;
|
|
@@ -8751,14 +8701,14 @@ export declare const Uint8Array: Uint8Array;
|
|
|
8751
8701
|
*
|
|
8752
8702
|
* @see {@link Uint8Array} for the corresponding schema
|
|
8753
8703
|
*
|
|
8754
|
-
* @category
|
|
8704
|
+
* @category schemas
|
|
8755
8705
|
* @since 4.0.0
|
|
8756
8706
|
*/
|
|
8757
8707
|
export declare const Uint8ArrayReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8758
8708
|
/**
|
|
8759
8709
|
* Type-level representation of {@link Uint8ArrayFromBase64}.
|
|
8760
8710
|
*
|
|
8761
|
-
* @category
|
|
8711
|
+
* @category models
|
|
8762
8712
|
* @since 3.10.0
|
|
8763
8713
|
*/
|
|
8764
8714
|
export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
@@ -8776,14 +8726,14 @@ export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
|
8776
8726
|
* Encoding:
|
|
8777
8727
|
* - A `Uint8Array` is encoded as a base64-encoded string.
|
|
8778
8728
|
*
|
|
8779
|
-
* @category
|
|
8729
|
+
* @category schemas
|
|
8780
8730
|
* @since 3.10.0
|
|
8781
8731
|
*/
|
|
8782
8732
|
export declare const Uint8ArrayFromBase64: Uint8ArrayFromBase64;
|
|
8783
8733
|
/**
|
|
8784
8734
|
* Type-level representation of {@link Uint8ArrayFromBase64Url}.
|
|
8785
8735
|
*
|
|
8786
|
-
* @category
|
|
8736
|
+
* @category models
|
|
8787
8737
|
* @since 3.10.0
|
|
8788
8738
|
*/
|
|
8789
8739
|
export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
@@ -8801,14 +8751,14 @@ export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
|
8801
8751
|
* Encoding:
|
|
8802
8752
|
* - A `Uint8Array` is encoded as a base64 (URL) encoded string.
|
|
8803
8753
|
*
|
|
8804
|
-
* @category
|
|
8754
|
+
* @category schemas
|
|
8805
8755
|
* @since 3.10.0
|
|
8806
8756
|
*/
|
|
8807
8757
|
export declare const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url;
|
|
8808
8758
|
/**
|
|
8809
8759
|
* Type-level representation of {@link Uint8ArrayFromHex}.
|
|
8810
8760
|
*
|
|
8811
|
-
* @category
|
|
8761
|
+
* @category models
|
|
8812
8762
|
* @since 3.10.0
|
|
8813
8763
|
*/
|
|
8814
8764
|
export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
@@ -8826,14 +8776,14 @@ export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
|
8826
8776
|
* Encoding:
|
|
8827
8777
|
* - A `Uint8Array` is encoded as a hex encoded string.
|
|
8828
8778
|
*
|
|
8829
|
-
* @category
|
|
8779
|
+
* @category schemas
|
|
8830
8780
|
* @since 3.10.0
|
|
8831
8781
|
*/
|
|
8832
8782
|
export declare const Uint8ArrayFromHex: Uint8ArrayFromHex;
|
|
8833
8783
|
/**
|
|
8834
8784
|
* Type-level representation of {@link DateTimeUtc}.
|
|
8835
8785
|
*
|
|
8836
|
-
* @category
|
|
8786
|
+
* @category models
|
|
8837
8787
|
* @since 3.10.0
|
|
8838
8788
|
*/
|
|
8839
8789
|
export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
@@ -8857,7 +8807,7 @@ export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
|
8857
8807
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
8858
8808
|
* @see {@link DateTimeZoned} for preserving zoned DateTime values
|
|
8859
8809
|
*
|
|
8860
|
-
* @category
|
|
8810
|
+
* @category schemas
|
|
8861
8811
|
* @since 3.10.0
|
|
8862
8812
|
*/
|
|
8863
8813
|
export declare const DateTimeUtc: DateTimeUtc;
|
|
@@ -8870,14 +8820,14 @@ export declare const DateTimeUtc: DateTimeUtc;
|
|
|
8870
8820
|
*
|
|
8871
8821
|
* @see {@link DateTimeUtc} for the corresponding schema
|
|
8872
8822
|
*
|
|
8873
|
-
* @category
|
|
8823
|
+
* @category schemas
|
|
8874
8824
|
* @since 4.0.0
|
|
8875
8825
|
*/
|
|
8876
8826
|
export declare const DateTimeUtcReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
8877
8827
|
/**
|
|
8878
8828
|
* Type-level representation of {@link DateTimeUtcFromDate}.
|
|
8879
8829
|
*
|
|
8880
|
-
* @category
|
|
8830
|
+
* @category models
|
|
8881
8831
|
* @since 3.12.0
|
|
8882
8832
|
*/
|
|
8883
8833
|
export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
@@ -8904,14 +8854,14 @@ export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
|
8904
8854
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
8905
8855
|
* @see {@link Date} for validating Date instances without converting them
|
|
8906
8856
|
*
|
|
8907
|
-
* @category
|
|
8857
|
+
* @category schemas
|
|
8908
8858
|
* @since 3.12.0
|
|
8909
8859
|
*/
|
|
8910
8860
|
export declare const DateTimeUtcFromDate: DateTimeUtcFromDate;
|
|
8911
8861
|
/**
|
|
8912
8862
|
* Type-level representation of {@link DateTimeUtcFromString}.
|
|
8913
8863
|
*
|
|
8914
|
-
* @category
|
|
8864
|
+
* @category models
|
|
8915
8865
|
* @since 4.0.0
|
|
8916
8866
|
*/
|
|
8917
8867
|
export interface DateTimeUtcFromString extends decodeTo<DateTimeUtc, String> {
|
|
@@ -8935,14 +8885,14 @@ export interface DateTimeUtcFromString extends decodeTo<DateTimeUtc, String> {
|
|
|
8935
8885
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
8936
8886
|
* @see {@link DateFromString} for decoding strings into JavaScript Date instances
|
|
8937
8887
|
*
|
|
8938
|
-
* @category
|
|
8888
|
+
* @category schemas
|
|
8939
8889
|
* @since 4.0.0
|
|
8940
8890
|
*/
|
|
8941
8891
|
export declare const DateTimeUtcFromString: DateTimeUtcFromString;
|
|
8942
8892
|
/**
|
|
8943
8893
|
* Type-level representation of {@link DateTimeUtcFromMillis}.
|
|
8944
8894
|
*
|
|
8945
|
-
* @category
|
|
8895
|
+
* @category models
|
|
8946
8896
|
* @since 4.0.0
|
|
8947
8897
|
*/
|
|
8948
8898
|
export interface DateTimeUtcFromMillis extends decodeTo<instanceOf<DateTime.Utc>, Int> {
|
|
@@ -8963,14 +8913,14 @@ export interface DateTimeUtcFromMillis extends decodeTo<instanceOf<DateTime.Utc>
|
|
|
8963
8913
|
* @see {@link DateTimeUtcFromString} for decoding date-time strings into UTC values
|
|
8964
8914
|
* @see {@link DateFromMillis} for decoding epoch milliseconds into JavaScript Date instances
|
|
8965
8915
|
*
|
|
8966
|
-
* @category
|
|
8916
|
+
* @category schemas
|
|
8967
8917
|
* @since 4.0.0
|
|
8968
8918
|
*/
|
|
8969
8919
|
export declare const DateTimeUtcFromMillis: DateTimeUtcFromMillis;
|
|
8970
8920
|
/**
|
|
8971
8921
|
* Type-level representation of {@link TimeZoneOffset}.
|
|
8972
8922
|
*
|
|
8973
|
-
* @category
|
|
8923
|
+
* @category models
|
|
8974
8924
|
* @since 3.10.0
|
|
8975
8925
|
*/
|
|
8976
8926
|
export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
@@ -8985,7 +8935,7 @@ export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
|
8985
8935
|
*
|
|
8986
8936
|
* - encodes `DateTime.TimeZone.Offset` as a number (offset in milliseconds)
|
|
8987
8937
|
*
|
|
8988
|
-
* @category
|
|
8938
|
+
* @category schemas
|
|
8989
8939
|
* @since 3.10.0
|
|
8990
8940
|
*/
|
|
8991
8941
|
export declare const TimeZoneOffset: TimeZoneOffset;
|
|
@@ -8998,14 +8948,14 @@ export declare const TimeZoneOffset: TimeZoneOffset;
|
|
|
8998
8948
|
*
|
|
8999
8949
|
* @see {@link TimeZoneOffset} for the corresponding schema
|
|
9000
8950
|
*
|
|
9001
|
-
* @category
|
|
8951
|
+
* @category schemas
|
|
9002
8952
|
* @since 4.0.0
|
|
9003
8953
|
*/
|
|
9004
8954
|
export declare const TimeZoneOffsetReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
9005
8955
|
/**
|
|
9006
8956
|
* Type-level representation of {@link TimeZoneNamed}.
|
|
9007
8957
|
*
|
|
9008
|
-
* @category
|
|
8958
|
+
* @category models
|
|
9009
8959
|
* @since 3.10.0
|
|
9010
8960
|
*/
|
|
9011
8961
|
export interface TimeZoneNamed extends declare<DateTime.TimeZone.Named> {
|
|
@@ -9020,7 +8970,7 @@ export interface TimeZoneNamed extends declare<DateTime.TimeZone.Named> {
|
|
|
9020
8970
|
*
|
|
9021
8971
|
* - encodes `DateTime.TimeZone.Named` as a string (IANA time zone identifier)
|
|
9022
8972
|
*
|
|
9023
|
-
* @category
|
|
8973
|
+
* @category schemas
|
|
9024
8974
|
* @since 3.10.0
|
|
9025
8975
|
*/
|
|
9026
8976
|
export declare const TimeZoneNamed: TimeZoneNamed;
|
|
@@ -9033,14 +8983,14 @@ export declare const TimeZoneNamed: TimeZoneNamed;
|
|
|
9033
8983
|
*
|
|
9034
8984
|
* @see {@link TimeZoneNamed} for the corresponding schema
|
|
9035
8985
|
*
|
|
9036
|
-
* @category
|
|
8986
|
+
* @category schemas
|
|
9037
8987
|
* @since 4.0.0
|
|
9038
8988
|
*/
|
|
9039
8989
|
export declare const TimeZoneNamedReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
9040
8990
|
/**
|
|
9041
8991
|
* Type-level representation of {@link TimeZoneNamedFromString}.
|
|
9042
8992
|
*
|
|
9043
|
-
* @category
|
|
8993
|
+
* @category models
|
|
9044
8994
|
* @since 4.0.0
|
|
9045
8995
|
*/
|
|
9046
8996
|
export interface TimeZoneNamedFromString extends decodeTo<TimeZoneNamed, String> {
|
|
@@ -9057,14 +9007,14 @@ export interface TimeZoneNamedFromString extends decodeTo<TimeZoneNamed, String>
|
|
|
9057
9007
|
* Encoding:
|
|
9058
9008
|
* - A `DateTime.TimeZone.Named` is encoded as a `string`.
|
|
9059
9009
|
*
|
|
9060
|
-
* @category
|
|
9010
|
+
* @category schemas
|
|
9061
9011
|
* @since 4.0.0
|
|
9062
9012
|
*/
|
|
9063
9013
|
export declare const TimeZoneNamedFromString: TimeZoneNamedFromString;
|
|
9064
9014
|
/**
|
|
9065
9015
|
* Type-level representation of {@link TimeZone}.
|
|
9066
9016
|
*
|
|
9067
|
-
* @category
|
|
9017
|
+
* @category models
|
|
9068
9018
|
* @since 3.10.0
|
|
9069
9019
|
*/
|
|
9070
9020
|
export interface TimeZone extends declare<DateTime.TimeZone> {
|
|
@@ -9080,7 +9030,7 @@ export interface TimeZone extends declare<DateTime.TimeZone> {
|
|
|
9080
9030
|
* - encodes `DateTime.TimeZone` as a string (IANA identifier or offset like
|
|
9081
9031
|
* `+03:00`)
|
|
9082
9032
|
*
|
|
9083
|
-
* @category
|
|
9033
|
+
* @category schemas
|
|
9084
9034
|
* @since 3.10.0
|
|
9085
9035
|
*/
|
|
9086
9036
|
export declare const TimeZone: TimeZone;
|
|
@@ -9093,14 +9043,14 @@ export declare const TimeZone: TimeZone;
|
|
|
9093
9043
|
*
|
|
9094
9044
|
* @see {@link TimeZone} for the corresponding schema
|
|
9095
9045
|
*
|
|
9096
|
-
* @category
|
|
9046
|
+
* @category schemas
|
|
9097
9047
|
* @since 4.0.0
|
|
9098
9048
|
*/
|
|
9099
9049
|
export declare const TimeZoneReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
9100
9050
|
/**
|
|
9101
9051
|
* Type-level representation of {@link TimeZoneFromString}.
|
|
9102
9052
|
*
|
|
9103
|
-
* @category
|
|
9053
|
+
* @category models
|
|
9104
9054
|
* @since 4.0.0
|
|
9105
9055
|
*/
|
|
9106
9056
|
export interface TimeZoneFromString extends decodeTo<TimeZone, String> {
|
|
@@ -9117,14 +9067,14 @@ export interface TimeZoneFromString extends decodeTo<TimeZone, String> {
|
|
|
9117
9067
|
* Encoding:
|
|
9118
9068
|
* - A `DateTime.TimeZone` is encoded as a `string`.
|
|
9119
9069
|
*
|
|
9120
|
-
* @category
|
|
9070
|
+
* @category schemas
|
|
9121
9071
|
* @since 4.0.0
|
|
9122
9072
|
*/
|
|
9123
9073
|
export declare const TimeZoneFromString: TimeZoneFromString;
|
|
9124
9074
|
/**
|
|
9125
9075
|
* Type-level representation of {@link DateTimeZoned}.
|
|
9126
9076
|
*
|
|
9127
|
-
* @category
|
|
9077
|
+
* @category models
|
|
9128
9078
|
* @since 3.10.0
|
|
9129
9079
|
*/
|
|
9130
9080
|
export interface DateTimeZoned extends declare<DateTime.Zoned> {
|
|
@@ -9142,7 +9092,7 @@ export interface DateTimeZoned extends declare<DateTime.Zoned> {
|
|
|
9142
9092
|
* - encodes named zones by appending the IANA identifier in brackets, such as
|
|
9143
9093
|
* `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`
|
|
9144
9094
|
*
|
|
9145
|
-
* @category
|
|
9095
|
+
* @category schemas
|
|
9146
9096
|
* @since 3.10.0
|
|
9147
9097
|
*/
|
|
9148
9098
|
export declare const DateTimeZoned: DateTimeZoned;
|
|
@@ -9155,14 +9105,14 @@ export declare const DateTimeZoned: DateTimeZoned;
|
|
|
9155
9105
|
*
|
|
9156
9106
|
* @see {@link DateTimeZoned} for the corresponding schema
|
|
9157
9107
|
*
|
|
9158
|
-
* @category
|
|
9108
|
+
* @category schemas
|
|
9159
9109
|
* @since 4.0.0
|
|
9160
9110
|
*/
|
|
9161
9111
|
export declare const DateTimeZonedReviver: SchemaRepresentation.DeclarationReviver<null>;
|
|
9162
9112
|
/**
|
|
9163
9113
|
* Type-level representation of {@link DateTimeZonedFromString}.
|
|
9164
9114
|
*
|
|
9165
|
-
* @category
|
|
9115
|
+
* @category models
|
|
9166
9116
|
* @since 4.0.0
|
|
9167
9117
|
*/
|
|
9168
9118
|
export interface DateTimeZonedFromString extends decodeTo<DateTimeZoned, String> {
|
|
@@ -9179,7 +9129,7 @@ export interface DateTimeZonedFromString extends decodeTo<DateTimeZoned, String>
|
|
|
9179
9129
|
* Encoding:
|
|
9180
9130
|
* - A `DateTime.Zoned` is encoded as a `string`.
|
|
9181
9131
|
*
|
|
9182
|
-
* @category
|
|
9132
|
+
* @category schemas
|
|
9183
9133
|
* @since 4.0.0
|
|
9184
9134
|
*/
|
|
9185
9135
|
export declare const DateTimeZonedFromString: DateTimeZonedFromString;
|
|
@@ -9264,13 +9214,23 @@ type MissingSelfGeneric<Usage extends string> = `Missing \`Self\` generic - use
|
|
|
9264
9214
|
* Pass the desired class type as the first type parameter. The second optional
|
|
9265
9215
|
* type parameter can be used to add nominal brands.
|
|
9266
9216
|
*
|
|
9217
|
+
* The `identifier` is the schema's stable runtime name. It is exposed on the
|
|
9218
|
+
* class, stored in the schema AST, and used to label diagnostics and generated
|
|
9219
|
+
* references as well as to format class instances.
|
|
9220
|
+
*
|
|
9221
|
+
* It also derives a runtime marker that recognizes instances across hot module
|
|
9222
|
+
* reloads, where `instanceof` can fail because the constructor has been
|
|
9223
|
+
* replaced. The identifier is explicit because the outer JavaScript class name
|
|
9224
|
+
* is not available while the `extends` expression is evaluated and may change
|
|
9225
|
+
* through renaming or minification.
|
|
9226
|
+
*
|
|
9267
9227
|
* **Gotchas**
|
|
9268
9228
|
*
|
|
9269
9229
|
* Passing `disableChecks` in the options skips constructor validation.
|
|
9270
9230
|
*
|
|
9271
9231
|
* **Example** (Defining a basic class)
|
|
9272
9232
|
*
|
|
9273
|
-
* ```ts
|
|
9233
|
+
* ```ts import.meta.vitest
|
|
9274
9234
|
* import { Schema } from "effect"
|
|
9275
9235
|
*
|
|
9276
9236
|
* class Person extends Schema.Class<Person>("Person")({
|
|
@@ -9279,13 +9239,13 @@ type MissingSelfGeneric<Usage extends string> = `Missing \`Self\` generic - use
|
|
|
9279
9239
|
* }) {}
|
|
9280
9240
|
*
|
|
9281
9241
|
* const alice = new Person({ name: "Alice", age: 30 })
|
|
9282
|
-
*
|
|
9283
|
-
*
|
|
9242
|
+
* alice.name // => "Alice"
|
|
9243
|
+
* String(alice) // => "Person({\"name\":\"Alice\",\"age\":30})"
|
|
9284
9244
|
* ```
|
|
9285
9245
|
*
|
|
9286
9246
|
* **Example** (Extending a class)
|
|
9287
9247
|
*
|
|
9288
|
-
* ```ts
|
|
9248
|
+
* ```ts import.meta.vitest
|
|
9289
9249
|
* import { Schema } from "effect"
|
|
9290
9250
|
*
|
|
9291
9251
|
* class Animal extends Schema.Class<Animal>("Animal")({
|
|
@@ -9297,8 +9257,8 @@ type MissingSelfGeneric<Usage extends string> = `Missing \`Self\` generic - use
|
|
|
9297
9257
|
* }) {}
|
|
9298
9258
|
*
|
|
9299
9259
|
* const dog = new Dog({ name: "Rex", breed: "Labrador" })
|
|
9300
|
-
*
|
|
9301
|
-
*
|
|
9260
|
+
* dog.name // => "Rex"
|
|
9261
|
+
* dog.breed // => "Labrador"
|
|
9302
9262
|
* ```
|
|
9303
9263
|
*
|
|
9304
9264
|
* @see {@link TaggedClass} for adding a `_tag` literal field to the class schema
|
|
@@ -9324,13 +9284,23 @@ export declare const Class: {
|
|
|
9324
9284
|
* Pass the desired class type as the first type parameter. The second optional
|
|
9325
9285
|
* type parameter can be used to add nominal brands.
|
|
9326
9286
|
*
|
|
9287
|
+
* The `identifier` is the schema's stable runtime name. It is exposed on the
|
|
9288
|
+
* class, stored in the schema AST, and used to label diagnostics and generated
|
|
9289
|
+
* references as well as to format class instances.
|
|
9290
|
+
*
|
|
9291
|
+
* It also derives a runtime marker that recognizes instances across hot module
|
|
9292
|
+
* reloads, where `instanceof` can fail because the constructor has been
|
|
9293
|
+
* replaced. The identifier is explicit because the outer JavaScript class name
|
|
9294
|
+
* is not available while the `extends` expression is evaluated and may change
|
|
9295
|
+
* through renaming or minification.
|
|
9296
|
+
*
|
|
9327
9297
|
* **Gotchas**
|
|
9328
9298
|
*
|
|
9329
9299
|
* Passing `disableChecks` in the options skips constructor validation.
|
|
9330
9300
|
*
|
|
9331
9301
|
* **Example** (Defining a basic class)
|
|
9332
9302
|
*
|
|
9333
|
-
* ```ts
|
|
9303
|
+
* ```ts import.meta.vitest
|
|
9334
9304
|
* import { Schema } from "effect"
|
|
9335
9305
|
*
|
|
9336
9306
|
* class Person extends Schema.Class<Person>("Person")({
|
|
@@ -9339,13 +9309,13 @@ export declare const Class: {
|
|
|
9339
9309
|
* }) {}
|
|
9340
9310
|
*
|
|
9341
9311
|
* const alice = new Person({ name: "Alice", age: 30 })
|
|
9342
|
-
*
|
|
9343
|
-
*
|
|
9312
|
+
* alice.name // => "Alice"
|
|
9313
|
+
* String(alice) // => "Person({\"name\":\"Alice\",\"age\":30})"
|
|
9344
9314
|
* ```
|
|
9345
9315
|
*
|
|
9346
9316
|
* **Example** (Extending a class)
|
|
9347
9317
|
*
|
|
9348
|
-
* ```ts
|
|
9318
|
+
* ```ts import.meta.vitest
|
|
9349
9319
|
* import { Schema } from "effect"
|
|
9350
9320
|
*
|
|
9351
9321
|
* class Animal extends Schema.Class<Animal>("Animal")({
|
|
@@ -9357,8 +9327,8 @@ export declare const Class: {
|
|
|
9357
9327
|
* }) {}
|
|
9358
9328
|
*
|
|
9359
9329
|
* const dog = new Dog({ name: "Rex", breed: "Labrador" })
|
|
9360
|
-
*
|
|
9361
|
-
*
|
|
9330
|
+
* dog.name // => "Rex"
|
|
9331
|
+
* dog.breed // => "Labrador"
|
|
9362
9332
|
* ```
|
|
9363
9333
|
*
|
|
9364
9334
|
* @see {@link TaggedClass} for adding a `_tag` literal field to the class schema
|
|
@@ -9384,13 +9354,23 @@ export declare const Class: {
|
|
|
9384
9354
|
* Pass the desired class type as the first type parameter. The second optional
|
|
9385
9355
|
* type parameter can be used to add nominal brands.
|
|
9386
9356
|
*
|
|
9357
|
+
* The `identifier` is the schema's stable runtime name. It is exposed on the
|
|
9358
|
+
* class, stored in the schema AST, and used to label diagnostics and generated
|
|
9359
|
+
* references as well as to format class instances.
|
|
9360
|
+
*
|
|
9361
|
+
* It also derives a runtime marker that recognizes instances across hot module
|
|
9362
|
+
* reloads, where `instanceof` can fail because the constructor has been
|
|
9363
|
+
* replaced. The identifier is explicit because the outer JavaScript class name
|
|
9364
|
+
* is not available while the `extends` expression is evaluated and may change
|
|
9365
|
+
* through renaming or minification.
|
|
9366
|
+
*
|
|
9387
9367
|
* **Gotchas**
|
|
9388
9368
|
*
|
|
9389
9369
|
* Passing `disableChecks` in the options skips constructor validation.
|
|
9390
9370
|
*
|
|
9391
9371
|
* **Example** (Defining a basic class)
|
|
9392
9372
|
*
|
|
9393
|
-
* ```ts
|
|
9373
|
+
* ```ts import.meta.vitest
|
|
9394
9374
|
* import { Schema } from "effect"
|
|
9395
9375
|
*
|
|
9396
9376
|
* class Person extends Schema.Class<Person>("Person")({
|
|
@@ -9399,13 +9379,13 @@ export declare const Class: {
|
|
|
9399
9379
|
* }) {}
|
|
9400
9380
|
*
|
|
9401
9381
|
* const alice = new Person({ name: "Alice", age: 30 })
|
|
9402
|
-
*
|
|
9403
|
-
*
|
|
9382
|
+
* alice.name // => "Alice"
|
|
9383
|
+
* String(alice) // => "Person({\"name\":\"Alice\",\"age\":30})"
|
|
9404
9384
|
* ```
|
|
9405
9385
|
*
|
|
9406
9386
|
* **Example** (Extending a class)
|
|
9407
9387
|
*
|
|
9408
|
-
* ```ts
|
|
9388
|
+
* ```ts import.meta.vitest
|
|
9409
9389
|
* import { Schema } from "effect"
|
|
9410
9390
|
*
|
|
9411
9391
|
* class Animal extends Schema.Class<Animal>("Animal")({
|
|
@@ -9417,8 +9397,8 @@ export declare const Class: {
|
|
|
9417
9397
|
* }) {}
|
|
9418
9398
|
*
|
|
9419
9399
|
* const dog = new Dog({ name: "Rex", breed: "Labrador" })
|
|
9420
|
-
*
|
|
9421
|
-
*
|
|
9400
|
+
* dog.name // => "Rex"
|
|
9401
|
+
* dog.breed // => "Labrador"
|
|
9422
9402
|
* ```
|
|
9423
9403
|
*
|
|
9424
9404
|
* @see {@link TaggedClass} for adding a `_tag` literal field to the class schema
|
|
@@ -9444,13 +9424,23 @@ export declare const Class: {
|
|
|
9444
9424
|
* Pass the desired class type as the first type parameter. The second optional
|
|
9445
9425
|
* type parameter can be used to add nominal brands.
|
|
9446
9426
|
*
|
|
9427
|
+
* The `identifier` is the schema's stable runtime name. It is exposed on the
|
|
9428
|
+
* class, stored in the schema AST, and used to label diagnostics and generated
|
|
9429
|
+
* references as well as to format class instances.
|
|
9430
|
+
*
|
|
9431
|
+
* It also derives a runtime marker that recognizes instances across hot module
|
|
9432
|
+
* reloads, where `instanceof` can fail because the constructor has been
|
|
9433
|
+
* replaced. The identifier is explicit because the outer JavaScript class name
|
|
9434
|
+
* is not available while the `extends` expression is evaluated and may change
|
|
9435
|
+
* through renaming or minification.
|
|
9436
|
+
*
|
|
9447
9437
|
* **Gotchas**
|
|
9448
9438
|
*
|
|
9449
9439
|
* Passing `disableChecks` in the options skips constructor validation.
|
|
9450
9440
|
*
|
|
9451
9441
|
* **Example** (Defining a basic class)
|
|
9452
9442
|
*
|
|
9453
|
-
* ```ts
|
|
9443
|
+
* ```ts import.meta.vitest
|
|
9454
9444
|
* import { Schema } from "effect"
|
|
9455
9445
|
*
|
|
9456
9446
|
* class Person extends Schema.Class<Person>("Person")({
|
|
@@ -9459,13 +9449,13 @@ export declare const Class: {
|
|
|
9459
9449
|
* }) {}
|
|
9460
9450
|
*
|
|
9461
9451
|
* const alice = new Person({ name: "Alice", age: 30 })
|
|
9462
|
-
*
|
|
9463
|
-
*
|
|
9452
|
+
* alice.name // => "Alice"
|
|
9453
|
+
* String(alice) // => "Person({\"name\":\"Alice\",\"age\":30})"
|
|
9464
9454
|
* ```
|
|
9465
9455
|
*
|
|
9466
9456
|
* **Example** (Extending a class)
|
|
9467
9457
|
*
|
|
9468
|
-
* ```ts
|
|
9458
|
+
* ```ts import.meta.vitest
|
|
9469
9459
|
* import { Schema } from "effect"
|
|
9470
9460
|
*
|
|
9471
9461
|
* class Animal extends Schema.Class<Animal>("Animal")({
|
|
@@ -9477,8 +9467,8 @@ export declare const Class: {
|
|
|
9477
9467
|
* }) {}
|
|
9478
9468
|
*
|
|
9479
9469
|
* const dog = new Dog({ name: "Rex", breed: "Labrador" })
|
|
9480
|
-
*
|
|
9481
|
-
*
|
|
9470
|
+
* dog.name // => "Rex"
|
|
9471
|
+
* dog.breed // => "Labrador"
|
|
9482
9472
|
* ```
|
|
9483
9473
|
*
|
|
9484
9474
|
* @see {@link TaggedClass} for adding a `_tag` literal field to the class schema
|
|
@@ -9506,7 +9496,7 @@ export declare const Class: {
|
|
|
9506
9496
|
*
|
|
9507
9497
|
* **Example** (Defining a tagged class)
|
|
9508
9498
|
*
|
|
9509
|
-
* ```ts
|
|
9499
|
+
* ```ts import.meta.vitest
|
|
9510
9500
|
* import { Schema } from "effect"
|
|
9511
9501
|
*
|
|
9512
9502
|
* class Circle extends Schema.TaggedClass<Circle>()("Circle", {
|
|
@@ -9514,8 +9504,8 @@ export declare const Class: {
|
|
|
9514
9504
|
* }) {}
|
|
9515
9505
|
*
|
|
9516
9506
|
* const c = new Circle({ radius: 5 })
|
|
9517
|
-
*
|
|
9518
|
-
*
|
|
9507
|
+
* c._tag // => "Circle"
|
|
9508
|
+
* c.radius // => 5
|
|
9519
9509
|
* ```
|
|
9520
9510
|
*
|
|
9521
9511
|
* @category constructors
|
|
@@ -9537,7 +9527,7 @@ export declare const TaggedClass: {
|
|
|
9537
9527
|
*
|
|
9538
9528
|
* **Example** (Defining a tagged class)
|
|
9539
9529
|
*
|
|
9540
|
-
* ```ts
|
|
9530
|
+
* ```ts import.meta.vitest
|
|
9541
9531
|
* import { Schema } from "effect"
|
|
9542
9532
|
*
|
|
9543
9533
|
* class Circle extends Schema.TaggedClass<Circle>()("Circle", {
|
|
@@ -9545,8 +9535,8 @@ export declare const TaggedClass: {
|
|
|
9545
9535
|
* }) {}
|
|
9546
9536
|
*
|
|
9547
9537
|
* const c = new Circle({ radius: 5 })
|
|
9548
|
-
*
|
|
9549
|
-
*
|
|
9538
|
+
* c._tag // => "Circle"
|
|
9539
|
+
* c.radius // => 5
|
|
9550
9540
|
* ```
|
|
9551
9541
|
*
|
|
9552
9542
|
* @category constructors
|
|
@@ -9568,7 +9558,7 @@ export declare const TaggedClass: {
|
|
|
9568
9558
|
*
|
|
9569
9559
|
* **Example** (Defining a tagged class)
|
|
9570
9560
|
*
|
|
9571
|
-
* ```ts
|
|
9561
|
+
* ```ts import.meta.vitest
|
|
9572
9562
|
* import { Schema } from "effect"
|
|
9573
9563
|
*
|
|
9574
9564
|
* class Circle extends Schema.TaggedClass<Circle>()("Circle", {
|
|
@@ -9576,8 +9566,8 @@ export declare const TaggedClass: {
|
|
|
9576
9566
|
* }) {}
|
|
9577
9567
|
*
|
|
9578
9568
|
* const c = new Circle({ radius: 5 })
|
|
9579
|
-
*
|
|
9580
|
-
*
|
|
9569
|
+
* c._tag // => "Circle"
|
|
9570
|
+
* c.radius // => 5
|
|
9581
9571
|
* ```
|
|
9582
9572
|
*
|
|
9583
9573
|
* @category constructors
|
|
@@ -9599,7 +9589,7 @@ export declare const TaggedClass: {
|
|
|
9599
9589
|
*
|
|
9600
9590
|
* **Example** (Defining a tagged class)
|
|
9601
9591
|
*
|
|
9602
|
-
* ```ts
|
|
9592
|
+
* ```ts import.meta.vitest
|
|
9603
9593
|
* import { Schema } from "effect"
|
|
9604
9594
|
*
|
|
9605
9595
|
* class Circle extends Schema.TaggedClass<Circle>()("Circle", {
|
|
@@ -9607,8 +9597,8 @@ export declare const TaggedClass: {
|
|
|
9607
9597
|
* }) {}
|
|
9608
9598
|
*
|
|
9609
9599
|
* const c = new Circle({ radius: 5 })
|
|
9610
|
-
*
|
|
9611
|
-
*
|
|
9600
|
+
* c._tag // => "Circle"
|
|
9601
|
+
* c.radius // => 5
|
|
9612
9602
|
* ```
|
|
9613
9603
|
*
|
|
9614
9604
|
* @category constructors
|
|
@@ -9629,7 +9619,7 @@ export declare const TaggedClass: {
|
|
|
9629
9619
|
*
|
|
9630
9620
|
* **Example** (Schema-backed error)
|
|
9631
9621
|
*
|
|
9632
|
-
* ```ts
|
|
9622
|
+
* ```ts import.meta.vitest
|
|
9633
9623
|
* import { Effect, Schema } from "effect"
|
|
9634
9624
|
*
|
|
9635
9625
|
* class NotFound extends Schema.ErrorClass<NotFound>("NotFound")({
|
|
@@ -9639,6 +9629,8 @@ export declare const TaggedClass: {
|
|
|
9639
9629
|
* const program = Effect.gen(function*() {
|
|
9640
9630
|
* yield* new NotFound({ id: 1 })
|
|
9641
9631
|
* })
|
|
9632
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9633
|
+
* error.id // => 1
|
|
9642
9634
|
* ```
|
|
9643
9635
|
*
|
|
9644
9636
|
* @category constructors
|
|
@@ -9653,7 +9645,7 @@ export declare const ErrorClass: {
|
|
|
9653
9645
|
*
|
|
9654
9646
|
* **Example** (Schema-backed error)
|
|
9655
9647
|
*
|
|
9656
|
-
* ```ts
|
|
9648
|
+
* ```ts import.meta.vitest
|
|
9657
9649
|
* import { Effect, Schema } from "effect"
|
|
9658
9650
|
*
|
|
9659
9651
|
* class NotFound extends Schema.ErrorClass<NotFound>("NotFound")({
|
|
@@ -9663,6 +9655,8 @@ export declare const ErrorClass: {
|
|
|
9663
9655
|
* const program = Effect.gen(function*() {
|
|
9664
9656
|
* yield* new NotFound({ id: 1 })
|
|
9665
9657
|
* })
|
|
9658
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9659
|
+
* error.id // => 1
|
|
9666
9660
|
* ```
|
|
9667
9661
|
*
|
|
9668
9662
|
* @category constructors
|
|
@@ -9677,7 +9671,7 @@ export declare const ErrorClass: {
|
|
|
9677
9671
|
*
|
|
9678
9672
|
* **Example** (Schema-backed error)
|
|
9679
9673
|
*
|
|
9680
|
-
* ```ts
|
|
9674
|
+
* ```ts import.meta.vitest
|
|
9681
9675
|
* import { Effect, Schema } from "effect"
|
|
9682
9676
|
*
|
|
9683
9677
|
* class NotFound extends Schema.ErrorClass<NotFound>("NotFound")({
|
|
@@ -9687,6 +9681,8 @@ export declare const ErrorClass: {
|
|
|
9687
9681
|
* const program = Effect.gen(function*() {
|
|
9688
9682
|
* yield* new NotFound({ id: 1 })
|
|
9689
9683
|
* })
|
|
9684
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9685
|
+
* error.id // => 1
|
|
9690
9686
|
* ```
|
|
9691
9687
|
*
|
|
9692
9688
|
* @category constructors
|
|
@@ -9701,7 +9697,7 @@ export declare const ErrorClass: {
|
|
|
9701
9697
|
*
|
|
9702
9698
|
* **Example** (Schema-backed error)
|
|
9703
9699
|
*
|
|
9704
|
-
* ```ts
|
|
9700
|
+
* ```ts import.meta.vitest
|
|
9705
9701
|
* import { Effect, Schema } from "effect"
|
|
9706
9702
|
*
|
|
9707
9703
|
* class NotFound extends Schema.ErrorClass<NotFound>("NotFound")({
|
|
@@ -9711,6 +9707,8 @@ export declare const ErrorClass: {
|
|
|
9711
9707
|
* const program = Effect.gen(function*() {
|
|
9712
9708
|
* yield* new NotFound({ id: 1 })
|
|
9713
9709
|
* })
|
|
9710
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9711
|
+
* error.id // => 1
|
|
9714
9712
|
* ```
|
|
9715
9713
|
*
|
|
9716
9714
|
* @category constructors
|
|
@@ -9730,7 +9728,7 @@ export declare const ErrorClass: {
|
|
|
9730
9728
|
*
|
|
9731
9729
|
* **Example** (Defining a tagged error class)
|
|
9732
9730
|
*
|
|
9733
|
-
* ```ts
|
|
9731
|
+
* ```ts import.meta.vitest
|
|
9734
9732
|
* import { Effect, Schema } from "effect"
|
|
9735
9733
|
*
|
|
9736
9734
|
* class NotFound extends Schema.TaggedErrorClass<NotFound>()("NotFound", {
|
|
@@ -9740,6 +9738,9 @@ export declare const ErrorClass: {
|
|
|
9740
9738
|
* const program = Effect.gen(function*() {
|
|
9741
9739
|
* yield* new NotFound({ id: 42 })
|
|
9742
9740
|
* })
|
|
9741
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9742
|
+
* error._tag // => "NotFound"
|
|
9743
|
+
* error.id // => 42
|
|
9743
9744
|
* ```
|
|
9744
9745
|
*
|
|
9745
9746
|
* @category constructors
|
|
@@ -9757,7 +9758,7 @@ export declare const TaggedErrorClass: {
|
|
|
9757
9758
|
*
|
|
9758
9759
|
* **Example** (Defining a tagged error class)
|
|
9759
9760
|
*
|
|
9760
|
-
* ```ts
|
|
9761
|
+
* ```ts import.meta.vitest
|
|
9761
9762
|
* import { Effect, Schema } from "effect"
|
|
9762
9763
|
*
|
|
9763
9764
|
* class NotFound extends Schema.TaggedErrorClass<NotFound>()("NotFound", {
|
|
@@ -9767,6 +9768,9 @@ export declare const TaggedErrorClass: {
|
|
|
9767
9768
|
* const program = Effect.gen(function*() {
|
|
9768
9769
|
* yield* new NotFound({ id: 42 })
|
|
9769
9770
|
* })
|
|
9771
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9772
|
+
* error._tag // => "NotFound"
|
|
9773
|
+
* error.id // => 42
|
|
9770
9774
|
* ```
|
|
9771
9775
|
*
|
|
9772
9776
|
* @category constructors
|
|
@@ -9784,7 +9788,7 @@ export declare const TaggedErrorClass: {
|
|
|
9784
9788
|
*
|
|
9785
9789
|
* **Example** (Defining a tagged error class)
|
|
9786
9790
|
*
|
|
9787
|
-
* ```ts
|
|
9791
|
+
* ```ts import.meta.vitest
|
|
9788
9792
|
* import { Effect, Schema } from "effect"
|
|
9789
9793
|
*
|
|
9790
9794
|
* class NotFound extends Schema.TaggedErrorClass<NotFound>()("NotFound", {
|
|
@@ -9794,6 +9798,9 @@ export declare const TaggedErrorClass: {
|
|
|
9794
9798
|
* const program = Effect.gen(function*() {
|
|
9795
9799
|
* yield* new NotFound({ id: 42 })
|
|
9796
9800
|
* })
|
|
9801
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9802
|
+
* error._tag // => "NotFound"
|
|
9803
|
+
* error.id // => 42
|
|
9797
9804
|
* ```
|
|
9798
9805
|
*
|
|
9799
9806
|
* @category constructors
|
|
@@ -9811,7 +9818,7 @@ export declare const TaggedErrorClass: {
|
|
|
9811
9818
|
*
|
|
9812
9819
|
* **Example** (Defining a tagged error class)
|
|
9813
9820
|
*
|
|
9814
|
-
* ```ts
|
|
9821
|
+
* ```ts import.meta.vitest
|
|
9815
9822
|
* import { Effect, Schema } from "effect"
|
|
9816
9823
|
*
|
|
9817
9824
|
* class NotFound extends Schema.TaggedErrorClass<NotFound>()("NotFound", {
|
|
@@ -9821,6 +9828,9 @@ export declare const TaggedErrorClass: {
|
|
|
9821
9828
|
* const program = Effect.gen(function*() {
|
|
9822
9829
|
* yield* new NotFound({ id: 42 })
|
|
9823
9830
|
* })
|
|
9831
|
+
* const error = await Effect.runPromise(Effect.flip(program))
|
|
9832
|
+
* error._tag // => "NotFound"
|
|
9833
|
+
* error.id // => 42
|
|
9824
9834
|
* ```
|
|
9825
9835
|
*
|
|
9826
9836
|
* @category constructors
|
|
@@ -9838,7 +9848,7 @@ export declare const TaggedErrorClass: {
|
|
|
9838
9848
|
* Use this type when you need to defer instantiation of the arbitrary, for
|
|
9839
9849
|
* example to support recursive schemas.
|
|
9840
9850
|
*
|
|
9841
|
-
* @category
|
|
9851
|
+
* @category utility types
|
|
9842
9852
|
* @since 4.0.0
|
|
9843
9853
|
*/
|
|
9844
9854
|
export type LazyArbitrary<T> = (fc: typeof FastCheck) => FastCheck.Arbitrary<T>;
|
|
@@ -9853,7 +9863,7 @@ export type LazyArbitrary<T> = (fc: typeof FastCheck) => FastCheck.Arbitrary<T>;
|
|
|
9853
9863
|
* nodes, impossible constraints, invalid candidates, and recursive schemas
|
|
9854
9864
|
* without a finite terminal path fail immediately.
|
|
9855
9865
|
*
|
|
9856
|
-
* @category
|
|
9866
|
+
* @category generators
|
|
9857
9867
|
* @since 4.0.0
|
|
9858
9868
|
*/
|
|
9859
9869
|
export declare function toArbitraryLazy<S extends Constraint>(schema: S): LazyArbitrary<S["Type"]>;
|
|
@@ -9870,7 +9880,7 @@ export declare function toArbitraryLazy<S extends Constraint>(schema: S): LazyAr
|
|
|
9870
9880
|
*
|
|
9871
9881
|
* **Example** (Generating arbitrary values)
|
|
9872
9882
|
*
|
|
9873
|
-
* ```ts
|
|
9883
|
+
* ```ts import.meta.vitest
|
|
9874
9884
|
* import { Schema } from "effect"
|
|
9875
9885
|
* import * as FastCheck from "fast-check"
|
|
9876
9886
|
*
|
|
@@ -9879,11 +9889,10 @@ export declare function toArbitraryLazy<S extends Constraint>(schema: S): LazyAr
|
|
|
9879
9889
|
* )
|
|
9880
9890
|
*
|
|
9881
9891
|
* // Sample a random value
|
|
9882
|
-
*
|
|
9883
|
-
* console.log(typeof sample.name) // "string"
|
|
9892
|
+
* FastCheck.sample(PersonArb, 1)
|
|
9884
9893
|
* ```
|
|
9885
9894
|
*
|
|
9886
|
-
* @category
|
|
9895
|
+
* @category generators
|
|
9887
9896
|
* @since 4.0.0
|
|
9888
9897
|
*/
|
|
9889
9898
|
export declare function toArbitrary<S extends Constraint>(schema: S): FastCheck.Arbitrary<S["Type"]>;
|
|
@@ -9899,7 +9908,7 @@ export declare function toArbitrary<S extends Constraint>(schema: S, options: {
|
|
|
9899
9908
|
* The annotation is applied through this helper because adding it directly to
|
|
9900
9909
|
* `Annotations.Bottom` would make schemas invariant.
|
|
9901
9910
|
*
|
|
9902
|
-
* @category
|
|
9911
|
+
* @category formatting
|
|
9903
9912
|
* @since 4.0.0
|
|
9904
9913
|
*/
|
|
9905
9914
|
export declare function overrideToFormatter<S extends Top>(toFormatter: () => Formatter<S["Type"]>): (self: S) => S["Rebuild"];
|
|
@@ -9913,7 +9922,7 @@ export declare function overrideToFormatter<S extends Top>(toFormatter: () => Fo
|
|
|
9913
9922
|
* The optional `onBefore` hook lets you intercept specific AST nodes before
|
|
9914
9923
|
* the default formatting logic runs.
|
|
9915
9924
|
*
|
|
9916
|
-
* @category
|
|
9925
|
+
* @category formatting
|
|
9917
9926
|
* @since 4.0.0
|
|
9918
9927
|
*/
|
|
9919
9928
|
export declare function toFormatter<S extends Constraint>(schema: S, options?: {
|
|
@@ -9939,13 +9948,13 @@ export declare function overrideToEquivalence<S extends Top>(toEquivalence: () =
|
|
|
9939
9948
|
*
|
|
9940
9949
|
* **Example** (Comparing structs)
|
|
9941
9950
|
*
|
|
9942
|
-
* ```ts
|
|
9951
|
+
* ```ts import.meta.vitest
|
|
9943
9952
|
* import { Schema } from "effect"
|
|
9944
9953
|
*
|
|
9945
9954
|
* const eq = Schema.toEquivalence(Schema.Struct({ id: Schema.Number, name: Schema.String }))
|
|
9946
9955
|
*
|
|
9947
|
-
*
|
|
9948
|
-
*
|
|
9956
|
+
* eq({ id: 1, name: "Alice" }, { id: 1, name: "Alice" }) // => true
|
|
9957
|
+
* eq({ id: 1, name: "Alice" }, { id: 2, name: "Alice" }) // => false
|
|
9949
9958
|
* ```
|
|
9950
9959
|
*
|
|
9951
9960
|
* @category instances
|
|
@@ -9960,7 +9969,7 @@ export declare function toEquivalence<T>(schema: Schema<T>): Equivalence.Equival
|
|
|
9960
9969
|
*
|
|
9961
9970
|
* Use {@link toType} before this function to represent the type side instead.
|
|
9962
9971
|
*
|
|
9963
|
-
* @category
|
|
9972
|
+
* @category converting
|
|
9964
9973
|
* @since 4.0.0
|
|
9965
9974
|
*/
|
|
9966
9975
|
export declare function toRepresentation(schema: Constraint): SchemaRepresentation.Document;
|
|
@@ -10014,7 +10023,7 @@ export interface ToJsonSchemaOptions {
|
|
|
10014
10023
|
*
|
|
10015
10024
|
* **Example** (Including custom annotations)
|
|
10016
10025
|
*
|
|
10017
|
-
* ```ts
|
|
10026
|
+
* ```ts import.meta.vitest
|
|
10018
10027
|
* import { Schema } from "effect"
|
|
10019
10028
|
*
|
|
10020
10029
|
* const schema = Schema.String.annotate({
|
|
@@ -10027,12 +10036,7 @@ export interface ToJsonSchemaOptions {
|
|
|
10027
10036
|
* key === "markdownDescription" || key.startsWith("x-")
|
|
10028
10037
|
* })
|
|
10029
10038
|
*
|
|
10030
|
-
*
|
|
10031
|
-
* // {
|
|
10032
|
-
* // type: "string",
|
|
10033
|
-
* // description: "A name",
|
|
10034
|
-
* // markdownDescription: "The **name** field"
|
|
10035
|
-
* // }
|
|
10039
|
+
* doc.schema // => { type: "string", description: "A name", markdownDescription: "The **name** field" }
|
|
10036
10040
|
* ```
|
|
10037
10041
|
*/
|
|
10038
10042
|
readonly includeAnnotationKey?: ((key: string) => boolean) | undefined;
|
|
@@ -10062,7 +10066,7 @@ export declare function toJsonSchemaDocument(schema: Constraint, options?: ToJso
|
|
|
10062
10066
|
/**
|
|
10063
10067
|
* Type-level representation returned by {@link toCodecJson}.
|
|
10064
10068
|
*
|
|
10065
|
-
* @category
|
|
10069
|
+
* @category converting
|
|
10066
10070
|
* @since 4.0.0
|
|
10067
10071
|
*/
|
|
10068
10072
|
export interface toCodecJson<S extends Constraint> extends BottomLazy<S["ast"], toCodecJson<S>, S["~type.parameters"], S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]> {
|
|
@@ -10087,7 +10091,7 @@ export interface toCodecJson<S extends Constraint> extends BottomLazy<S["ast"],
|
|
|
10087
10091
|
* `toCodecJson` callback can return `undefined` when the declaration is already
|
|
10088
10092
|
* in canonical JSON form.
|
|
10089
10093
|
*
|
|
10090
|
-
* @category
|
|
10094
|
+
* @category converting
|
|
10091
10095
|
* @since 4.0.0
|
|
10092
10096
|
*/
|
|
10093
10097
|
export declare function toCodecJson<S extends Constraint>(schema: S): toCodecJson<S>;
|
|
@@ -10095,7 +10099,7 @@ export declare function toCodecJson<S extends Constraint>(schema: S): toCodecJso
|
|
|
10095
10099
|
* Derives an isomorphism codec from a schema. The encoded form is the
|
|
10096
10100
|
* schema's `Iso` type — the intermediate representation used for round-tripping.
|
|
10097
10101
|
*
|
|
10098
|
-
* @category
|
|
10102
|
+
* @category converting
|
|
10099
10103
|
* @since 4.0.0
|
|
10100
10104
|
*/
|
|
10101
10105
|
export declare function toCodecIso<S extends Constraint>(schema: S): Codec<S["Type"], S["Iso"]>;
|
|
@@ -10103,14 +10107,14 @@ export declare function toCodecIso<S extends Constraint>(schema: S): Codec<S["Ty
|
|
|
10103
10107
|
* A {@link Tree} of `string | undefined` nodes. Leaf values are either a
|
|
10104
10108
|
* string representation or `undefined` for opaque/declaration types.
|
|
10105
10109
|
*
|
|
10106
|
-
* @category
|
|
10110
|
+
* @category models
|
|
10107
10111
|
* @since 4.0.0
|
|
10108
10112
|
*/
|
|
10109
10113
|
export type StringTree = Tree<string | undefined>;
|
|
10110
10114
|
/**
|
|
10111
10115
|
* Type-level representation returned by {@link toCodecStringTree}.
|
|
10112
10116
|
*
|
|
10113
|
-
* @category
|
|
10117
|
+
* @category converting
|
|
10114
10118
|
* @since 4.0.0
|
|
10115
10119
|
*/
|
|
10116
10120
|
export interface toCodecStringTree<S extends Constraint> extends BottomLazy<S["ast"], toCodecStringTree<S>, ReadonlyArray<Constraint>, S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]> {
|
|
@@ -10133,14 +10137,14 @@ export interface toCodecStringTree<S extends Constraint> extends BottomLazy<S["a
|
|
|
10133
10137
|
* `toCodec` encoding. A callback can return `undefined` when the declaration is
|
|
10134
10138
|
* already in canonical StringTree form.
|
|
10135
10139
|
*
|
|
10136
|
-
* @category
|
|
10140
|
+
* @category converting
|
|
10137
10141
|
* @since 4.0.0
|
|
10138
10142
|
*/
|
|
10139
10143
|
export declare function toCodecStringTree<S extends Constraint>(schema: S): toCodecStringTree<S>;
|
|
10140
10144
|
/**
|
|
10141
10145
|
* Type-level representation returned by {@link toCodecArrayFromSingle}.
|
|
10142
10146
|
*
|
|
10143
|
-
* @category
|
|
10147
|
+
* @category converting
|
|
10144
10148
|
* @since 4.0.0
|
|
10145
10149
|
*/
|
|
10146
10150
|
export interface toCodecArrayFromSingle<S extends Constraint> extends BottomLazy<S["ast"], toCodecArrayFromSingle<S>, S["~type.parameters"], S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]> {
|
|
@@ -10167,7 +10171,7 @@ export interface toCodecArrayFromSingle<S extends Constraint> extends BottomLazy
|
|
|
10167
10171
|
* decoding convenience rather than a canonical StringTree representation. It
|
|
10168
10172
|
* does not parse comma-separated strings.
|
|
10169
10173
|
*
|
|
10170
|
-
* @category
|
|
10174
|
+
* @category converting
|
|
10171
10175
|
* @since 4.0.0
|
|
10172
10176
|
*/
|
|
10173
10177
|
export declare function toCodecArrayFromSingle<S extends Constraint>(schema: S): toCodecArrayFromSingle<S>;
|
|
@@ -10192,7 +10196,7 @@ type XmlEncoderOptions = {
|
|
|
10192
10196
|
* an `Effect` that succeeds with the XML string or fails with `SchemaError` if
|
|
10193
10197
|
* codec encoding fails.
|
|
10194
10198
|
*
|
|
10195
|
-
* @category
|
|
10199
|
+
* @category encoding
|
|
10196
10200
|
* @since 4.0.0
|
|
10197
10201
|
*/
|
|
10198
10202
|
export declare function toEncoderXml<T, RE>(codec: ConstraintCodec<T, unknown, unknown, RE>, options?: XmlEncoderOptions): (t: T) => Effect.Effect<string, SchemaError, RE>;
|
|
@@ -10205,7 +10209,7 @@ export declare function toEncoderXml<T, RE>(codec: ConstraintCodec<T, unknown, u
|
|
|
10205
10209
|
*
|
|
10206
10210
|
* @see {@link isGreaterThanDate} for creating the corresponding check
|
|
10207
10211
|
*
|
|
10208
|
-
* @category
|
|
10212
|
+
* @category validation
|
|
10209
10213
|
* @since 4.0.0
|
|
10210
10214
|
*/
|
|
10211
10215
|
export declare const isGreaterThanDateReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10220,7 +10224,7 @@ export declare const isGreaterThanDateReviver: SchemaRepresentation.FilterRevive
|
|
|
10220
10224
|
*
|
|
10221
10225
|
* @see {@link isGreaterThanOrEqualToDate} for creating the corresponding check
|
|
10222
10226
|
*
|
|
10223
|
-
* @category
|
|
10227
|
+
* @category validation
|
|
10224
10228
|
* @since 4.0.0
|
|
10225
10229
|
*/
|
|
10226
10230
|
export declare const isGreaterThanOrEqualToDateReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10235,7 +10239,7 @@ export declare const isGreaterThanOrEqualToDateReviver: SchemaRepresentation.Fil
|
|
|
10235
10239
|
*
|
|
10236
10240
|
* @see {@link isLessThanDate} for creating the corresponding check
|
|
10237
10241
|
*
|
|
10238
|
-
* @category
|
|
10242
|
+
* @category validation
|
|
10239
10243
|
* @since 4.0.0
|
|
10240
10244
|
*/
|
|
10241
10245
|
export declare const isLessThanDateReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10250,7 +10254,7 @@ export declare const isLessThanDateReviver: SchemaRepresentation.FilterReviver<{
|
|
|
10250
10254
|
*
|
|
10251
10255
|
* @see {@link isLessThanOrEqualToDate} for creating the corresponding check
|
|
10252
10256
|
*
|
|
10253
|
-
* @category
|
|
10257
|
+
* @category validation
|
|
10254
10258
|
* @since 4.0.0
|
|
10255
10259
|
*/
|
|
10256
10260
|
export declare const isLessThanOrEqualToDateReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10265,7 +10269,7 @@ export declare const isLessThanOrEqualToDateReviver: SchemaRepresentation.Filter
|
|
|
10265
10269
|
*
|
|
10266
10270
|
* @see {@link isBetweenDate} for creating the corresponding check
|
|
10267
10271
|
*
|
|
10268
|
-
* @category
|
|
10272
|
+
* @category validation
|
|
10269
10273
|
* @since 4.0.0
|
|
10270
10274
|
*/
|
|
10271
10275
|
export declare const isBetweenDateReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10283,7 +10287,7 @@ export declare const isBetweenDateReviver: SchemaRepresentation.FilterReviver<{
|
|
|
10283
10287
|
*
|
|
10284
10288
|
* @see {@link isGreaterThanBigInt} for creating the corresponding check
|
|
10285
10289
|
*
|
|
10286
|
-
* @category
|
|
10290
|
+
* @category validation
|
|
10287
10291
|
* @since 4.0.0
|
|
10288
10292
|
*/
|
|
10289
10293
|
export declare const isGreaterThanBigIntReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10298,7 +10302,7 @@ export declare const isGreaterThanBigIntReviver: SchemaRepresentation.FilterRevi
|
|
|
10298
10302
|
*
|
|
10299
10303
|
* @see {@link isGreaterThanOrEqualToBigInt} for creating the corresponding check
|
|
10300
10304
|
*
|
|
10301
|
-
* @category
|
|
10305
|
+
* @category validation
|
|
10302
10306
|
* @since 4.0.0
|
|
10303
10307
|
*/
|
|
10304
10308
|
export declare const isGreaterThanOrEqualToBigIntReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10313,7 +10317,7 @@ export declare const isGreaterThanOrEqualToBigIntReviver: SchemaRepresentation.F
|
|
|
10313
10317
|
*
|
|
10314
10318
|
* @see {@link isLessThanBigInt} for creating the corresponding check
|
|
10315
10319
|
*
|
|
10316
|
-
* @category
|
|
10320
|
+
* @category validation
|
|
10317
10321
|
* @since 4.0.0
|
|
10318
10322
|
*/
|
|
10319
10323
|
export declare const isLessThanBigIntReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10328,7 +10332,7 @@ export declare const isLessThanBigIntReviver: SchemaRepresentation.FilterReviver
|
|
|
10328
10332
|
*
|
|
10329
10333
|
* @see {@link isLessThanOrEqualToBigInt} for creating the corresponding check
|
|
10330
10334
|
*
|
|
10331
|
-
* @category
|
|
10335
|
+
* @category validation
|
|
10332
10336
|
* @since 4.0.0
|
|
10333
10337
|
*/
|
|
10334
10338
|
export declare const isLessThanOrEqualToBigIntReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10343,7 +10347,7 @@ export declare const isLessThanOrEqualToBigIntReviver: SchemaRepresentation.Filt
|
|
|
10343
10347
|
*
|
|
10344
10348
|
* @see {@link isBetweenBigInt} for creating the corresponding check
|
|
10345
10349
|
*
|
|
10346
|
-
* @category
|
|
10350
|
+
* @category validation
|
|
10347
10351
|
* @since 4.0.0
|
|
10348
10352
|
*/
|
|
10349
10353
|
export declare const isBetweenBigIntReviver: SchemaRepresentation.FilterReviver<{
|
|
@@ -10356,28 +10360,28 @@ export declare const isBetweenBigIntReviver: SchemaRepresentation.FilterReviver<
|
|
|
10356
10360
|
* Derives an `Iso` optic from a schema that isomorphically converts between
|
|
10357
10361
|
* the schema's `Type` and its `Iso` (intermediate / serialized form).
|
|
10358
10362
|
*
|
|
10359
|
-
* @category
|
|
10363
|
+
* @category converting
|
|
10360
10364
|
* @since 4.0.0
|
|
10361
10365
|
*/
|
|
10362
10366
|
export declare function toIso<S extends Constraint>(schema: S): Optic_.Iso<S["Type"], S["Iso"]>;
|
|
10363
10367
|
/**
|
|
10364
10368
|
* Returns an identity `Iso` over the schema's source (`Type`) side.
|
|
10365
10369
|
*
|
|
10366
|
-
* @category
|
|
10370
|
+
* @category constructors
|
|
10367
10371
|
* @since 4.0.0
|
|
10368
10372
|
*/
|
|
10369
10373
|
export declare function toIsoSource<S extends Constraint>(_: S): Optic_.Iso<S["Type"], S["Type"]>;
|
|
10370
10374
|
/**
|
|
10371
10375
|
* Returns an identity `Iso` over the schema's focus (`Iso`) side.
|
|
10372
10376
|
*
|
|
10373
|
-
* @category
|
|
10377
|
+
* @category constructors
|
|
10374
10378
|
* @since 4.0.0
|
|
10375
10379
|
*/
|
|
10376
10380
|
export declare function toIsoFocus<S extends Constraint>(_: S): Optic_.Iso<S["Iso"], S["Iso"]>;
|
|
10377
10381
|
/**
|
|
10378
10382
|
* Type-level representation returned by {@link overrideToCodecIso}.
|
|
10379
10383
|
*
|
|
10380
|
-
* @category
|
|
10384
|
+
* @category transforming
|
|
10381
10385
|
* @since 4.0.0
|
|
10382
10386
|
*/
|
|
10383
10387
|
export interface overrideToCodecIso<S extends Constraint, Iso> extends BottomLazy<S["ast"], overrideToCodecIso<S, Iso>, S["~type.parameters"], S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]> {
|
|
@@ -10404,7 +10408,7 @@ export interface overrideToCodecIso<S extends Constraint, Iso> extends BottomLaz
|
|
|
10404
10408
|
* provided `decode` and `encode` getters to transform between the schema type
|
|
10405
10409
|
* and the target codec.
|
|
10406
10410
|
*
|
|
10407
|
-
* @category
|
|
10411
|
+
* @category transforming
|
|
10408
10412
|
* @since 4.0.0
|
|
10409
10413
|
*/
|
|
10410
10414
|
export declare function overrideToCodecIso<S extends Constraint, Iso>(to: ConstraintCodec<Iso>, transformation: {
|
|
@@ -10424,7 +10428,7 @@ export declare function toDifferJsonPatch<T>(schema: ConstraintCodec<T, unknown>
|
|
|
10424
10428
|
* Recursive tree type whose leaves are `Node` values and whose branches are
|
|
10425
10429
|
* readonly arrays or string-keyed records of child trees.
|
|
10426
10430
|
*
|
|
10427
|
-
* @category
|
|
10431
|
+
* @category models
|
|
10428
10432
|
* @since 4.0.0
|
|
10429
10433
|
*/
|
|
10430
10434
|
export type Tree<Node> = Node | TreeRecord<Node> | ReadonlyArray<Tree<Node>>;
|
|
@@ -10432,7 +10436,7 @@ export type Tree<Node> = Node | TreeRecord<Node> | ReadonlyArray<Tree<Node>>;
|
|
|
10432
10436
|
* A record node in a {@link Tree}: an object mapping string keys to child
|
|
10433
10437
|
* `Tree` nodes.
|
|
10434
10438
|
*
|
|
10435
|
-
* @category
|
|
10439
|
+
* @category models
|
|
10436
10440
|
* @since 4.0.0
|
|
10437
10441
|
*/
|
|
10438
10442
|
export interface TreeRecord<A> {
|
|
@@ -10443,7 +10447,7 @@ export interface TreeRecord<A> {
|
|
|
10443
10447
|
* The resulting schema accepts a single node value, an array of trees, or an
|
|
10444
10448
|
* object whose values are trees.
|
|
10445
10449
|
*
|
|
10446
|
-
* @category
|
|
10450
|
+
* @category schemas
|
|
10447
10451
|
* @since 4.0.0
|
|
10448
10452
|
*/
|
|
10449
10453
|
export declare function Tree<S extends Constraint>(node: S): Union<readonly [S, $Array<suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>, $Record<String, suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>]>;
|
|
@@ -10479,11 +10483,10 @@ export interface JsonObject {
|
|
|
10479
10483
|
*
|
|
10480
10484
|
* **Example** (Validating a JSON value)
|
|
10481
10485
|
*
|
|
10482
|
-
* ```ts
|
|
10483
|
-
* import { Schema } from "effect"
|
|
10486
|
+
* ```ts import.meta.vitest
|
|
10487
|
+
* import { Option, Schema } from "effect"
|
|
10484
10488
|
*
|
|
10485
|
-
*
|
|
10486
|
-
* console.log(result._tag) // "Some"
|
|
10489
|
+
* Schema.decodeUnknownOption(Schema.Json)({ key: [1, true, null] }) // => Option.some({ key: [1, true, null] })
|
|
10487
10490
|
* ```
|
|
10488
10491
|
*
|
|
10489
10492
|
* @category schemas
|
|
@@ -10555,7 +10558,7 @@ export declare const MutableJsonReviver: SchemaRepresentation.DeclarationReviver
|
|
|
10555
10558
|
* annotations are taken from the last check; otherwise they are taken from
|
|
10556
10559
|
* the base schema instance.
|
|
10557
10560
|
*
|
|
10558
|
-
* @category
|
|
10561
|
+
* @category getters
|
|
10559
10562
|
* @since 4.0.0
|
|
10560
10563
|
*/
|
|
10561
10564
|
export declare function resolveAnnotations<S extends Constraint>(schema: S): Annotations.Bottom<S["Type"], S["~type.parameters"]> | undefined;
|
|
@@ -10564,7 +10567,7 @@ export declare function resolveAnnotations<S extends Constraint>(schema: S): Ann
|
|
|
10564
10567
|
* annotations are those attached via `annotateKey` and live on the AST's
|
|
10565
10568
|
* `context` rather than on the schema node itself.
|
|
10566
10569
|
*
|
|
10567
|
-
* @category
|
|
10570
|
+
* @category getters
|
|
10568
10571
|
* @since 4.0.0
|
|
10569
10572
|
*/
|
|
10570
10573
|
export declare function resolveAnnotationsKey<S extends Constraint>(schema: S): Annotations.Key<S["Type"]> | undefined;
|
|
@@ -10594,7 +10597,7 @@ export declare namespace Annotations {
|
|
|
10594
10597
|
*
|
|
10595
10598
|
* **Example** (Defining your own annotations)
|
|
10596
10599
|
*
|
|
10597
|
-
* ```ts
|
|
10600
|
+
* ```ts import.meta.vitest
|
|
10598
10601
|
* import { Schema } from "effect"
|
|
10599
10602
|
*
|
|
10600
10603
|
* // Extend the Annotations interface with a custom `version` annotation
|
|
@@ -10616,8 +10619,7 @@ export declare namespace Annotations {
|
|
|
10616
10619
|
*
|
|
10617
10620
|
* if (version) {
|
|
10618
10621
|
* // Access individual parts of the version
|
|
10619
|
-
*
|
|
10620
|
-
* // Output: 2
|
|
10622
|
+
* version[1] // => 2
|
|
10621
10623
|
* }
|
|
10622
10624
|
* ```
|
|
10623
10625
|
*
|
|
@@ -10644,7 +10646,7 @@ export declare namespace Annotations {
|
|
|
10644
10646
|
* `message` first, then `expected`, and finally falls back to `<filter>`.
|
|
10645
10647
|
*
|
|
10646
10648
|
* Use this to name a failed filter in the default message:
|
|
10647
|
-
* `Expected <expected
|
|
10649
|
+
* `Expected <expected>`.
|
|
10648
10650
|
*/
|
|
10649
10651
|
readonly expected?: string | undefined;
|
|
10650
10652
|
readonly title?: string | undefined;
|
|
@@ -10700,7 +10702,7 @@ export declare namespace Annotations {
|
|
|
10700
10702
|
* only changing the expected label. For a filter or refinement failure,
|
|
10701
10703
|
* annotate the filter with `message` to replace the whole filter failure
|
|
10702
10704
|
* message, or `expected` to keep the default
|
|
10703
|
-
* `Expected <expected
|
|
10705
|
+
* `Expected <expected>` shape.
|
|
10704
10706
|
*/
|
|
10705
10707
|
readonly message?: string | undefined;
|
|
10706
10708
|
/**
|
|
@@ -10715,7 +10717,7 @@ export declare namespace Annotations {
|
|
|
10715
10717
|
* Identifiers are used by schema tooling, including JSON Schema
|
|
10716
10718
|
* generation, to name references. The default formatter also uses
|
|
10717
10719
|
* `identifier` as the expected label for type-level failures, such as
|
|
10718
|
-
* `Expected UserId
|
|
10720
|
+
* `Expected UserId`.
|
|
10719
10721
|
*
|
|
10720
10722
|
* `identifier` does not name a failed filter or refinement. If the base
|
|
10721
10723
|
* type matches and a filter fails, put `expected` or `message` on the
|