effect 4.0.0-beta.67 → 4.0.0-beta.68
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 +41 -42
- package/dist/Array.d.ts.map +1 -1
- package/dist/Array.js +23 -23
- package/dist/Array.js.map +1 -1
- package/dist/BigDecimal.d.ts +265 -265
- package/dist/BigDecimal.js +128 -128
- package/dist/BigInt.d.ts +175 -177
- package/dist/BigInt.d.ts.map +1 -1
- package/dist/BigInt.js +81 -79
- package/dist/BigInt.js.map +1 -1
- package/dist/Boolean.d.ts +127 -125
- package/dist/Boolean.d.ts.map +1 -1
- package/dist/Boolean.js +55 -53
- package/dist/Boolean.js.map +1 -1
- package/dist/Brand.d.ts +10 -4
- package/dist/Brand.d.ts.map +1 -1
- package/dist/Brand.js +3 -2
- package/dist/Brand.js.map +1 -1
- package/dist/Cache.d.ts +36 -36
- package/dist/Cache.js +17 -17
- package/dist/Cause.d.ts +17 -18
- package/dist/Cause.d.ts.map +1 -1
- package/dist/Cause.js +12 -12
- package/dist/Cause.js.map +1 -1
- package/dist/Channel.d.ts +234 -241
- package/dist/Channel.d.ts.map +1 -1
- package/dist/Channel.js +97 -101
- package/dist/Channel.js.map +1 -1
- package/dist/Chunk.d.ts +33 -56
- package/dist/Chunk.d.ts.map +1 -1
- package/dist/Chunk.js +17 -26
- package/dist/Chunk.js.map +1 -1
- package/dist/Clock.d.ts +1 -1
- package/dist/Clock.js +1 -1
- package/dist/Combiner.d.ts +9 -1
- package/dist/Combiner.d.ts.map +1 -1
- package/dist/Combiner.js +8 -0
- package/dist/Combiner.js.map +1 -1
- package/dist/Config.d.ts +78 -68
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js +53 -49
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.d.ts +33 -32
- package/dist/ConfigProvider.d.ts.map +1 -1
- package/dist/ConfigProvider.js +19 -18
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Console.d.ts +19 -19
- package/dist/Console.js +19 -19
- package/dist/Context.d.ts +70 -108
- package/dist/Context.d.ts.map +1 -1
- package/dist/Context.js +30 -44
- package/dist/Context.js.map +1 -1
- package/dist/Cron.d.ts +3 -5
- package/dist/Cron.d.ts.map +1 -1
- package/dist/Cron.js +3 -5
- package/dist/Cron.js.map +1 -1
- package/dist/Crypto.d.ts +208 -0
- package/dist/Crypto.d.ts.map +1 -0
- package/dist/Crypto.js +157 -0
- package/dist/Crypto.js.map +1 -0
- package/dist/Data.d.ts +6 -1
- package/dist/Data.d.ts.map +1 -1
- package/dist/Data.js.map +1 -1
- package/dist/DateTime.d.ts +29 -31
- package/dist/DateTime.d.ts.map +1 -1
- package/dist/DateTime.js +19 -19
- package/dist/DateTime.js.map +1 -1
- package/dist/Deferred.d.ts +8 -9
- package/dist/Deferred.d.ts.map +1 -1
- package/dist/Deferred.js +6 -6
- package/dist/Deferred.js.map +1 -1
- package/dist/Differ.d.ts +2 -2
- package/dist/Duration.d.ts +30 -27
- package/dist/Duration.d.ts.map +1 -1
- package/dist/Duration.js +15 -12
- package/dist/Duration.js.map +1 -1
- package/dist/Effect.d.ts +394 -652
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effect.js +157 -247
- package/dist/Effect.js.map +1 -1
- package/dist/Effectable.d.ts +2 -2
- package/dist/Effectable.js +2 -2
- package/dist/Encoding.d.ts +9 -9
- package/dist/Encoding.js +9 -9
- package/dist/Equal.d.ts +4 -3
- package/dist/Equal.d.ts.map +1 -1
- package/dist/Equal.js +4 -3
- package/dist/Equal.js.map +1 -1
- package/dist/Equivalence.d.ts +4 -5
- package/dist/Equivalence.d.ts.map +1 -1
- package/dist/Equivalence.js +2 -2
- package/dist/Equivalence.js.map +1 -1
- package/dist/ErrorReporter.d.ts +14 -14
- package/dist/ErrorReporter.js +9 -9
- package/dist/ExecutionPlan.d.ts +18 -9
- package/dist/ExecutionPlan.d.ts.map +1 -1
- package/dist/ExecutionPlan.js +6 -4
- package/dist/ExecutionPlan.js.map +1 -1
- package/dist/Exit.d.ts +0 -1
- package/dist/Exit.d.ts.map +1 -1
- package/dist/Exit.js.map +1 -1
- package/dist/Fiber.d.ts +1 -2
- package/dist/Fiber.d.ts.map +1 -1
- package/dist/Fiber.js +1 -1
- package/dist/Fiber.js.map +1 -1
- package/dist/FiberHandle.d.ts +5 -5
- package/dist/FiberHandle.js +3 -3
- package/dist/FiberMap.d.ts +10 -10
- package/dist/FiberMap.js +4 -4
- package/dist/FiberSet.d.ts +4 -4
- package/dist/FiberSet.js +2 -2
- package/dist/FileSystem.d.ts +10 -12
- package/dist/FileSystem.d.ts.map +1 -1
- package/dist/FileSystem.js +3 -3
- package/dist/FileSystem.js.map +1 -1
- package/dist/Filter.d.ts +54 -54
- package/dist/Filter.js +28 -28
- package/dist/Formatter.d.ts +4 -2
- package/dist/Formatter.d.ts.map +1 -1
- package/dist/Formatter.js +3 -69
- package/dist/Formatter.js.map +1 -1
- package/dist/Function.d.ts +64 -65
- package/dist/Function.d.ts.map +1 -1
- package/dist/Function.js +41 -41
- package/dist/Function.js.map +1 -1
- package/dist/Graph.d.ts +157 -175
- package/dist/Graph.d.ts.map +1 -1
- package/dist/Graph.js +72 -80
- package/dist/Graph.js.map +1 -1
- package/dist/Hash.d.ts +4 -6
- package/dist/Hash.d.ts.map +1 -1
- package/dist/Hash.js +2 -2
- package/dist/Hash.js.map +1 -1
- package/dist/HashMap.d.ts +121 -157
- package/dist/HashMap.d.ts.map +1 -1
- package/dist/HashMap.js +47 -59
- package/dist/HashMap.js.map +1 -1
- package/dist/HashRing.d.ts +34 -34
- package/dist/HashRing.js +16 -16
- package/dist/HashSet.d.ts +51 -55
- package/dist/HashSet.d.ts.map +1 -1
- package/dist/HashSet.js +19 -20
- package/dist/HashSet.js.map +1 -1
- package/dist/Inspectable.d.ts +6 -4
- package/dist/Inspectable.d.ts.map +1 -1
- package/dist/Inspectable.js +6 -4
- package/dist/Inspectable.js.map +1 -1
- package/dist/Iterable.d.ts +37 -83
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Iterable.js +21 -39
- package/dist/Iterable.js.map +1 -1
- package/dist/JsonPatch.d.ts +8 -6
- package/dist/JsonPatch.d.ts.map +1 -1
- package/dist/JsonPatch.js +5 -3
- package/dist/JsonPatch.js.map +1 -1
- package/dist/JsonPointer.d.ts +13 -11
- package/dist/JsonPointer.d.ts.map +1 -1
- package/dist/JsonPointer.js +13 -11
- package/dist/JsonPointer.js.map +1 -1
- package/dist/JsonSchema.d.ts +16 -0
- package/dist/JsonSchema.d.ts.map +1 -1
- package/dist/JsonSchema.js +10 -0
- package/dist/JsonSchema.js.map +1 -1
- package/dist/Latch.d.ts +4 -16
- package/dist/Latch.d.ts.map +1 -1
- package/dist/Latch.js +2 -14
- package/dist/Latch.js.map +1 -1
- package/dist/Layer.d.ts +94 -135
- package/dist/Layer.d.ts.map +1 -1
- package/dist/Layer.js +44 -61
- package/dist/Layer.js.map +1 -1
- package/dist/LayerMap.d.ts +15 -16
- package/dist/LayerMap.d.ts.map +1 -1
- package/dist/LayerMap.js +6 -6
- package/dist/LogLevel.d.ts +13 -13
- package/dist/LogLevel.js +4 -4
- package/dist/Logger.d.ts +10 -11
- package/dist/Logger.d.ts.map +1 -1
- package/dist/Logger.js +10 -11
- package/dist/Logger.js.map +1 -1
- package/dist/ManagedRuntime.d.ts +5 -4
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/ManagedRuntime.js +4 -3
- package/dist/ManagedRuntime.js.map +1 -1
- package/dist/Match.d.ts +2 -4
- package/dist/Match.d.ts.map +1 -1
- package/dist/Match.js +1 -2
- package/dist/Match.js.map +1 -1
- package/dist/Metric.d.ts +48 -50
- package/dist/Metric.d.ts.map +1 -1
- package/dist/Metric.js +22 -22
- package/dist/Metric.js.map +1 -1
- package/dist/MutableHashMap.d.ts +30 -30
- package/dist/MutableHashMap.d.ts.map +1 -1
- package/dist/MutableHashMap.js +15 -14
- package/dist/MutableHashMap.js.map +1 -1
- package/dist/MutableHashSet.d.ts.map +1 -1
- package/dist/MutableHashSet.js +0 -2
- package/dist/MutableHashSet.js.map +1 -1
- package/dist/MutableList.d.ts +23 -24
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableList.js +17 -19
- package/dist/MutableList.js.map +1 -1
- package/dist/MutableRef.d.ts.map +1 -1
- package/dist/MutableRef.js +0 -1
- package/dist/MutableRef.js.map +1 -1
- package/dist/Newtype.d.ts +12 -2
- package/dist/Newtype.d.ts.map +1 -1
- package/dist/Newtype.js +8 -2
- package/dist/Newtype.js.map +1 -1
- package/dist/NonEmptyIterable.d.ts +5 -12
- package/dist/NonEmptyIterable.d.ts.map +1 -1
- package/dist/NonEmptyIterable.js +3 -8
- package/dist/NonEmptyIterable.js.map +1 -1
- package/dist/Number.d.ts +145 -141
- package/dist/Number.d.ts.map +1 -1
- package/dist/Number.js +65 -61
- package/dist/Number.js.map +1 -1
- package/dist/Optic.d.ts +5 -5
- package/dist/Optic.js +5 -5
- package/dist/Option.d.ts +105 -109
- package/dist/Option.d.ts.map +1 -1
- package/dist/Option.js +50 -52
- package/dist/Option.js.map +1 -1
- package/dist/Order.d.ts +6 -6
- package/dist/Order.js +6 -6
- package/dist/Ordering.d.ts +15 -19
- package/dist/Ordering.d.ts.map +1 -1
- package/dist/Ordering.js +6 -6
- package/dist/Ordering.js.map +1 -1
- package/dist/PartitionedSemaphore.d.ts +3 -3
- package/dist/PartitionedSemaphore.js +2 -2
- package/dist/Path.d.ts +4 -4
- package/dist/Path.d.ts.map +1 -1
- package/dist/Path.js +2 -1
- package/dist/Path.js.map +1 -1
- package/dist/Pipeable.d.ts +10 -7
- package/dist/Pipeable.d.ts.map +1 -1
- package/dist/Pipeable.js +6 -4
- package/dist/Pipeable.js.map +1 -1
- package/dist/PlatformError.d.ts +3 -3
- package/dist/PlatformError.js +2 -2
- package/dist/Predicate.d.ts +2 -4
- package/dist/Predicate.d.ts.map +1 -1
- package/dist/Predicate.js +3 -3
- package/dist/Predicate.js.map +1 -1
- package/dist/PrimaryKey.d.ts +2 -1
- package/dist/PrimaryKey.d.ts.map +1 -1
- package/dist/PrimaryKey.js +2 -1
- package/dist/PrimaryKey.js.map +1 -1
- package/dist/PubSub.d.ts +25 -51
- package/dist/PubSub.d.ts.map +1 -1
- package/dist/PubSub.js +17 -35
- package/dist/PubSub.js.map +1 -1
- package/dist/Queue.d.ts +45 -60
- package/dist/Queue.d.ts.map +1 -1
- package/dist/Queue.js +27 -33
- package/dist/Queue.js.map +1 -1
- package/dist/Random.d.ts +27 -38
- package/dist/Random.d.ts.map +1 -1
- package/dist/Random.js +17 -54
- package/dist/Random.js.map +1 -1
- package/dist/RcMap.d.ts +11 -11
- package/dist/RcMap.js +3 -3
- package/dist/RcRef.d.ts +0 -1
- package/dist/RcRef.d.ts.map +1 -1
- package/dist/RcRef.js.map +1 -1
- package/dist/Record.d.ts +9 -8
- package/dist/Record.d.ts.map +1 -1
- package/dist/Record.js +7 -5
- package/dist/Record.js.map +1 -1
- package/dist/Redactable.d.ts +7 -5
- package/dist/Redactable.d.ts.map +1 -1
- package/dist/Redactable.js +5 -3
- package/dist/Redactable.js.map +1 -1
- package/dist/Redacted.d.ts +2 -3
- package/dist/Redacted.d.ts.map +1 -1
- package/dist/Redacted.js +2 -2
- package/dist/Redacted.js.map +1 -1
- package/dist/Reducer.d.ts +3 -1
- package/dist/Reducer.d.ts.map +1 -1
- package/dist/Reducer.js +2 -0
- package/dist/Reducer.js.map +1 -1
- package/dist/Ref.d.ts +7 -17
- package/dist/Ref.d.ts.map +1 -1
- package/dist/Ref.js +5 -12
- package/dist/Ref.js.map +1 -1
- package/dist/RegExp.d.ts +1 -1
- package/dist/RegExp.js +1 -1
- package/dist/Request.d.ts +2 -1
- package/dist/Request.d.ts.map +1 -1
- package/dist/Request.js +1 -0
- package/dist/Request.js.map +1 -1
- package/dist/RequestResolver.d.ts +2 -3
- package/dist/RequestResolver.d.ts.map +1 -1
- package/dist/RequestResolver.js +1 -1
- package/dist/RequestResolver.js.map +1 -1
- package/dist/Resource.d.ts +1 -1
- package/dist/Resource.js +1 -1
- package/dist/Result.d.ts +124 -142
- package/dist/Result.d.ts.map +1 -1
- package/dist/Result.js +51 -63
- package/dist/Result.js.map +1 -1
- package/dist/Runtime.d.ts +2 -7
- package/dist/Runtime.d.ts.map +1 -1
- package/dist/Runtime.js +1 -3
- package/dist/Runtime.js.map +1 -1
- package/dist/Schedule.d.ts +69 -72
- package/dist/Schedule.d.ts.map +1 -1
- package/dist/Schedule.js +31 -33
- package/dist/Schedule.js.map +1 -1
- package/dist/Scheduler.d.ts +2 -2
- package/dist/Scheduler.js +2 -2
- package/dist/Schema.d.ts +491 -321
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +220 -172
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +98 -77
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +89 -68
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaGetter.d.ts +23 -23
- package/dist/SchemaGetter.js +20 -20
- package/dist/SchemaIssue.d.ts +18 -16
- package/dist/SchemaIssue.d.ts.map +1 -1
- package/dist/SchemaIssue.js +16 -14
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts +39 -40
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaParser.js +48 -51
- package/dist/SchemaParser.js.map +1 -1
- package/dist/SchemaRepresentation.d.ts +89 -77
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +47 -37
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +36 -5
- package/dist/SchemaTransformation.d.ts.map +1 -1
- package/dist/SchemaTransformation.js +33 -5
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/SchemaUtils.d.ts +1 -1
- package/dist/SchemaUtils.js +1 -1
- package/dist/Scope.d.ts +12 -29
- package/dist/Scope.d.ts.map +1 -1
- package/dist/Scope.js +6 -11
- package/dist/Scope.js.map +1 -1
- package/dist/ScopedCache.d.ts +37 -37
- package/dist/ScopedCache.js +17 -17
- package/dist/Semaphore.d.ts +4 -16
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Semaphore.js +2 -14
- package/dist/Semaphore.js.map +1 -1
- package/dist/Sink.d.ts +36 -39
- package/dist/Sink.d.ts.map +1 -1
- package/dist/Sink.js +18 -18
- package/dist/Sink.js.map +1 -1
- package/dist/Stdio.d.ts +6 -6
- package/dist/Stdio.js +4 -4
- package/dist/Stream.d.ts +671 -808
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +289 -363
- package/dist/Stream.js.map +1 -1
- package/dist/String.d.ts +3 -2
- package/dist/String.d.ts.map +1 -1
- package/dist/String.js +3 -2
- package/dist/String.js.map +1 -1
- package/dist/Struct.d.ts +20 -18
- package/dist/Struct.d.ts.map +1 -1
- package/dist/Struct.js +10 -8
- package/dist/Struct.js.map +1 -1
- package/dist/SubscriptionRef.d.ts +2 -2
- package/dist/SubscriptionRef.js +2 -2
- package/dist/Symbol.d.ts +3 -3
- package/dist/Symbol.js +3 -3
- package/dist/SynchronizedRef.d.ts +1 -1
- package/dist/SynchronizedRef.js +1 -1
- package/dist/Take.d.ts +2 -2
- package/dist/Take.js +1 -1
- package/dist/Terminal.d.ts +5 -5
- package/dist/Terminal.js +2 -2
- package/dist/Tracer.d.ts +9 -9
- package/dist/Tracer.js +2 -2
- package/dist/Trie.d.ts +70 -106
- package/dist/Trie.d.ts.map +1 -1
- package/dist/Trie.js +29 -43
- package/dist/Trie.js.map +1 -1
- package/dist/Tuple.d.ts +34 -32
- package/dist/Tuple.d.ts.map +1 -1
- package/dist/Tuple.js +16 -14
- package/dist/Tuple.js.map +1 -1
- package/dist/TxChunk.d.ts +27 -18
- package/dist/TxChunk.d.ts.map +1 -1
- package/dist/TxChunk.js +15 -10
- package/dist/TxChunk.js.map +1 -1
- package/dist/TxDeferred.d.ts +11 -11
- package/dist/TxDeferred.js +5 -5
- package/dist/TxHashMap.d.ts +60 -61
- package/dist/TxHashMap.d.ts.map +1 -1
- package/dist/TxHashMap.js +23 -23
- package/dist/TxHashMap.js.map +1 -1
- package/dist/TxHashSet.d.ts +28 -32
- package/dist/TxHashSet.d.ts.map +1 -1
- package/dist/TxHashSet.js +13 -16
- package/dist/TxHashSet.js.map +1 -1
- package/dist/TxPriorityQueue.d.ts +30 -30
- package/dist/TxPriorityQueue.js +18 -18
- package/dist/TxPubSub.d.ts +18 -18
- package/dist/TxPubSub.js +14 -14
- package/dist/TxQueue.d.ts +26 -29
- package/dist/TxQueue.d.ts.map +1 -1
- package/dist/TxQueue.js +17 -17
- package/dist/TxQueue.js.map +1 -1
- package/dist/TxReentrantLock.d.ts +21 -21
- package/dist/TxReentrantLock.js +15 -15
- package/dist/TxRef.d.ts +24 -24
- package/dist/TxRef.js +11 -11
- package/dist/TxSemaphore.d.ts +13 -74
- package/dist/TxSemaphore.d.ts.map +1 -1
- package/dist/TxSemaphore.js +9 -52
- package/dist/TxSemaphore.js.map +1 -1
- package/dist/TxSubscriptionRef.d.ts +24 -24
- package/dist/TxSubscriptionRef.js +11 -11
- package/dist/Types.d.ts +1 -4
- package/dist/Types.d.ts.map +1 -1
- package/dist/UndefinedOr.d.ts +14 -0
- package/dist/UndefinedOr.d.ts.map +1 -1
- package/dist/UndefinedOr.js +8 -0
- package/dist/UndefinedOr.js.map +1 -1
- package/dist/Unify.d.ts +8 -8
- package/dist/Unify.js +1 -1
- package/dist/Utils.d.ts +1 -2
- package/dist/Utils.d.ts.map +1 -1
- package/dist/Utils.js.map +1 -1
- package/dist/index.d.ts +1917 -411
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1917 -411
- package/dist/index.js.map +1 -1
- package/dist/testing/FastCheck.d.ts +3 -3
- package/dist/testing/FastCheck.js +3 -3
- package/dist/testing/TestClock.d.ts +2 -3
- package/dist/testing/TestClock.d.ts.map +1 -1
- package/dist/testing/TestClock.js +1 -1
- package/dist/testing/TestClock.js.map +1 -1
- package/dist/testing/TestConsole.d.ts +8 -9
- package/dist/testing/TestConsole.d.ts.map +1 -1
- package/dist/testing/TestConsole.js +5 -5
- package/dist/testing/TestConsole.js.map +1 -1
- package/dist/testing/TestSchema.d.ts +2 -0
- package/dist/testing/TestSchema.d.ts.map +1 -1
- package/dist/testing/TestSchema.js +2 -0
- package/dist/testing/TestSchema.js.map +1 -1
- package/dist/testing/index.d.ts +34 -0
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +34 -0
- package/dist/testing/index.js.map +1 -1
- package/dist/unstable/ai/AiError.d.ts +10 -19
- package/dist/unstable/ai/AiError.d.ts.map +1 -1
- package/dist/unstable/ai/AiError.js +0 -9
- package/dist/unstable/ai/AiError.js.map +1 -1
- package/dist/unstable/ai/Chat.d.ts +0 -1
- package/dist/unstable/ai/Chat.d.ts.map +1 -1
- package/dist/unstable/ai/Chat.js.map +1 -1
- package/dist/unstable/ai/McpSchema.d.ts +3 -0
- package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
- package/dist/unstable/ai/McpSchema.js +2 -0
- package/dist/unstable/ai/McpSchema.js.map +1 -1
- package/dist/unstable/ai/McpServer.d.ts +3 -1
- package/dist/unstable/ai/McpServer.d.ts.map +1 -1
- package/dist/unstable/ai/McpServer.js +1 -1
- package/dist/unstable/ai/McpServer.js.map +1 -1
- package/dist/unstable/ai/Model.d.ts +2 -6
- package/dist/unstable/ai/Model.d.ts.map +1 -1
- package/dist/unstable/ai/Model.js +2 -2
- package/dist/unstable/ai/Model.js.map +1 -1
- package/dist/unstable/ai/Prompt.d.ts +8 -10
- package/dist/unstable/ai/Prompt.d.ts.map +1 -1
- package/dist/unstable/ai/Prompt.js +4 -4
- package/dist/unstable/ai/Prompt.js.map +1 -1
- package/dist/unstable/ai/Response.d.ts +20 -20
- package/dist/unstable/ai/ResponseIdTracker.d.ts +1 -1
- package/dist/unstable/ai/ResponseIdTracker.js +1 -1
- package/dist/unstable/ai/Telemetry.d.ts +5 -5
- package/dist/unstable/ai/Telemetry.js +3 -3
- package/dist/unstable/ai/Tokenizer.d.ts +1 -1
- package/dist/unstable/ai/Tool.d.ts +14 -12
- package/dist/unstable/ai/Tool.d.ts.map +1 -1
- package/dist/unstable/ai/Tool.js +10 -9
- package/dist/unstable/ai/Tool.js.map +1 -1
- package/dist/unstable/ai/index.d.ts +79 -5
- package/dist/unstable/ai/index.d.ts.map +1 -1
- package/dist/unstable/ai/index.js +79 -5
- package/dist/unstable/ai/index.js.map +1 -1
- package/dist/unstable/cli/CliOutput.d.ts +5 -6
- package/dist/unstable/cli/CliOutput.d.ts.map +1 -1
- package/dist/unstable/cli/CliOutput.js +2 -3
- package/dist/unstable/cli/CliOutput.js.map +1 -1
- package/dist/unstable/cli/Command.d.ts +3 -3
- package/dist/unstable/cli/Command.js +1 -1
- package/dist/unstable/cli/HelpDoc.d.ts +4 -4
- package/dist/unstable/cli/Param.d.ts +31 -1
- package/dist/unstable/cli/Param.d.ts.map +1 -1
- package/dist/unstable/cli/Param.js +37 -38
- package/dist/unstable/cli/Param.js.map +1 -1
- package/dist/unstable/cli/Primitive.d.ts +1 -1
- package/dist/unstable/cli/Primitive.js +1 -1
- package/dist/unstable/cli/Prompt.d.ts +6 -14
- package/dist/unstable/cli/Prompt.d.ts.map +1 -1
- package/dist/unstable/cli/Prompt.js +2 -2
- package/dist/unstable/cli/Prompt.js.map +1 -1
- package/dist/unstable/cli/index.d.ts +182 -0
- package/dist/unstable/cli/index.d.ts.map +1 -1
- package/dist/unstable/cli/index.js +205 -6
- package/dist/unstable/cli/index.js.map +1 -1
- package/dist/unstable/cli/internal/parser.js +0 -1
- package/dist/unstable/cli/internal/parser.js.map +1 -1
- package/dist/unstable/cluster/ClusterCron.d.ts +1 -1
- package/dist/unstable/cluster/ClusterCron.js +1 -1
- package/dist/unstable/cluster/ClusterSchema.d.ts +8 -8
- package/dist/unstable/cluster/ClusterSchema.js +8 -8
- package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts +2 -2
- package/dist/unstable/cluster/ClusterWorkflowEngine.js +2 -2
- package/dist/unstable/cluster/Entity.d.ts +0 -1
- package/dist/unstable/cluster/Entity.d.ts.map +1 -1
- package/dist/unstable/cluster/Entity.js.map +1 -1
- package/dist/unstable/cluster/EntityProxy.d.ts +10 -14
- package/dist/unstable/cluster/EntityProxy.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxy.js +8 -14
- package/dist/unstable/cluster/EntityProxy.js.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.d.ts +3 -2
- package/dist/unstable/cluster/EntityProxyServer.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityProxyServer.js +2 -2
- package/dist/unstable/cluster/EntityResource.d.ts +2 -2
- package/dist/unstable/cluster/EntityResource.js +1 -1
- package/dist/unstable/cluster/Envelope.d.ts +1 -1
- package/dist/unstable/cluster/Envelope.js +1 -1
- package/dist/unstable/cluster/HttpRunner.d.ts +11 -11
- package/dist/unstable/cluster/HttpRunner.js +11 -11
- package/dist/unstable/cluster/K8sHttpClient.d.ts +5 -5
- package/dist/unstable/cluster/K8sHttpClient.js +5 -5
- package/dist/unstable/cluster/MachineId.d.ts +1 -1
- package/dist/unstable/cluster/MachineId.js +1 -1
- package/dist/unstable/cluster/MessageStorage.d.ts +1 -2
- package/dist/unstable/cluster/MessageStorage.d.ts.map +1 -1
- package/dist/unstable/cluster/MessageStorage.js +1 -1
- package/dist/unstable/cluster/MessageStorage.js.map +1 -1
- package/dist/unstable/cluster/Runner.d.ts +1 -1
- package/dist/unstable/cluster/Runner.js +1 -1
- package/dist/unstable/cluster/RunnerHealth.d.ts +2 -2
- package/dist/unstable/cluster/RunnerHealth.js +2 -2
- package/dist/unstable/cluster/RunnerServer.d.ts +4 -4
- package/dist/unstable/cluster/RunnerServer.js +4 -4
- package/dist/unstable/cluster/Runners.d.ts +3 -3
- package/dist/unstable/cluster/Runners.js +3 -3
- package/dist/unstable/cluster/ShardId.d.ts +7 -5
- package/dist/unstable/cluster/ShardId.d.ts.map +1 -1
- package/dist/unstable/cluster/ShardId.js +6 -4
- package/dist/unstable/cluster/ShardId.js.map +1 -1
- package/dist/unstable/cluster/Sharding.js +1 -1
- package/dist/unstable/cluster/ShardingConfig.d.ts +2 -2
- package/dist/unstable/cluster/ShardingConfig.js +2 -2
- package/dist/unstable/cluster/SingleRunner.d.ts +1 -1
- package/dist/unstable/cluster/SingleRunner.js +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts +10 -9
- package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
- package/dist/unstable/cluster/Snowflake.js +4 -3
- package/dist/unstable/cluster/Snowflake.js.map +1 -1
- package/dist/unstable/cluster/SocketRunner.d.ts +2 -2
- package/dist/unstable/cluster/SocketRunner.js +2 -2
- package/dist/unstable/cluster/SqlMessageStorage.d.ts +3 -3
- package/dist/unstable/cluster/SqlMessageStorage.js +3 -3
- package/dist/unstable/cluster/SqlRunnerStorage.d.ts +3 -3
- package/dist/unstable/cluster/SqlRunnerStorage.js +3 -3
- package/dist/unstable/cluster/TestRunner.d.ts +1 -1
- package/dist/unstable/cluster/TestRunner.js +1 -1
- package/dist/unstable/cluster/index.d.ts +790 -0
- package/dist/unstable/cluster/index.d.ts.map +1 -1
- package/dist/unstable/cluster/index.js +790 -0
- package/dist/unstable/cluster/index.js.map +1 -1
- package/dist/unstable/devtools/index.d.ts +58 -0
- package/dist/unstable/devtools/index.d.ts.map +1 -1
- package/dist/unstable/devtools/index.js +58 -0
- package/dist/unstable/devtools/index.js.map +1 -1
- package/dist/unstable/encoding/Sse.d.ts +16 -16
- package/dist/unstable/encoding/Sse.js +11 -11
- package/dist/unstable/encoding/index.d.ts +49 -0
- package/dist/unstable/encoding/index.d.ts.map +1 -1
- package/dist/unstable/encoding/index.js +49 -0
- package/dist/unstable/encoding/index.js.map +1 -1
- package/dist/unstable/eventlog/Event.d.ts +2 -2
- package/dist/unstable/eventlog/Event.js +1 -1
- package/dist/unstable/eventlog/EventGroup.d.ts +2 -2
- package/dist/unstable/eventlog/EventGroup.js +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts +6 -7
- package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
- package/dist/unstable/eventlog/EventLog.js +4 -4
- package/dist/unstable/eventlog/EventLog.js.map +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +2 -2
- package/dist/unstable/eventlog/EventLogRemote.js +2 -2
- package/dist/unstable/eventlog/EventLogServer.d.ts +2 -2
- package/dist/unstable/eventlog/EventLogServer.js +2 -2
- package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +2 -2
- package/dist/unstable/eventlog/EventLogServerEncrypted.js +2 -2
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js +1 -1
- package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +1 -1
- package/dist/unstable/eventlog/index.d.ts +240 -0
- package/dist/unstable/eventlog/index.d.ts.map +1 -1
- package/dist/unstable/eventlog/index.js +240 -0
- package/dist/unstable/eventlog/index.js.map +1 -1
- package/dist/unstable/http/Cookies.d.ts +6 -6
- package/dist/unstable/http/Cookies.js +4 -4
- package/dist/unstable/http/Etag.d.ts +2 -2
- package/dist/unstable/http/Etag.js +2 -2
- package/dist/unstable/http/Headers.d.ts +2 -2
- package/dist/unstable/http/Headers.js +1 -1
- package/dist/unstable/http/HttpClient.d.ts +5 -6
- package/dist/unstable/http/HttpClient.d.ts.map +1 -1
- package/dist/unstable/http/HttpClient.js +5 -4
- package/dist/unstable/http/HttpClient.js.map +1 -1
- package/dist/unstable/http/HttpClientError.d.ts +1 -1
- package/dist/unstable/http/HttpClientError.js +1 -1
- package/dist/unstable/http/HttpClientRequest.d.ts +4 -4
- package/dist/unstable/http/HttpClientRequest.js +4 -4
- package/dist/unstable/http/HttpClientResponse.d.ts +6 -6
- package/dist/unstable/http/HttpClientResponse.js +6 -6
- package/dist/unstable/http/HttpEffect.d.ts +5 -5
- package/dist/unstable/http/HttpEffect.js +5 -5
- package/dist/unstable/http/HttpIncomingMessage.d.ts +7 -6
- package/dist/unstable/http/HttpIncomingMessage.d.ts.map +1 -1
- package/dist/unstable/http/HttpIncomingMessage.js +7 -6
- package/dist/unstable/http/HttpIncomingMessage.js.map +1 -1
- package/dist/unstable/http/HttpMethod.d.ts +4 -2
- package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
- package/dist/unstable/http/HttpMethod.js +4 -1
- package/dist/unstable/http/HttpMethod.js.map +1 -1
- package/dist/unstable/http/HttpMiddleware.d.ts +1 -0
- package/dist/unstable/http/HttpMiddleware.d.ts.map +1 -1
- package/dist/unstable/http/HttpMiddleware.js.map +1 -1
- package/dist/unstable/http/HttpRouter.d.ts +23 -25
- package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
- package/dist/unstable/http/HttpRouter.js +23 -22
- package/dist/unstable/http/HttpRouter.js.map +1 -1
- package/dist/unstable/http/HttpServerError.d.ts +4 -1
- package/dist/unstable/http/HttpServerError.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerError.js +4 -1
- package/dist/unstable/http/HttpServerError.js.map +1 -1
- package/dist/unstable/http/HttpServerRequest.d.ts +15 -15
- package/dist/unstable/http/HttpServerRequest.js +15 -15
- package/dist/unstable/http/HttpServerRespondable.d.ts +1 -1
- package/dist/unstable/http/HttpServerRespondable.js +1 -1
- package/dist/unstable/http/HttpServerResponse.d.ts +5 -4
- package/dist/unstable/http/HttpServerResponse.d.ts.map +1 -1
- package/dist/unstable/http/HttpServerResponse.js +5 -4
- package/dist/unstable/http/HttpServerResponse.js.map +1 -1
- package/dist/unstable/http/HttpStaticServer.d.ts +2 -4
- package/dist/unstable/http/HttpStaticServer.d.ts.map +1 -1
- package/dist/unstable/http/HttpStaticServer.js +2 -4
- package/dist/unstable/http/HttpStaticServer.js.map +1 -1
- package/dist/unstable/http/Multipart.d.ts +20 -19
- package/dist/unstable/http/Multipart.d.ts.map +1 -1
- package/dist/unstable/http/Multipart.js +19 -17
- package/dist/unstable/http/Multipart.js.map +1 -1
- package/dist/unstable/http/Template.d.ts +0 -1
- package/dist/unstable/http/Template.d.ts.map +1 -1
- package/dist/unstable/http/Template.js.map +1 -1
- package/dist/unstable/http/Url.d.ts +17 -17
- package/dist/unstable/http/Url.js +8 -8
- package/dist/unstable/http/UrlParams.d.ts +14 -12
- package/dist/unstable/http/UrlParams.d.ts.map +1 -1
- package/dist/unstable/http/UrlParams.js +12 -10
- package/dist/unstable/http/UrlParams.js.map +1 -1
- package/dist/unstable/http/index.d.ts +452 -0
- package/dist/unstable/http/index.d.ts.map +1 -1
- package/dist/unstable/http/index.js +452 -0
- package/dist/unstable/http/index.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts +0 -1
- package/dist/unstable/httpapi/HttpApiBuilder.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.d.ts +0 -1
- package/dist/unstable/httpapi/HttpApiClient.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiClient.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts +4 -2
- package/dist/unstable/httpapi/HttpApiMiddleware.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.js +3 -1
- package/dist/unstable/httpapi/HttpApiMiddleware.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiScalar.d.ts +2 -2
- package/dist/unstable/httpapi/HttpApiSchema.d.ts +19 -8
- package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSchema.js +11 -8
- package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.d.ts +0 -1
- package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.d.ts +0 -2
- package/dist/unstable/httpapi/HttpApiSwagger.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSwagger.js +0 -2
- package/dist/unstable/httpapi/HttpApiSwagger.js.map +1 -1
- package/dist/unstable/httpapi/index.d.ts +310 -25
- package/dist/unstable/httpapi/index.d.ts.map +1 -1
- package/dist/unstable/httpapi/index.js +310 -25
- package/dist/unstable/httpapi/index.js.map +1 -1
- package/dist/unstable/observability/Otlp.d.ts +3 -3
- package/dist/unstable/observability/Otlp.js +3 -3
- package/dist/unstable/observability/OtlpExporter.d.ts +1 -1
- package/dist/unstable/observability/OtlpExporter.js +1 -1
- package/dist/unstable/observability/OtlpLogger.d.ts +3 -2
- package/dist/unstable/observability/OtlpLogger.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpLogger.js +2 -2
- package/dist/unstable/observability/OtlpLogger.js.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.d.ts +5 -4
- package/dist/unstable/observability/OtlpMetrics.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpMetrics.js +2 -2
- package/dist/unstable/observability/OtlpMetrics.js.map +1 -1
- package/dist/unstable/observability/OtlpResource.d.ts +9 -9
- package/dist/unstable/observability/OtlpResource.js +2 -2
- package/dist/unstable/observability/OtlpSerialization.d.ts +3 -3
- package/dist/unstable/observability/OtlpSerialization.js +3 -3
- package/dist/unstable/observability/OtlpTracer.d.ts +5 -2
- package/dist/unstable/observability/OtlpTracer.d.ts.map +1 -1
- package/dist/unstable/observability/OtlpTracer.js +2 -2
- package/dist/unstable/observability/OtlpTracer.js.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.d.ts +7 -7
- package/dist/unstable/observability/PrometheusMetrics.js +2 -2
- package/dist/unstable/observability/index.d.ts +158 -2
- package/dist/unstable/observability/index.d.ts.map +1 -1
- package/dist/unstable/observability/index.js +158 -2
- package/dist/unstable/observability/index.js.map +1 -1
- package/dist/unstable/persistence/KeyValueStore.d.ts +4 -4
- package/dist/unstable/persistence/KeyValueStore.js +1 -1
- package/dist/unstable/persistence/Persistable.d.ts +11 -11
- package/dist/unstable/persistence/Persistable.js +1 -1
- package/dist/unstable/persistence/PersistedCache.d.ts +2 -2
- package/dist/unstable/persistence/PersistedCache.js +1 -1
- package/dist/unstable/persistence/PersistedQueue.d.ts +6 -6
- package/dist/unstable/persistence/PersistedQueue.js +3 -3
- package/dist/unstable/persistence/Persistence.d.ts +2 -1
- package/dist/unstable/persistence/Persistence.d.ts.map +1 -1
- package/dist/unstable/persistence/Persistence.js +2 -1
- package/dist/unstable/persistence/Persistence.js.map +1 -1
- package/dist/unstable/persistence/RateLimiter.d.ts +19 -15
- package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
- package/dist/unstable/persistence/RateLimiter.js +14 -10
- package/dist/unstable/persistence/RateLimiter.js.map +1 -1
- package/dist/unstable/persistence/Redis.d.ts +3 -3
- package/dist/unstable/persistence/Redis.js +3 -3
- package/dist/unstable/persistence/index.d.ts +147 -0
- package/dist/unstable/persistence/index.d.ts.map +1 -1
- package/dist/unstable/persistence/index.js +147 -0
- package/dist/unstable/persistence/index.js.map +1 -1
- package/dist/unstable/process/ChildProcess.d.ts +41 -41
- package/dist/unstable/process/ChildProcess.js +11 -11
- package/dist/unstable/process/ChildProcessSpawner.d.ts +10 -10
- package/dist/unstable/process/ChildProcessSpawner.js +5 -5
- package/dist/unstable/reactivity/AsyncResult.d.ts +8 -6
- package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
- package/dist/unstable/reactivity/AsyncResult.js +3 -3
- package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
- package/dist/unstable/reactivity/Atom.d.ts +25 -20
- package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
- package/dist/unstable/reactivity/Atom.js +12 -12
- package/dist/unstable/reactivity/Atom.js.map +1 -1
- package/dist/unstable/reactivity/AtomHttpApi.d.ts +2 -2
- package/dist/unstable/reactivity/AtomHttpApi.js +1 -1
- package/dist/unstable/reactivity/AtomRef.d.ts +2 -2
- package/dist/unstable/reactivity/AtomRef.js +1 -1
- package/dist/unstable/reactivity/AtomRegistry.d.ts +16 -16
- package/dist/unstable/reactivity/AtomRegistry.js +7 -7
- package/dist/unstable/reactivity/AtomRpc.d.ts +2 -2
- package/dist/unstable/reactivity/AtomRpc.js +1 -1
- package/dist/unstable/reactivity/Reactivity.d.ts +2 -3
- package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
- package/dist/unstable/reactivity/Reactivity.js +2 -3
- package/dist/unstable/reactivity/Reactivity.js.map +1 -1
- package/dist/unstable/reactivity/index.d.ts +167 -0
- package/dist/unstable/reactivity/index.d.ts.map +1 -1
- package/dist/unstable/reactivity/index.js +167 -0
- package/dist/unstable/reactivity/index.js.map +1 -1
- package/dist/unstable/rpc/Rpc.d.ts +0 -1
- package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
- package/dist/unstable/rpc/Rpc.js.map +1 -1
- package/dist/unstable/rpc/RpcClient.d.ts +0 -1
- package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcClient.js.map +1 -1
- package/dist/unstable/rpc/RpcClientError.d.ts +2 -2
- package/dist/unstable/rpc/RpcClientError.js +2 -2
- package/dist/unstable/rpc/RpcMiddleware.d.ts +2 -2
- package/dist/unstable/rpc/RpcMiddleware.js +1 -1
- package/dist/unstable/rpc/RpcWorker.d.ts +0 -1
- package/dist/unstable/rpc/RpcWorker.d.ts.map +1 -1
- package/dist/unstable/rpc/RpcWorker.js.map +1 -1
- package/dist/unstable/rpc/Utils.d.ts +2 -0
- package/dist/unstable/rpc/Utils.d.ts.map +1 -1
- package/dist/unstable/rpc/Utils.js +2 -0
- package/dist/unstable/rpc/Utils.js.map +1 -1
- package/dist/unstable/rpc/index.d.ts +272 -0
- package/dist/unstable/rpc/index.d.ts.map +1 -1
- package/dist/unstable/rpc/index.js +272 -0
- package/dist/unstable/rpc/index.js.map +1 -1
- package/dist/unstable/schema/Model.d.ts +63 -8
- package/dist/unstable/schema/Model.d.ts.map +1 -1
- package/dist/unstable/schema/Model.js +44 -5
- package/dist/unstable/schema/Model.js.map +1 -1
- package/dist/unstable/schema/VariantSchema.d.ts +1 -4
- package/dist/unstable/schema/VariantSchema.d.ts.map +1 -1
- package/dist/unstable/schema/VariantSchema.js +1 -1
- package/dist/unstable/schema/VariantSchema.js.map +1 -1
- package/dist/unstable/schema/index.d.ts +37 -0
- package/dist/unstable/schema/index.d.ts.map +1 -1
- package/dist/unstable/schema/index.js +37 -0
- package/dist/unstable/schema/index.js.map +1 -1
- package/dist/unstable/socket/Socket.d.ts +5 -4
- package/dist/unstable/socket/Socket.d.ts.map +1 -1
- package/dist/unstable/socket/Socket.js +4 -3
- package/dist/unstable/socket/Socket.js.map +1 -1
- package/dist/unstable/socket/index.d.ts +44 -0
- package/dist/unstable/socket/index.d.ts.map +1 -1
- package/dist/unstable/socket/index.js +44 -0
- package/dist/unstable/socket/index.js.map +1 -1
- package/dist/unstable/sql/Migrator.d.ts +5 -5
- package/dist/unstable/sql/Migrator.js +1 -1
- package/dist/unstable/sql/SqlClient.d.ts +4 -0
- package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
- package/dist/unstable/sql/SqlClient.js +2 -0
- package/dist/unstable/sql/SqlClient.js.map +1 -1
- package/dist/unstable/sql/SqlConnection.d.ts +3 -3
- package/dist/unstable/sql/SqlError.d.ts +18 -0
- package/dist/unstable/sql/SqlError.d.ts.map +1 -1
- package/dist/unstable/sql/SqlError.js +17 -0
- package/dist/unstable/sql/SqlError.js.map +1 -1
- package/dist/unstable/sql/SqlModel.d.ts +0 -1
- package/dist/unstable/sql/SqlModel.d.ts.map +1 -1
- package/dist/unstable/sql/SqlModel.js.map +1 -1
- package/dist/unstable/sql/SqlSchema.d.ts +5 -5
- package/dist/unstable/sql/SqlSchema.js +5 -5
- package/dist/unstable/sql/SqlStream.d.ts +1 -0
- package/dist/unstable/sql/SqlStream.d.ts.map +1 -1
- package/dist/unstable/sql/SqlStream.js +1 -0
- package/dist/unstable/sql/SqlStream.js.map +1 -1
- package/dist/unstable/sql/Statement.d.ts +27 -24
- package/dist/unstable/sql/Statement.d.ts.map +1 -1
- package/dist/unstable/sql/Statement.js +9 -6
- package/dist/unstable/sql/Statement.js.map +1 -1
- package/dist/unstable/sql/index.d.ts +178 -0
- package/dist/unstable/sql/index.d.ts.map +1 -1
- package/dist/unstable/sql/index.js +178 -0
- package/dist/unstable/sql/index.js.map +1 -1
- package/dist/unstable/workers/Transferable.d.ts +7 -7
- package/dist/unstable/workers/Transferable.js +4 -4
- package/dist/unstable/workers/Worker.d.ts +1 -0
- package/dist/unstable/workers/Worker.d.ts.map +1 -1
- package/dist/unstable/workers/Worker.js +1 -0
- package/dist/unstable/workers/Worker.js.map +1 -1
- package/dist/unstable/workers/WorkerError.d.ts +8 -8
- package/dist/unstable/workers/WorkerError.js +7 -7
- package/dist/unstable/workers/index.d.ts +80 -0
- package/dist/unstable/workers/index.d.ts.map +1 -1
- package/dist/unstable/workers/index.js +80 -0
- package/dist/unstable/workers/index.js.map +1 -1
- package/dist/unstable/workflow/Activity.d.ts +7 -7
- package/dist/unstable/workflow/Activity.js +2 -2
- package/dist/unstable/workflow/DurableClock.d.ts +2 -2
- package/dist/unstable/workflow/DurableClock.js +1 -1
- package/dist/unstable/workflow/DurableDeferred.d.ts +22 -20
- package/dist/unstable/workflow/DurableDeferred.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableDeferred.js +8 -7
- package/dist/unstable/workflow/DurableDeferred.js.map +1 -1
- package/dist/unstable/workflow/DurableQueue.d.ts +7 -5
- package/dist/unstable/workflow/DurableQueue.d.ts.map +1 -1
- package/dist/unstable/workflow/DurableQueue.js +5 -3
- package/dist/unstable/workflow/DurableQueue.js.map +1 -1
- package/dist/unstable/workflow/Workflow.d.ts +12 -10
- package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
- package/dist/unstable/workflow/Workflow.js +3 -3
- package/dist/unstable/workflow/Workflow.js.map +1 -1
- package/dist/unstable/workflow/WorkflowEngine.d.ts +4 -4
- package/dist/unstable/workflow/WorkflowEngine.js +4 -4
- package/dist/unstable/workflow/WorkflowProxy.d.ts +10 -12
- package/dist/unstable/workflow/WorkflowProxy.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxy.js +8 -12
- package/dist/unstable/workflow/WorkflowProxy.js.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.d.ts +3 -2
- package/dist/unstable/workflow/WorkflowProxyServer.d.ts.map +1 -1
- package/dist/unstable/workflow/WorkflowProxyServer.js +2 -2
- package/dist/unstable/workflow/index.d.ts +160 -0
- package/dist/unstable/workflow/index.d.ts.map +1 -1
- package/dist/unstable/workflow/index.js +160 -0
- package/dist/unstable/workflow/index.js.map +1 -1
- package/package.json +1 -1
- package/src/Array.ts +41 -42
- package/src/BigDecimal.ts +265 -265
- package/src/BigInt.ts +175 -177
- package/src/Boolean.ts +127 -125
- package/src/Brand.ts +10 -4
- package/src/Cache.ts +42 -42
- package/src/Cause.ts +17 -18
- package/src/Channel.ts +250 -256
- package/src/Chunk.ts +33 -56
- package/src/Clock.ts +1 -1
- package/src/Combiner.ts +9 -1
- package/src/Config.ts +78 -68
- package/src/ConfigProvider.ts +33 -32
- package/src/Console.ts +23 -23
- package/src/Context.ts +70 -108
- package/src/Cron.ts +3 -5
- package/src/Crypto.ts +327 -0
- package/src/Data.ts +6 -1
- package/src/DateTime.ts +29 -31
- package/src/Deferred.ts +8 -9
- package/src/Differ.ts +2 -2
- package/src/Duration.ts +30 -27
- package/src/Effect.ts +402 -660
- package/src/Effectable.ts +2 -2
- package/src/Encoding.ts +9 -9
- package/src/Equal.ts +4 -3
- package/src/Equivalence.ts +4 -5
- package/src/ErrorReporter.ts +14 -14
- package/src/ExecutionPlan.ts +18 -9
- package/src/Exit.ts +0 -1
- package/src/Fiber.ts +1 -2
- package/src/FiberHandle.ts +5 -5
- package/src/FiberMap.ts +10 -10
- package/src/FiberSet.ts +4 -4
- package/src/FileSystem.ts +10 -12
- package/src/Filter.ts +54 -54
- package/src/Formatter.ts +4 -70
- package/src/Function.ts +64 -65
- package/src/Graph.ts +157 -175
- package/src/Hash.ts +4 -6
- package/src/HashMap.ts +121 -157
- package/src/HashRing.ts +34 -34
- package/src/HashSet.ts +51 -55
- package/src/Inspectable.ts +8 -7
- package/src/Iterable.ts +37 -83
- package/src/JsonPatch.ts +9 -7
- package/src/JsonPointer.ts +13 -11
- package/src/JsonSchema.ts +16 -0
- package/src/Latch.ts +4 -16
- package/src/Layer.ts +94 -135
- package/src/LayerMap.ts +15 -16
- package/src/LogLevel.ts +13 -13
- package/src/Logger.ts +16 -17
- package/src/ManagedRuntime.ts +5 -4
- package/src/Match.ts +2 -4
- package/src/Metric.ts +56 -58
- package/src/MutableHashMap.ts +42 -44
- package/src/MutableHashSet.ts +0 -2
- package/src/MutableList.ts +23 -26
- package/src/MutableRef.ts +0 -1
- package/src/Newtype.ts +12 -2
- package/src/NonEmptyIterable.ts +5 -12
- package/src/Number.ts +145 -141
- package/src/Optic.ts +5 -5
- package/src/Option.ts +105 -109
- package/src/Order.ts +6 -6
- package/src/Ordering.ts +15 -19
- package/src/PartitionedSemaphore.ts +3 -3
- package/src/Path.ts +4 -4
- package/src/Pipeable.ts +10 -7
- package/src/PlatformError.ts +3 -3
- package/src/Predicate.ts +3 -5
- package/src/PrimaryKey.ts +2 -1
- package/src/PubSub.ts +25 -51
- package/src/Queue.ts +45 -60
- package/src/Random.ts +31 -74
- package/src/RcMap.ts +11 -11
- package/src/RcRef.ts +0 -1
- package/src/Record.ts +9 -8
- package/src/Redactable.ts +7 -5
- package/src/Redacted.ts +2 -3
- package/src/Reducer.ts +3 -1
- package/src/Ref.ts +15 -33
- package/src/RegExp.ts +1 -1
- package/src/Request.ts +2 -1
- package/src/RequestResolver.ts +2 -3
- package/src/Resource.ts +1 -1
- package/src/Result.ts +124 -142
- package/src/Runtime.ts +2 -7
- package/src/Schedule.ts +74 -77
- package/src/Scheduler.ts +2 -2
- package/src/Schema.ts +491 -321
- package/src/SchemaAST.ts +98 -77
- package/src/SchemaGetter.ts +23 -23
- package/src/SchemaIssue.ts +18 -16
- package/src/SchemaParser.ts +46 -49
- package/src/SchemaRepresentation.ts +89 -77
- package/src/SchemaTransformation.ts +36 -5
- package/src/SchemaUtils.ts +1 -1
- package/src/Scope.ts +12 -29
- package/src/ScopedCache.ts +43 -43
- package/src/Semaphore.ts +4 -16
- package/src/Sink.ts +36 -39
- package/src/Stdio.ts +6 -6
- package/src/Stream.ts +789 -828
- package/src/String.ts +3 -2
- package/src/Struct.ts +20 -18
- package/src/SubscriptionRef.ts +2 -2
- package/src/Symbol.ts +3 -3
- package/src/SynchronizedRef.ts +1 -1
- package/src/Take.ts +2 -2
- package/src/Terminal.ts +5 -5
- package/src/Tracer.ts +9 -9
- package/src/Trie.ts +70 -106
- package/src/Tuple.ts +34 -32
- package/src/TxChunk.ts +27 -18
- package/src/TxDeferred.ts +11 -11
- package/src/TxHashMap.ts +62 -63
- package/src/TxHashSet.ts +38 -42
- package/src/TxPriorityQueue.ts +31 -31
- package/src/TxPubSub.ts +18 -18
- package/src/TxQueue.ts +26 -29
- package/src/TxReentrantLock.ts +21 -21
- package/src/TxRef.ts +24 -24
- package/src/TxSemaphore.ts +13 -74
- package/src/TxSubscriptionRef.ts +24 -24
- package/src/Types.ts +1 -4
- package/src/UndefinedOr.ts +14 -0
- package/src/Unify.ts +8 -8
- package/src/Utils.ts +1 -2
- package/src/index.ts +1915 -408
- package/src/testing/FastCheck.ts +3 -3
- package/src/testing/TestClock.ts +2 -3
- package/src/testing/TestConsole.ts +8 -9
- package/src/testing/TestSchema.ts +2 -0
- package/src/testing/index.ts +34 -0
- package/src/unstable/ai/AiError.ts +10 -19
- package/src/unstable/ai/Chat.ts +0 -1
- package/src/unstable/ai/McpSchema.ts +3 -0
- package/src/unstable/ai/McpServer.ts +3 -1
- package/src/unstable/ai/Model.ts +2 -6
- package/src/unstable/ai/Prompt.ts +8 -10
- package/src/unstable/ai/Response.ts +20 -20
- package/src/unstable/ai/ResponseIdTracker.ts +1 -1
- package/src/unstable/ai/Telemetry.ts +5 -5
- package/src/unstable/ai/Tokenizer.ts +1 -1
- package/src/unstable/ai/Tool.ts +14 -12
- package/src/unstable/ai/index.ts +79 -5
- package/src/unstable/cli/CliOutput.ts +5 -6
- package/src/unstable/cli/Command.ts +3 -3
- package/src/unstable/cli/HelpDoc.ts +4 -4
- package/src/unstable/cli/Param.ts +69 -72
- package/src/unstable/cli/Primitive.ts +1 -1
- package/src/unstable/cli/Prompt.ts +6 -14
- package/src/unstable/cli/index.ts +205 -6
- package/src/unstable/cli/internal/parser.ts +0 -1
- package/src/unstable/cluster/ClusterCron.ts +1 -1
- package/src/unstable/cluster/ClusterSchema.ts +8 -8
- package/src/unstable/cluster/ClusterWorkflowEngine.ts +2 -2
- package/src/unstable/cluster/Entity.ts +0 -1
- package/src/unstable/cluster/EntityProxy.ts +10 -14
- package/src/unstable/cluster/EntityProxyServer.ts +3 -2
- package/src/unstable/cluster/EntityResource.ts +2 -2
- package/src/unstable/cluster/Envelope.ts +1 -1
- package/src/unstable/cluster/HttpRunner.ts +11 -11
- package/src/unstable/cluster/K8sHttpClient.ts +5 -5
- package/src/unstable/cluster/MachineId.ts +1 -1
- package/src/unstable/cluster/MessageStorage.ts +1 -2
- package/src/unstable/cluster/Runner.ts +1 -1
- package/src/unstable/cluster/RunnerHealth.ts +2 -2
- package/src/unstable/cluster/RunnerServer.ts +4 -4
- package/src/unstable/cluster/Runners.ts +3 -3
- package/src/unstable/cluster/ShardId.ts +7 -5
- package/src/unstable/cluster/Sharding.ts +1 -1
- package/src/unstable/cluster/ShardingConfig.ts +2 -2
- package/src/unstable/cluster/SingleRunner.ts +1 -1
- package/src/unstable/cluster/Snowflake.ts +10 -9
- package/src/unstable/cluster/SocketRunner.ts +2 -2
- package/src/unstable/cluster/SqlMessageStorage.ts +3 -3
- package/src/unstable/cluster/SqlRunnerStorage.ts +3 -3
- package/src/unstable/cluster/TestRunner.ts +1 -1
- package/src/unstable/cluster/index.ts +790 -0
- package/src/unstable/devtools/index.ts +58 -0
- package/src/unstable/encoding/Sse.ts +16 -16
- package/src/unstable/encoding/index.ts +49 -0
- package/src/unstable/eventlog/Event.ts +2 -2
- package/src/unstable/eventlog/EventGroup.ts +2 -2
- package/src/unstable/eventlog/EventLog.ts +6 -7
- package/src/unstable/eventlog/EventLogRemote.ts +2 -2
- package/src/unstable/eventlog/EventLogServer.ts +2 -2
- package/src/unstable/eventlog/EventLogServerEncrypted.ts +2 -2
- package/src/unstable/eventlog/EventLogServerUnencrypted.ts +1 -1
- package/src/unstable/eventlog/EventLogSessionAuth.ts +1 -1
- package/src/unstable/eventlog/index.ts +240 -0
- package/src/unstable/http/Cookies.ts +6 -6
- package/src/unstable/http/Etag.ts +2 -2
- package/src/unstable/http/Headers.ts +2 -2
- package/src/unstable/http/HttpClient.ts +5 -6
- package/src/unstable/http/HttpClientError.ts +1 -1
- package/src/unstable/http/HttpClientRequest.ts +4 -4
- package/src/unstable/http/HttpClientResponse.ts +6 -6
- package/src/unstable/http/HttpEffect.ts +5 -5
- package/src/unstable/http/HttpIncomingMessage.ts +7 -6
- package/src/unstable/http/HttpMethod.ts +4 -2
- package/src/unstable/http/HttpMiddleware.ts +1 -0
- package/src/unstable/http/HttpRouter.ts +23 -25
- package/src/unstable/http/HttpServerError.ts +4 -1
- package/src/unstable/http/HttpServerRequest.ts +15 -15
- package/src/unstable/http/HttpServerRespondable.ts +1 -1
- package/src/unstable/http/HttpServerResponse.ts +5 -4
- package/src/unstable/http/HttpStaticServer.ts +2 -4
- package/src/unstable/http/Multipart.ts +20 -19
- package/src/unstable/http/Template.ts +0 -1
- package/src/unstable/http/Url.ts +17 -17
- package/src/unstable/http/UrlParams.ts +14 -12
- package/src/unstable/http/index.ts +452 -0
- package/src/unstable/httpapi/HttpApiBuilder.ts +0 -1
- package/src/unstable/httpapi/HttpApiClient.ts +0 -1
- package/src/unstable/httpapi/HttpApiMiddleware.ts +4 -2
- package/src/unstable/httpapi/HttpApiScalar.ts +2 -2
- package/src/unstable/httpapi/HttpApiSchema.ts +19 -8
- package/src/unstable/httpapi/HttpApiSecurity.ts +0 -1
- package/src/unstable/httpapi/HttpApiSwagger.ts +0 -2
- package/src/unstable/httpapi/index.ts +310 -25
- package/src/unstable/observability/Otlp.ts +3 -3
- package/src/unstable/observability/OtlpExporter.ts +1 -1
- package/src/unstable/observability/OtlpLogger.ts +3 -2
- package/src/unstable/observability/OtlpMetrics.ts +5 -4
- package/src/unstable/observability/OtlpResource.ts +9 -9
- package/src/unstable/observability/OtlpSerialization.ts +3 -3
- package/src/unstable/observability/OtlpTracer.ts +5 -2
- package/src/unstable/observability/PrometheusMetrics.ts +7 -7
- package/src/unstable/observability/index.ts +158 -2
- package/src/unstable/persistence/KeyValueStore.ts +4 -4
- package/src/unstable/persistence/Persistable.ts +11 -11
- package/src/unstable/persistence/PersistedCache.ts +2 -2
- package/src/unstable/persistence/PersistedQueue.ts +6 -6
- package/src/unstable/persistence/Persistence.ts +2 -1
- package/src/unstable/persistence/RateLimiter.ts +19 -15
- package/src/unstable/persistence/Redis.ts +3 -3
- package/src/unstable/persistence/index.ts +147 -0
- package/src/unstable/process/ChildProcess.ts +42 -42
- package/src/unstable/process/ChildProcessSpawner.ts +10 -10
- package/src/unstable/reactivity/AsyncResult.ts +8 -6
- package/src/unstable/reactivity/Atom.ts +25 -20
- package/src/unstable/reactivity/AtomHttpApi.ts +2 -2
- package/src/unstable/reactivity/AtomRef.ts +2 -2
- package/src/unstable/reactivity/AtomRegistry.ts +17 -17
- package/src/unstable/reactivity/AtomRpc.ts +2 -2
- package/src/unstable/reactivity/Reactivity.ts +2 -3
- package/src/unstable/reactivity/index.ts +167 -0
- package/src/unstable/rpc/Rpc.ts +0 -1
- package/src/unstable/rpc/RpcClient.ts +0 -1
- package/src/unstable/rpc/RpcClientError.ts +2 -2
- package/src/unstable/rpc/RpcMiddleware.ts +2 -2
- package/src/unstable/rpc/RpcWorker.ts +0 -1
- package/src/unstable/rpc/Utils.ts +2 -0
- package/src/unstable/rpc/index.ts +272 -0
- package/src/unstable/schema/Model.ts +98 -10
- package/src/unstable/schema/VariantSchema.ts +1 -4
- package/src/unstable/schema/index.ts +37 -0
- package/src/unstable/socket/Socket.ts +5 -4
- package/src/unstable/socket/index.ts +44 -0
- package/src/unstable/sql/Migrator.ts +5 -5
- package/src/unstable/sql/SqlClient.ts +4 -0
- package/src/unstable/sql/SqlConnection.ts +3 -3
- package/src/unstable/sql/SqlError.ts +18 -0
- package/src/unstable/sql/SqlModel.ts +0 -1
- package/src/unstable/sql/SqlSchema.ts +5 -5
- package/src/unstable/sql/SqlStream.ts +1 -0
- package/src/unstable/sql/Statement.ts +27 -24
- package/src/unstable/sql/index.ts +178 -0
- package/src/unstable/workers/Transferable.ts +7 -7
- package/src/unstable/workers/Worker.ts +1 -0
- package/src/unstable/workers/WorkerError.ts +8 -8
- package/src/unstable/workers/index.ts +80 -0
- package/src/unstable/workflow/Activity.ts +7 -7
- package/src/unstable/workflow/DurableClock.ts +2 -2
- package/src/unstable/workflow/DurableDeferred.ts +22 -20
- package/src/unstable/workflow/DurableQueue.ts +7 -5
- package/src/unstable/workflow/Workflow.ts +12 -10
- package/src/unstable/workflow/WorkflowEngine.ts +4 -4
- package/src/unstable/workflow/WorkflowProxy.ts +10 -12
- package/src/unstable/workflow/WorkflowProxyServer.ts +3 -2
- package/src/unstable/workflow/index.ts +160 -0
package/src/Schema.ts
CHANGED
|
@@ -145,6 +145,7 @@ const TypeId = InternalSchema.TypeId
|
|
|
145
145
|
* @see {@link optionalKey} — mark a struct field as optional
|
|
146
146
|
* @see {@link optional} — mark a struct field as optional with `| undefined`
|
|
147
147
|
*
|
|
148
|
+
* @category models
|
|
148
149
|
* @since 4.0.0
|
|
149
150
|
*/
|
|
150
151
|
export type Optionality = "required" | "optional"
|
|
@@ -154,6 +155,7 @@ export type Optionality = "required" | "optional"
|
|
|
154
155
|
*
|
|
155
156
|
* @see {@link mutableKey} — mark a struct field as mutable
|
|
156
157
|
*
|
|
158
|
+
* @category models
|
|
157
159
|
* @since 4.0.0
|
|
158
160
|
*/
|
|
159
161
|
export type Mutability = "readonly" | "mutable"
|
|
@@ -164,6 +166,7 @@ export type Mutability = "readonly" | "mutable"
|
|
|
164
166
|
* @see {@link withConstructorDefault} — add a default to a schema field
|
|
165
167
|
* @see {@link tag} — creates a literal field with a constructor default
|
|
166
168
|
*
|
|
169
|
+
* @category models
|
|
167
170
|
* @since 4.0.0
|
|
168
171
|
*/
|
|
169
172
|
export type ConstructorDefault = "no-default" | "with-default"
|
|
@@ -178,7 +181,8 @@ export type ConstructorDefault = "no-default" | "with-default"
|
|
|
178
181
|
* @see {@link Bottom.makeEffect}
|
|
179
182
|
* @see {@link Bottom.make}
|
|
180
183
|
*
|
|
181
|
-
* @
|
|
184
|
+
* @category models
|
|
185
|
+
* @since 3.13.4
|
|
182
186
|
*/
|
|
183
187
|
export interface MakeOptions {
|
|
184
188
|
/**
|
|
@@ -206,6 +210,7 @@ export interface MakeOptions {
|
|
|
206
210
|
* @see {@link Schema} — tracks only the decoded Type
|
|
207
211
|
* @see {@link Codec} — tracks Type + Encoded
|
|
208
212
|
*
|
|
213
|
+
* @category models
|
|
209
214
|
* @since 4.0.0
|
|
210
215
|
*/
|
|
211
216
|
export interface Bottom<
|
|
@@ -252,8 +257,6 @@ export interface Bottom<
|
|
|
252
257
|
rebuild(ast: this["ast"]): this["Rebuild"]
|
|
253
258
|
/**
|
|
254
259
|
* Constructs a value from the make input representation.
|
|
255
|
-
*
|
|
256
|
-
* @throws {Error} The issue is contained in the error cause.
|
|
257
260
|
*/
|
|
258
261
|
make(input: this["~type.make.in"], options?: MakeOptions): this["Type"]
|
|
259
262
|
makeOption(input: this["~type.make.in"], options?: MakeOptions): Option_.Option<this["Type"]>
|
|
@@ -265,7 +268,7 @@ export interface Bottom<
|
|
|
265
268
|
* type `T`, the encoded type `E`, and the list of type-parameter schemas
|
|
266
269
|
* `TypeParameters`.
|
|
267
270
|
*
|
|
268
|
-
* @category
|
|
271
|
+
* @category constructors
|
|
269
272
|
* @since 4.0.0
|
|
270
273
|
*/
|
|
271
274
|
export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<Top>, Iso = T> extends
|
|
@@ -299,10 +302,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<T
|
|
|
299
302
|
* **Example** (Schema for a parametric `Box<A>` type)
|
|
300
303
|
*
|
|
301
304
|
* ```ts
|
|
302
|
-
* import { Effect, Schema } from "effect"
|
|
303
|
-
* import * as SchemaParser from "effect/SchemaParser"
|
|
304
|
-
* import * as Issue from "effect/SchemaIssue"
|
|
305
|
-
* import * as Option from "effect/Option"
|
|
305
|
+
* import { Effect, Option, Schema, SchemaIssue as Issue, SchemaParser } from "effect"
|
|
306
306
|
*
|
|
307
307
|
* interface Box<A> {
|
|
308
308
|
* readonly value: A
|
|
@@ -329,7 +329,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<T
|
|
|
329
329
|
* const schema = Box(Schema.Number)
|
|
330
330
|
* ```
|
|
331
331
|
*
|
|
332
|
-
* @category
|
|
332
|
+
* @category constructors
|
|
333
333
|
* @since 4.0.0
|
|
334
334
|
*/
|
|
335
335
|
export function declareConstructor<T, E = T, Iso = T>() {
|
|
@@ -356,8 +356,8 @@ export function declareConstructor<T, E = T, Iso = T>() {
|
|
|
356
356
|
* The schema type returned by {@link declare}, representing a non-parametric
|
|
357
357
|
* opaque type `T` with no type parameters.
|
|
358
358
|
*
|
|
359
|
-
* @category
|
|
360
|
-
* @since
|
|
359
|
+
* @category constructors
|
|
360
|
+
* @since 3.13.3
|
|
361
361
|
*/
|
|
362
362
|
export interface declare<T, Iso = T> extends declareConstructor<T, T, readonly [], Iso> {
|
|
363
363
|
readonly "Rebuild": declare<T, Iso>
|
|
@@ -389,8 +389,8 @@ export interface declare<T, Iso = T> extends declareConstructor<T, T, readonly [
|
|
|
389
389
|
*
|
|
390
390
|
* @see {@link declareConstructor} for creating schemas for parametric types.
|
|
391
391
|
*
|
|
392
|
-
* @category
|
|
393
|
-
* @since
|
|
392
|
+
* @category constructors
|
|
393
|
+
* @since 3.10.0
|
|
394
394
|
*/
|
|
395
395
|
export function declare<T, Iso = T>(
|
|
396
396
|
is: (u: unknown) => u is T,
|
|
@@ -430,6 +430,7 @@ export function declare<T, Iso = T>(
|
|
|
430
430
|
* type E = typeof bottom["Encoded"] // string
|
|
431
431
|
* ```
|
|
432
432
|
*
|
|
433
|
+
* @category utils
|
|
433
434
|
* @since 4.0.0
|
|
434
435
|
*/
|
|
435
436
|
export function revealBottom<S extends Top>(
|
|
@@ -477,7 +478,7 @@ export function revealBottom<S extends Top>(
|
|
|
477
478
|
*
|
|
478
479
|
* @see {@link annotateEncoded} to annotate the encoded side instead.
|
|
479
480
|
*
|
|
480
|
-
* @category
|
|
481
|
+
* @category annotations
|
|
481
482
|
* @since 4.0.0
|
|
482
483
|
*/
|
|
483
484
|
export function annotate<S extends Top>(annotations: Annotations.Bottom<S["Type"], S["~type.parameters"]>) {
|
|
@@ -509,7 +510,7 @@ export function annotate<S extends Top>(annotations: Annotations.Bottom<S["Type"
|
|
|
509
510
|
*
|
|
510
511
|
* @see {@link annotate} to annotate the type side instead.
|
|
511
512
|
*
|
|
512
|
-
* @category
|
|
513
|
+
* @category annotations
|
|
513
514
|
* @since 4.0.0
|
|
514
515
|
*/
|
|
515
516
|
export function annotateEncoded<S extends Top>(annotations: Annotations.Bottom<S["Encoded"], readonly []>) {
|
|
@@ -541,7 +542,7 @@ export function annotateEncoded<S extends Top>(annotations: Annotations.Bottom<S
|
|
|
541
542
|
* })
|
|
542
543
|
* ```
|
|
543
544
|
*
|
|
544
|
-
* @category
|
|
545
|
+
* @category annotations
|
|
545
546
|
* @since 4.0.0
|
|
546
547
|
*/
|
|
547
548
|
export function annotateKey<S extends Top>(annotations: Annotations.Key<S["Type"]>) {
|
|
@@ -563,6 +564,7 @@ export function annotateKey<S extends Top>(annotations: Annotations.Key<S["Type"
|
|
|
563
564
|
* - {@link Decoder}`<T, RD>` — for decode-only APIs
|
|
564
565
|
* - {@link Encoder}`<E, RE>` — for encode-only APIs
|
|
565
566
|
*
|
|
567
|
+
* @category models
|
|
566
568
|
* @since 4.0.0
|
|
567
569
|
*/
|
|
568
570
|
export interface Top extends
|
|
@@ -588,7 +590,7 @@ export interface Top extends
|
|
|
588
590
|
/**
|
|
589
591
|
* Namespace of type-level helpers for {@link Schema}.
|
|
590
592
|
*
|
|
591
|
-
* @since
|
|
593
|
+
* @since 3.10.0
|
|
592
594
|
*/
|
|
593
595
|
export declare namespace Schema {
|
|
594
596
|
/**
|
|
@@ -604,7 +606,8 @@ export declare namespace Schema {
|
|
|
604
606
|
* // { readonly name: string; readonly age: number }
|
|
605
607
|
* ```
|
|
606
608
|
*
|
|
607
|
-
* @
|
|
609
|
+
* @category utility types
|
|
610
|
+
* @since 3.10.0
|
|
608
611
|
*/
|
|
609
612
|
export type Type<S> = S extends Top ? S["Type"] : never
|
|
610
613
|
}
|
|
@@ -634,7 +637,8 @@ export declare namespace Schema {
|
|
|
634
637
|
* @see {@link Codec} — also tracks Encoded, DecodingServices, EncodingServices
|
|
635
638
|
* @see {@link Schema.Type} — extract the decoded type at the type level
|
|
636
639
|
*
|
|
637
|
-
* @
|
|
640
|
+
* @category models
|
|
641
|
+
* @since 3.10.0
|
|
638
642
|
*/
|
|
639
643
|
export interface Schema<out T> extends Top {
|
|
640
644
|
readonly "Type": T
|
|
@@ -660,7 +664,8 @@ export declare namespace Codec {
|
|
|
660
664
|
* // string
|
|
661
665
|
* ```
|
|
662
666
|
*
|
|
663
|
-
* @
|
|
667
|
+
* @category utility types
|
|
668
|
+
* @since 3.10.0
|
|
664
669
|
*/
|
|
665
670
|
export type Encoded<S> = S extends Top ? S["Encoded"] : never
|
|
666
671
|
/**
|
|
@@ -676,6 +681,7 @@ export declare namespace Codec {
|
|
|
676
681
|
* // never
|
|
677
682
|
* ```
|
|
678
683
|
*
|
|
684
|
+
* @category utility types
|
|
679
685
|
* @since 4.0.0
|
|
680
686
|
*/
|
|
681
687
|
export type DecodingServices<S> = S extends Top ? S["DecodingServices"] : never
|
|
@@ -692,19 +698,10 @@ export declare namespace Codec {
|
|
|
692
698
|
* // never
|
|
693
699
|
* ```
|
|
694
700
|
*
|
|
701
|
+
* @category utility types
|
|
695
702
|
* @since 4.0.0
|
|
696
703
|
*/
|
|
697
704
|
export type EncodingServices<S> = S extends Top ? S["EncodingServices"] : never
|
|
698
|
-
/**
|
|
699
|
-
* Converts a schema type into an assertion function signature. The resulting
|
|
700
|
-
* function narrows its argument to `I & S["Type"]`. Only schemas with
|
|
701
|
-
* `DecodingServices: never` (i.e. no required services) can be used here.
|
|
702
|
-
*
|
|
703
|
-
* Produced by {@link asserts}.
|
|
704
|
-
*
|
|
705
|
-
* @since 4.0.0
|
|
706
|
-
*/
|
|
707
|
-
export type ToAsserts<S extends Top> = <I>(input: I) => asserts input is I & S["Type"]
|
|
708
705
|
}
|
|
709
706
|
|
|
710
707
|
/**
|
|
@@ -720,6 +717,7 @@ export declare namespace Codec {
|
|
|
720
717
|
* `Optic` automatically. You normally interact with this interface through
|
|
721
718
|
* {@link Optic_} utilities rather than constructing it directly.
|
|
722
719
|
*
|
|
720
|
+
* @category models
|
|
723
721
|
* @since 4.0.0
|
|
724
722
|
*/
|
|
725
723
|
export interface Optic<out T, out Iso> extends Schema<T> {
|
|
@@ -757,6 +755,7 @@ export interface Optic<out T, out Iso> extends Schema<T> {
|
|
|
757
755
|
* @see {@link Codec.EncodingServices} — extract required encoding services
|
|
758
756
|
* @see {@link revealCodec} — helper to make TypeScript infer the full Codec type
|
|
759
757
|
*
|
|
758
|
+
* @category models
|
|
760
759
|
* @since 4.0.0
|
|
761
760
|
*/
|
|
762
761
|
export interface Codec<out T, out E = T, out RD = never, out RE = never> extends Schema<T> {
|
|
@@ -784,6 +783,7 @@ export interface Codec<out T, out E = T, out RD = never, out RE = never> extends
|
|
|
784
783
|
* validate(Schema.NumberFromString) // ok
|
|
785
784
|
* ```
|
|
786
785
|
*
|
|
786
|
+
* @category models
|
|
787
787
|
* @since 4.0.0
|
|
788
788
|
*/
|
|
789
789
|
export interface Decoder<out T, out RD = never> extends Codec<T, unknown, RD, unknown> {
|
|
@@ -808,6 +808,7 @@ export interface Decoder<out T, out RD = never> extends Codec<T, unknown, RD, un
|
|
|
808
808
|
* serialize(Schema.NumberFromString) // ok — encodes number to string
|
|
809
809
|
* ```
|
|
810
810
|
*
|
|
811
|
+
* @category models
|
|
811
812
|
* @since 4.0.0
|
|
812
813
|
*/
|
|
813
814
|
export interface Encoder<out E, out RE = never> extends Codec<unknown, E, unknown, RE> {
|
|
@@ -834,6 +835,7 @@ export interface Encoder<out E, out RE = never> extends Codec<unknown, E, unknow
|
|
|
834
835
|
* type Enc = typeof codec["Encoded"] // string
|
|
835
836
|
* ```
|
|
836
837
|
*
|
|
838
|
+
* @category utils
|
|
837
839
|
* @since 4.0.0
|
|
838
840
|
*/
|
|
839
841
|
export function revealCodec<T, E, RD, RE>(codec: Codec<T, E, RD, RE>) {
|
|
@@ -889,6 +891,7 @@ export {
|
|
|
889
891
|
* }
|
|
890
892
|
* ```
|
|
891
893
|
*
|
|
894
|
+
* @category guards
|
|
892
895
|
* @since 4.0.0
|
|
893
896
|
*/
|
|
894
897
|
export function isSchemaError(u: unknown): u is SchemaError {
|
|
@@ -1038,7 +1041,6 @@ function toBaseStandardJSONSchemaV1(self: Top, target: StandardJSONSchemaV1.Targ
|
|
|
1038
1041
|
*
|
|
1039
1042
|
* @category Standard Schema
|
|
1040
1043
|
* @since 4.0.0
|
|
1041
|
-
* @experimental
|
|
1042
1044
|
*/
|
|
1043
1045
|
export function toStandardJSONSchemaV1<S extends Top>(self: S): StandardJSONSchemaV1<S["Encoded"], S["Type"]> & S {
|
|
1044
1046
|
const jsonSchema: StandardJSONSchemaV1.Props<S["Encoded"], S["Type"]>["jsonSchema"] = {
|
|
@@ -1091,8 +1093,8 @@ export function toStandardJSONSchemaV1<S extends Top>(self: S): StandardJSONSche
|
|
|
1091
1093
|
* }
|
|
1092
1094
|
* ```
|
|
1093
1095
|
*
|
|
1094
|
-
* @category
|
|
1095
|
-
* @since
|
|
1096
|
+
* @category guards
|
|
1097
|
+
* @since 3.10.0
|
|
1096
1098
|
*/
|
|
1097
1099
|
export const is = Parser.is
|
|
1098
1100
|
|
|
@@ -1109,30 +1111,25 @@ export const is = Parser.is
|
|
|
1109
1111
|
* ```ts
|
|
1110
1112
|
* import { Schema } from "effect"
|
|
1111
1113
|
*
|
|
1112
|
-
* const
|
|
1113
|
-
* Schema.String
|
|
1114
|
-
* )
|
|
1114
|
+
* const input: unknown = "hello"
|
|
1115
1115
|
*
|
|
1116
|
-
* // This will pass silently (no return value)
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1119
|
-
* console.log("String assertion passed")
|
|
1120
|
-
* } catch (error) {
|
|
1121
|
-
* console.log("String assertion failed")
|
|
1122
|
-
* }
|
|
1116
|
+
* // This will pass silently (no return value) and narrow input to string
|
|
1117
|
+
* Schema.asserts(Schema.String, input)
|
|
1118
|
+
* console.log(input.toUpperCase())
|
|
1123
1119
|
*
|
|
1124
1120
|
* // This will throw an error
|
|
1125
1121
|
* try {
|
|
1126
|
-
*
|
|
1122
|
+
* const invalid: unknown = 123
|
|
1123
|
+
* Schema.asserts(Schema.String, invalid)
|
|
1127
1124
|
* } catch (error) {
|
|
1128
1125
|
* console.log("Non-string assertion failed as expected")
|
|
1129
1126
|
* }
|
|
1130
1127
|
* ```
|
|
1131
1128
|
*
|
|
1132
|
-
* @category
|
|
1129
|
+
* @category guards
|
|
1133
1130
|
* @since 4.0.0
|
|
1134
1131
|
*/
|
|
1135
|
-
export const asserts = Parser.asserts
|
|
1132
|
+
export const asserts: <S extends Top, I>(schema: S, input: I) => asserts input is I & S["Type"] = Parser.asserts
|
|
1136
1133
|
|
|
1137
1134
|
/**
|
|
1138
1135
|
* Decodes an `unknown` input against a schema, returning an `Effect` that
|
|
@@ -1142,7 +1139,7 @@ export const asserts = Parser.asserts
|
|
|
1142
1139
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1143
1140
|
* application options override creation options.
|
|
1144
1141
|
*
|
|
1145
|
-
* @category
|
|
1142
|
+
* @category decoding
|
|
1146
1143
|
* @since 4.0.0
|
|
1147
1144
|
*/
|
|
1148
1145
|
export function decodeUnknownEffect<S extends Top>(schema: S, options?: AST.ParseOptions) {
|
|
@@ -1160,7 +1157,7 @@ export function decodeUnknownEffect<S extends Top>(schema: S, options?: AST.Pars
|
|
|
1160
1157
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1161
1158
|
* application options override creation options.
|
|
1162
1159
|
*
|
|
1163
|
-
* @category
|
|
1160
|
+
* @category decoding
|
|
1164
1161
|
* @since 4.0.0
|
|
1165
1162
|
*/
|
|
1166
1163
|
export const decodeEffect: <S extends Top>(
|
|
@@ -1178,7 +1175,7 @@ export const decodeEffect: <S extends Top>(
|
|
|
1178
1175
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1179
1176
|
* application options override creation options.
|
|
1180
1177
|
*
|
|
1181
|
-
* @category
|
|
1178
|
+
* @category decoding
|
|
1182
1179
|
* @since 4.0.0
|
|
1183
1180
|
*/
|
|
1184
1181
|
export function decodeUnknownExit<S extends Decoder<unknown>>(schema: S, options?: AST.ParseOptions) {
|
|
@@ -1197,7 +1194,7 @@ export function decodeUnknownExit<S extends Decoder<unknown>>(schema: S, options
|
|
|
1197
1194
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1198
1195
|
* application options override creation options.
|
|
1199
1196
|
*
|
|
1200
|
-
* @category
|
|
1197
|
+
* @category decoding
|
|
1201
1198
|
* @since 4.0.0
|
|
1202
1199
|
*/
|
|
1203
1200
|
export const decodeExit: <S extends Decoder<unknown>>(
|
|
@@ -1214,8 +1211,8 @@ export const decodeExit: <S extends Decoder<unknown>>(
|
|
|
1214
1211
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1215
1212
|
* application options override creation options.
|
|
1216
1213
|
*
|
|
1217
|
-
* @category
|
|
1218
|
-
* @since
|
|
1214
|
+
* @category decoding
|
|
1215
|
+
* @since 3.10.0
|
|
1219
1216
|
*/
|
|
1220
1217
|
export const decodeUnknownOption = Parser.decodeUnknownOption
|
|
1221
1218
|
|
|
@@ -1226,8 +1223,8 @@ export const decodeUnknownOption = Parser.decodeUnknownOption
|
|
|
1226
1223
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1227
1224
|
* application options override creation options.
|
|
1228
1225
|
*
|
|
1229
|
-
* @category
|
|
1230
|
-
* @since
|
|
1226
|
+
* @category decoding
|
|
1227
|
+
* @since 3.10.0
|
|
1231
1228
|
*/
|
|
1232
1229
|
export const decodeOption = Parser.decodeOption
|
|
1233
1230
|
|
|
@@ -1238,7 +1235,7 @@ export const decodeOption = Parser.decodeOption
|
|
|
1238
1235
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1239
1236
|
* application options override creation options.
|
|
1240
1237
|
*
|
|
1241
|
-
* @category
|
|
1238
|
+
* @category decoding
|
|
1242
1239
|
* @since 4.0.0
|
|
1243
1240
|
*/
|
|
1244
1241
|
export const decodeUnknownResult = Parser.decodeUnknownResult
|
|
@@ -1250,7 +1247,7 @@ export const decodeUnknownResult = Parser.decodeUnknownResult
|
|
|
1250
1247
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1251
1248
|
* application options override creation options.
|
|
1252
1249
|
*
|
|
1253
|
-
* @category
|
|
1250
|
+
* @category decoding
|
|
1254
1251
|
* @since 4.0.0
|
|
1255
1252
|
*/
|
|
1256
1253
|
export const decodeResult = Parser.decodeResult
|
|
@@ -1263,8 +1260,8 @@ export const decodeResult = Parser.decodeResult
|
|
|
1263
1260
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1264
1261
|
* application options override creation options.
|
|
1265
1262
|
*
|
|
1266
|
-
* @category
|
|
1267
|
-
* @since
|
|
1263
|
+
* @category decoding
|
|
1264
|
+
* @since 3.10.0
|
|
1268
1265
|
*/
|
|
1269
1266
|
export const decodeUnknownPromise = Parser.decodeUnknownPromise
|
|
1270
1267
|
|
|
@@ -1277,8 +1274,8 @@ export const decodeUnknownPromise = Parser.decodeUnknownPromise
|
|
|
1277
1274
|
* Options may be provided either when creating the decoder or when applying it;
|
|
1278
1275
|
* application options override creation options.
|
|
1279
1276
|
*
|
|
1280
|
-
* @category
|
|
1281
|
-
* @since
|
|
1277
|
+
* @category decoding
|
|
1278
|
+
* @since 3.10.0
|
|
1282
1279
|
*/
|
|
1283
1280
|
export const decodePromise = Parser.decodePromise
|
|
1284
1281
|
|
|
@@ -1311,7 +1308,7 @@ export const decodePromise = Parser.decodePromise
|
|
|
1311
1308
|
* // └─ Expected a numeric string, actual "not a number"
|
|
1312
1309
|
* ```
|
|
1313
1310
|
*
|
|
1314
|
-
* @category
|
|
1311
|
+
* @category decoding
|
|
1315
1312
|
* @since 4.0.0
|
|
1316
1313
|
*/
|
|
1317
1314
|
export const decodeUnknownSync = Parser.decodeUnknownSync
|
|
@@ -1326,7 +1323,7 @@ export const decodeUnknownSync = Parser.decodeUnknownSync
|
|
|
1326
1323
|
* provided either when creating the decoder or when applying it; application
|
|
1327
1324
|
* options override creation options.
|
|
1328
1325
|
*
|
|
1329
|
-
* @category
|
|
1326
|
+
* @category decoding
|
|
1330
1327
|
* @since 4.0.0
|
|
1331
1328
|
*/
|
|
1332
1329
|
export const decodeSync = Parser.decodeSync
|
|
@@ -1350,7 +1347,7 @@ export const decodeSync = Parser.decodeSync
|
|
|
1350
1347
|
* // Output: "42"
|
|
1351
1348
|
* ```
|
|
1352
1349
|
*
|
|
1353
|
-
* @category
|
|
1350
|
+
* @category encoding
|
|
1354
1351
|
* @since 4.0.0
|
|
1355
1352
|
*/
|
|
1356
1353
|
export function encodeUnknownEffect<S extends Top>(schema: S, options?: AST.ParseOptions) {
|
|
@@ -1371,7 +1368,7 @@ export function encodeUnknownEffect<S extends Top>(schema: S, options?: AST.Pars
|
|
|
1371
1368
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1372
1369
|
* application options override creation options.
|
|
1373
1370
|
*
|
|
1374
|
-
* @category
|
|
1371
|
+
* @category encoding
|
|
1375
1372
|
* @since 4.0.0
|
|
1376
1373
|
*/
|
|
1377
1374
|
export const encodeEffect: <S extends Top>(
|
|
@@ -1389,7 +1386,7 @@ export const encodeEffect: <S extends Top>(
|
|
|
1389
1386
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1390
1387
|
* application options override creation options.
|
|
1391
1388
|
*
|
|
1392
|
-
* @category
|
|
1389
|
+
* @category encoding
|
|
1393
1390
|
* @since 4.0.0
|
|
1394
1391
|
*/
|
|
1395
1392
|
export function encodeUnknownExit<S extends Encoder<unknown>>(schema: S, options?: AST.ParseOptions) {
|
|
@@ -1408,7 +1405,7 @@ export function encodeUnknownExit<S extends Encoder<unknown>>(schema: S, options
|
|
|
1408
1405
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1409
1406
|
* application options override creation options.
|
|
1410
1407
|
*
|
|
1411
|
-
* @category
|
|
1408
|
+
* @category encoding
|
|
1412
1409
|
* @since 4.0.0
|
|
1413
1410
|
*/
|
|
1414
1411
|
export const encodeExit: <S extends Encoder<unknown>>(
|
|
@@ -1425,8 +1422,8 @@ export const encodeExit: <S extends Encoder<unknown>>(
|
|
|
1425
1422
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1426
1423
|
* application options override creation options.
|
|
1427
1424
|
*
|
|
1428
|
-
* @category
|
|
1429
|
-
* @since
|
|
1425
|
+
* @category encoding
|
|
1426
|
+
* @since 3.10.0
|
|
1430
1427
|
*/
|
|
1431
1428
|
export const encodeUnknownOption = Parser.encodeUnknownOption
|
|
1432
1429
|
|
|
@@ -1437,8 +1434,8 @@ export const encodeUnknownOption = Parser.encodeUnknownOption
|
|
|
1437
1434
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1438
1435
|
* application options override creation options.
|
|
1439
1436
|
*
|
|
1440
|
-
* @category
|
|
1441
|
-
* @since
|
|
1437
|
+
* @category encoding
|
|
1438
|
+
* @since 3.10.0
|
|
1442
1439
|
*/
|
|
1443
1440
|
export const encodeOption = Parser.encodeOption
|
|
1444
1441
|
|
|
@@ -1449,7 +1446,7 @@ export const encodeOption = Parser.encodeOption
|
|
|
1449
1446
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1450
1447
|
* application options override creation options.
|
|
1451
1448
|
*
|
|
1452
|
-
* @category
|
|
1449
|
+
* @category encoding
|
|
1453
1450
|
* @since 4.0.0
|
|
1454
1451
|
*/
|
|
1455
1452
|
export const encodeUnknownResult = Parser.encodeUnknownResult
|
|
@@ -1461,7 +1458,7 @@ export const encodeUnknownResult = Parser.encodeUnknownResult
|
|
|
1461
1458
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1462
1459
|
* application options override creation options.
|
|
1463
1460
|
*
|
|
1464
|
-
* @category
|
|
1461
|
+
* @category encoding
|
|
1465
1462
|
* @since 4.0.0
|
|
1466
1463
|
*/
|
|
1467
1464
|
export const encodeResult = Parser.encodeResult
|
|
@@ -1474,8 +1471,8 @@ export const encodeResult = Parser.encodeResult
|
|
|
1474
1471
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1475
1472
|
* application options override creation options.
|
|
1476
1473
|
*
|
|
1477
|
-
* @category
|
|
1478
|
-
* @since
|
|
1474
|
+
* @category encoding
|
|
1475
|
+
* @since 3.10.0
|
|
1479
1476
|
*/
|
|
1480
1477
|
export const encodeUnknownPromise = Parser.encodeUnknownPromise
|
|
1481
1478
|
|
|
@@ -1486,8 +1483,8 @@ export const encodeUnknownPromise = Parser.encodeUnknownPromise
|
|
|
1486
1483
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1487
1484
|
* application options override creation options.
|
|
1488
1485
|
*
|
|
1489
|
-
* @category
|
|
1490
|
-
* @since
|
|
1486
|
+
* @category encoding
|
|
1487
|
+
* @since 3.10.0
|
|
1491
1488
|
*/
|
|
1492
1489
|
export const encodePromise = Parser.encodePromise
|
|
1493
1490
|
|
|
@@ -1501,7 +1498,7 @@ export const encodePromise = Parser.encodePromise
|
|
|
1501
1498
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1502
1499
|
* application options override creation options.
|
|
1503
1500
|
*
|
|
1504
|
-
* @category
|
|
1501
|
+
* @category encoding
|
|
1505
1502
|
* @since 4.0.0
|
|
1506
1503
|
*/
|
|
1507
1504
|
export const encodeUnknownSync = Parser.encodeUnknownSync
|
|
@@ -1513,7 +1510,7 @@ export const encodeUnknownSync = Parser.encodeUnknownSync
|
|
|
1513
1510
|
* Options may be provided either when creating the encoder or when applying it;
|
|
1514
1511
|
* application options override creation options.
|
|
1515
1512
|
*
|
|
1516
|
-
* @category
|
|
1513
|
+
* @category encoding
|
|
1517
1514
|
* @since 4.0.0
|
|
1518
1515
|
*/
|
|
1519
1516
|
export const encodeSync = Parser.encodeSync
|
|
@@ -1530,8 +1527,8 @@ export const encodeSync = Parser.encodeSync
|
|
|
1530
1527
|
* the bridge between the untyped AST representation and the strongly-typed
|
|
1531
1528
|
* schema.
|
|
1532
1529
|
*
|
|
1533
|
-
* @category
|
|
1534
|
-
* @since
|
|
1530
|
+
* @category constructors
|
|
1531
|
+
* @since 3.10.0
|
|
1535
1532
|
*/
|
|
1536
1533
|
export const make: <S extends Top>(ast: S["ast"], options?: object) => S = InternalSchema.make
|
|
1537
1534
|
|
|
@@ -1553,6 +1550,7 @@ export const make: <S extends Top>(ast: S["ast"], options?: object) => S = Inter
|
|
|
1553
1550
|
* // "a"
|
|
1554
1551
|
* ```
|
|
1555
1552
|
*
|
|
1553
|
+
* @category constructors
|
|
1556
1554
|
* @since 4.0.0
|
|
1557
1555
|
*/
|
|
1558
1556
|
export function asClass<S extends Top>(schema: S): S & { new(_: never): {} } {
|
|
@@ -1564,8 +1562,8 @@ export function asClass<S extends Top>(schema: S): S & { new(_: never): {} } {
|
|
|
1564
1562
|
/**
|
|
1565
1563
|
* Tests if a value is a `Schema`.
|
|
1566
1564
|
*
|
|
1567
|
-
* @category
|
|
1568
|
-
* @since
|
|
1565
|
+
* @category guards
|
|
1566
|
+
* @since 3.10.0
|
|
1569
1567
|
*/
|
|
1570
1568
|
export function isSchema(u: unknown): u is Top {
|
|
1571
1569
|
return Predicate.hasProperty(u, TypeId) && u[TypeId] === TypeId
|
|
@@ -1576,6 +1574,7 @@ export function isSchema(u: unknown): u is Top {
|
|
|
1576
1574
|
* when present must match the wrapped schema (no implicit `undefined`).
|
|
1577
1575
|
* Produced by {@link optionalKey}.
|
|
1578
1576
|
*
|
|
1577
|
+
* @category models
|
|
1579
1578
|
* @since 4.0.0
|
|
1580
1579
|
*/
|
|
1581
1580
|
export interface optionalKey<S extends Top> extends
|
|
@@ -1624,6 +1623,7 @@ interface optionalKeyLambda extends Lambda {
|
|
|
1624
1623
|
* type Person = typeof schema["Type"]
|
|
1625
1624
|
* ```
|
|
1626
1625
|
*
|
|
1626
|
+
* @category combinators
|
|
1627
1627
|
* @since 4.0.0
|
|
1628
1628
|
*/
|
|
1629
1629
|
export const optionalKey = Struct_.lambda<optionalKeyLambda>((schema) => make(AST.optionalKey(schema.ast), { schema }))
|
|
@@ -1638,6 +1638,7 @@ interface requiredKeyLambda extends Lambda {
|
|
|
1638
1638
|
* Reverses {@link optionalKey}, returning the inner required schema. Only
|
|
1639
1639
|
* applicable to schemas already wrapped with `optionalKey`.
|
|
1640
1640
|
*
|
|
1641
|
+
* @category combinators
|
|
1641
1642
|
* @since 4.0.0
|
|
1642
1643
|
*/
|
|
1643
1644
|
export const requiredKey = Struct_.lambda<requiredKeyLambda>((self) => self.schema)
|
|
@@ -1646,7 +1647,8 @@ export const requiredKey = Struct_.lambda<requiredKeyLambda>((self) => self.sche
|
|
|
1646
1647
|
* Companion type for an optional struct key that also accepts `undefined`.
|
|
1647
1648
|
* Equivalent to `optionalKey<UndefinedOr<S>>`. Produced by {@link optional}.
|
|
1648
1649
|
*
|
|
1649
|
-
* @
|
|
1650
|
+
* @category models
|
|
1651
|
+
* @since 3.10.0
|
|
1650
1652
|
*/
|
|
1651
1653
|
export interface optional<S extends Top> extends optionalKey<UndefinedOr<S>> {
|
|
1652
1654
|
readonly "Rebuild": optional<S>
|
|
@@ -1680,7 +1682,8 @@ interface optionalLambda extends Lambda {
|
|
|
1680
1682
|
* type Person = typeof schema.Type
|
|
1681
1683
|
* ```
|
|
1682
1684
|
*
|
|
1683
|
-
* @
|
|
1685
|
+
* @category combinators
|
|
1686
|
+
* @since 3.10.0
|
|
1684
1687
|
*/
|
|
1685
1688
|
export const optional = Struct_.lambda<optionalLambda>((self) => optionalKey(UndefinedOr(self)))
|
|
1686
1689
|
|
|
@@ -1694,7 +1697,8 @@ interface requiredLambda extends Lambda {
|
|
|
1694
1697
|
* Reverses {@link optional}, returning the inner schema (unwrapping `UndefinedOr`).
|
|
1695
1698
|
* Only applicable to schemas already wrapped with `optional`.
|
|
1696
1699
|
*
|
|
1697
|
-
* @
|
|
1700
|
+
* @category combinators
|
|
1701
|
+
* @since 3.10.0
|
|
1698
1702
|
*/
|
|
1699
1703
|
export const required = Struct_.lambda<requiredLambda>((self) => self.schema.members[0])
|
|
1700
1704
|
|
|
@@ -1702,6 +1706,7 @@ export const required = Struct_.lambda<requiredLambda>((self) => self.schema.mem
|
|
|
1702
1706
|
* Companion type for a mutable struct key. The key's property is writable.
|
|
1703
1707
|
* Produced by {@link mutableKey}.
|
|
1704
1708
|
*
|
|
1709
|
+
* @category models
|
|
1705
1710
|
* @since 4.0.0
|
|
1706
1711
|
*/
|
|
1707
1712
|
export interface mutableKey<S extends Top> extends
|
|
@@ -1735,6 +1740,7 @@ interface mutableKeyLambda extends Lambda {
|
|
|
1735
1740
|
* Makes a struct field mutable (removes the `readonly` modifier on the property).
|
|
1736
1741
|
* Use {@link readonlyKey} to reverse.
|
|
1737
1742
|
*
|
|
1743
|
+
* @category combinators
|
|
1738
1744
|
* @since 4.0.0
|
|
1739
1745
|
*/
|
|
1740
1746
|
export const mutableKey = Struct_.lambda<mutableKeyLambda>((schema) => make(AST.mutableKey(schema.ast), { schema }))
|
|
@@ -1749,6 +1755,7 @@ interface readonlyKeyLambda extends Lambda {
|
|
|
1749
1755
|
* Reverses {@link mutableKey}, returning the inner schema as readonly again.
|
|
1750
1756
|
* Only applicable to schemas already wrapped with `mutableKey`.
|
|
1751
1757
|
*
|
|
1758
|
+
* @category combinators
|
|
1752
1759
|
* @since 4.0.0
|
|
1753
1760
|
*/
|
|
1754
1761
|
export const readonlyKey = Struct_.lambda<readonlyKeyLambda>((self) => self.schema)
|
|
@@ -1757,6 +1764,7 @@ export const readonlyKey = Struct_.lambda<readonlyKeyLambda>((self) => self.sche
|
|
|
1757
1764
|
* Schema type that collapses a transformation schema to its decoded `Type` on
|
|
1758
1765
|
* both sides (Type = Encoded = S["Type"]). Produced by {@link toType}.
|
|
1759
1766
|
*
|
|
1767
|
+
* @category transforming
|
|
1760
1768
|
* @since 4.0.0
|
|
1761
1769
|
*/
|
|
1762
1770
|
export interface toType<S extends Top> extends
|
|
@@ -1788,6 +1796,7 @@ interface toTypeLambda extends Lambda {
|
|
|
1788
1796
|
* Extracts the type-side schema: sets `Encoded` to equal the decoded `Type`,
|
|
1789
1797
|
* discarding the encoding transformation path.
|
|
1790
1798
|
*
|
|
1799
|
+
* @category transforming
|
|
1791
1800
|
* @since 4.0.0
|
|
1792
1801
|
*/
|
|
1793
1802
|
export const toType = Struct_.lambda<toTypeLambda>((schema) => make(AST.toType(schema.ast), { schema }))
|
|
@@ -1796,6 +1805,7 @@ export const toType = Struct_.lambda<toTypeLambda>((schema) => make(AST.toType(s
|
|
|
1796
1805
|
* Schema type that collapses a transformation schema to its `Encoded` side on
|
|
1797
1806
|
* both sides (Type = Encoded = S["Encoded"]). Produced by {@link toEncoded}.
|
|
1798
1807
|
*
|
|
1808
|
+
* @category transforming
|
|
1799
1809
|
* @since 4.0.0
|
|
1800
1810
|
*/
|
|
1801
1811
|
export interface toEncoded<S extends Top> extends
|
|
@@ -1827,6 +1837,7 @@ interface toEncodedLambda extends Lambda {
|
|
|
1827
1837
|
* Extracts the encoded-side schema: sets `Type` to equal the `Encoded`,
|
|
1828
1838
|
* discarding the decoding transformation path.
|
|
1829
1839
|
*
|
|
1840
|
+
* @category transforming
|
|
1830
1841
|
* @since 4.0.0
|
|
1831
1842
|
*/
|
|
1832
1843
|
export const toEncoded = Struct_.lambda<toEncodedLambda>((schema) => make(AST.toEncoded(schema.ast), { schema }))
|
|
@@ -1837,6 +1848,7 @@ const FlipTypeId = "~effect/Schema/flip"
|
|
|
1837
1848
|
* Schema type representing a flipped schema where `Type` and `Encoded` are
|
|
1838
1849
|
* swapped. Produced by {@link flip}.
|
|
1839
1850
|
*
|
|
1851
|
+
* @category transforming
|
|
1840
1852
|
* @since 4.0.0
|
|
1841
1853
|
*/
|
|
1842
1854
|
export interface flip<S extends Top> extends
|
|
@@ -1880,6 +1892,7 @@ function isFlip$(schema: Top): schema is flip<any> {
|
|
|
1880
1892
|
* // flipped: decodes number → string
|
|
1881
1893
|
* ```
|
|
1882
1894
|
*
|
|
1895
|
+
* @category transforming
|
|
1883
1896
|
* @since 4.0.0
|
|
1884
1897
|
*/
|
|
1885
1898
|
export function flip<S extends Top>(schema: S): S extends flip<infer F> ? F["Rebuild"] : flip<S>
|
|
@@ -1894,7 +1907,8 @@ export function flip<S extends Top>(schema: S): flip<S> {
|
|
|
1894
1907
|
* Represents a schema for a single literal value.
|
|
1895
1908
|
*
|
|
1896
1909
|
* @see {@link Literal} for the constructor function.
|
|
1897
|
-
* @
|
|
1910
|
+
* @category models
|
|
1911
|
+
* @since 3.10.0
|
|
1898
1912
|
*/
|
|
1899
1913
|
export interface Literal<L extends AST.LiteralValue> extends Bottom<L, L, never, never, AST.Literal, Literal<L>> {
|
|
1900
1914
|
readonly literal: L
|
|
@@ -1905,6 +1919,7 @@ export interface Literal<L extends AST.LiteralValue> extends Bottom<L, L, never,
|
|
|
1905
1919
|
* Creates a schema for a single literal value (string, number, bigint, boolean, or null).
|
|
1906
1920
|
*
|
|
1907
1921
|
* **Example** (String literal)
|
|
1922
|
+
*
|
|
1908
1923
|
* ```ts
|
|
1909
1924
|
* import { Schema } from "effect"
|
|
1910
1925
|
*
|
|
@@ -1915,7 +1930,8 @@ export interface Literal<L extends AST.LiteralValue> extends Bottom<L, L, never,
|
|
|
1915
1930
|
* @see {@link Literals} for a schema that represents a union of literals.
|
|
1916
1931
|
* @see {@link tag} for a schema that represents a literal value that can be
|
|
1917
1932
|
* used as a discriminator field in tagged unions and has a constructor default.
|
|
1918
|
-
* @
|
|
1933
|
+
* @category constructors
|
|
1934
|
+
* @since 3.10.0
|
|
1919
1935
|
*/
|
|
1920
1936
|
export function Literal<L extends AST.LiteralValue>(literal: L): Literal<L> {
|
|
1921
1937
|
const out = make<Literal<L>>(new AST.Literal(literal), {
|
|
@@ -1933,7 +1949,7 @@ export function Literal<L extends AST.LiteralValue>(literal: L): Literal<L> {
|
|
|
1933
1949
|
/**
|
|
1934
1950
|
* Namespace for {@link TemplateLiteral} helper types.
|
|
1935
1951
|
*
|
|
1936
|
-
* @since
|
|
1952
|
+
* @since 3.10.0
|
|
1937
1953
|
*/
|
|
1938
1954
|
export declare namespace TemplateLiteral {
|
|
1939
1955
|
/**
|
|
@@ -1943,6 +1959,7 @@ export declare namespace TemplateLiteral {
|
|
|
1943
1959
|
* The schema's encoded value must be a `string`, `number`, or `bigint` so it can
|
|
1944
1960
|
* be converted into a template literal string segment.
|
|
1945
1961
|
*
|
|
1962
|
+
* @category utility types
|
|
1946
1963
|
* @since 4.0.0
|
|
1947
1964
|
*/
|
|
1948
1965
|
export interface SchemaPart extends Top {
|
|
@@ -1952,6 +1969,7 @@ export declare namespace TemplateLiteral {
|
|
|
1952
1969
|
/**
|
|
1953
1970
|
* Literal value that can be used directly as a part of a `TemplateLiteral`.
|
|
1954
1971
|
*
|
|
1972
|
+
* @category utility types
|
|
1955
1973
|
* @since 4.0.0
|
|
1956
1974
|
*/
|
|
1957
1975
|
export type LiteralPart = string | number | bigint
|
|
@@ -1960,6 +1978,7 @@ export declare namespace TemplateLiteral {
|
|
|
1960
1978
|
* A single part of a `TemplateLiteral`, either an interpolated schema part or a
|
|
1961
1979
|
* literal `string`, `number`, or `bigint`.
|
|
1962
1980
|
*
|
|
1981
|
+
* @category utility types
|
|
1963
1982
|
* @since 4.0.0
|
|
1964
1983
|
*/
|
|
1965
1984
|
export type Part = SchemaPart | LiteralPart
|
|
@@ -1967,6 +1986,7 @@ export declare namespace TemplateLiteral {
|
|
|
1967
1986
|
/**
|
|
1968
1987
|
* Ordered list of parts used to construct a `TemplateLiteral` schema.
|
|
1969
1988
|
*
|
|
1989
|
+
* @category utility types
|
|
1970
1990
|
* @since 4.0.0
|
|
1971
1991
|
*/
|
|
1972
1992
|
export type Parts = ReadonlyArray<Part>
|
|
@@ -1982,7 +2002,8 @@ export declare namespace TemplateLiteral {
|
|
|
1982
2002
|
* Computes the encoded string literal type produced by concatenating the encoded
|
|
1983
2003
|
* forms of all template literal parts.
|
|
1984
2004
|
*
|
|
1985
|
-
* @
|
|
2005
|
+
* @category utility types
|
|
2006
|
+
* @since 3.10.0
|
|
1986
2007
|
*/
|
|
1987
2008
|
export type Encoded<Parts> = Parts extends readonly [...infer Init, infer Last] ? AppendType<Encoded<Init>, Last>
|
|
1988
2009
|
: ``
|
|
@@ -1993,7 +2014,8 @@ export declare namespace TemplateLiteral {
|
|
|
1993
2014
|
* The encoded type is a string formed by concatenating the parts.
|
|
1994
2015
|
*
|
|
1995
2016
|
* @see {@link TemplateLiteral} for the constructor function.
|
|
1996
|
-
* @
|
|
2017
|
+
* @category models
|
|
2018
|
+
* @since 3.10.0
|
|
1997
2019
|
*/
|
|
1998
2020
|
export interface TemplateLiteral<Parts extends TemplateLiteral.Parts> extends
|
|
1999
2021
|
Bottom<
|
|
@@ -2017,6 +2039,7 @@ function templateLiteralFromParts<Parts extends TemplateLiteral.Parts>(parts: Pa
|
|
|
2017
2039
|
* a literal string/number/bigint or a schema whose encoded type is a string, number, or bigint.
|
|
2018
2040
|
*
|
|
2019
2041
|
* **Example** (URL path pattern)
|
|
2042
|
+
*
|
|
2020
2043
|
* ```ts
|
|
2021
2044
|
* import { Schema } from "effect"
|
|
2022
2045
|
*
|
|
@@ -2025,7 +2048,8 @@ function templateLiteralFromParts<Parts extends TemplateLiteral.Parts>(parts: Pa
|
|
|
2025
2048
|
* ```
|
|
2026
2049
|
*
|
|
2027
2050
|
* @see {@link TemplateLiteralParser} for a schema that also parses matched parts into a tuple.
|
|
2028
|
-
* @
|
|
2051
|
+
* @category constructors
|
|
2052
|
+
* @since 3.10.0
|
|
2029
2053
|
*/
|
|
2030
2054
|
export function TemplateLiteral<const Parts extends TemplateLiteral.Parts>(parts: Parts): TemplateLiteral<Parts> {
|
|
2031
2055
|
return make(templateLiteralFromParts(parts), { parts })
|
|
@@ -2034,7 +2058,7 @@ export function TemplateLiteral<const Parts extends TemplateLiteral.Parts>(parts
|
|
|
2034
2058
|
/**
|
|
2035
2059
|
* Namespace for {@link TemplateLiteralParser} helper types.
|
|
2036
2060
|
*
|
|
2037
|
-
* @since
|
|
2061
|
+
* @since 3.10.0
|
|
2038
2062
|
*/
|
|
2039
2063
|
export declare namespace TemplateLiteralParser {
|
|
2040
2064
|
/**
|
|
@@ -2044,7 +2068,8 @@ export declare namespace TemplateLiteralParser {
|
|
|
2044
2068
|
* Literal parts contribute their literal value to the tuple. Schema parts
|
|
2045
2069
|
* contribute their decoded `Type`.
|
|
2046
2070
|
*
|
|
2047
|
-
* @
|
|
2071
|
+
* @category utility types
|
|
2072
|
+
* @since 3.10.0
|
|
2048
2073
|
*/
|
|
2049
2074
|
export type Type<Parts> = Parts extends readonly [infer Head, ...infer Tail] ? readonly [
|
|
2050
2075
|
Head extends TemplateLiteral.LiteralPart ? Head :
|
|
@@ -2060,7 +2085,8 @@ export declare namespace TemplateLiteralParser {
|
|
|
2060
2085
|
* them into a tuple of typed values, one per schema part.
|
|
2061
2086
|
*
|
|
2062
2087
|
* @see {@link TemplateLiteralParser} for the constructor function.
|
|
2063
|
-
* @
|
|
2088
|
+
* @category models
|
|
2089
|
+
* @since 3.10.0
|
|
2064
2090
|
*/
|
|
2065
2091
|
export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> extends
|
|
2066
2092
|
Bottom<
|
|
@@ -2080,6 +2106,7 @@ export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> exte
|
|
|
2080
2106
|
* one element per schema part.
|
|
2081
2107
|
*
|
|
2082
2108
|
* **Example** (Parse path parameters)
|
|
2109
|
+
*
|
|
2083
2110
|
* ```ts
|
|
2084
2111
|
* import { Schema } from "effect"
|
|
2085
2112
|
*
|
|
@@ -2088,7 +2115,8 @@ export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> exte
|
|
|
2088
2115
|
* ```
|
|
2089
2116
|
*
|
|
2090
2117
|
* @see {@link TemplateLiteral} for a validation-only version that keeps the string encoded.
|
|
2091
|
-
* @
|
|
2118
|
+
* @category constructors
|
|
2119
|
+
* @since 3.10.0
|
|
2092
2120
|
*/
|
|
2093
2121
|
export function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>(
|
|
2094
2122
|
parts: Parts
|
|
@@ -2101,6 +2129,7 @@ export function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>
|
|
|
2101
2129
|
* `as const` object, accepting any of its values.
|
|
2102
2130
|
*
|
|
2103
2131
|
* @see {@link Enum} for the constructor function.
|
|
2132
|
+
* @category models
|
|
2104
2133
|
* @since 4.0.0
|
|
2105
2134
|
*/
|
|
2106
2135
|
export interface Enum<A extends { [x: string]: string | number }>
|
|
@@ -2113,6 +2142,7 @@ export interface Enum<A extends { [x: string]: string | number }>
|
|
|
2113
2142
|
* Creates a schema from a TypeScript enum object. Validates that the input is one of the enum's values.
|
|
2114
2143
|
*
|
|
2115
2144
|
* **Example** (Direction enum)
|
|
2145
|
+
*
|
|
2116
2146
|
* ```ts
|
|
2117
2147
|
* import { Schema } from "effect"
|
|
2118
2148
|
*
|
|
@@ -2125,6 +2155,7 @@ export interface Enum<A extends { [x: string]: string | number }>
|
|
|
2125
2155
|
* // accepts "Up" or "Down"
|
|
2126
2156
|
* ```
|
|
2127
2157
|
*
|
|
2158
|
+
* @category constructors
|
|
2128
2159
|
* @since 4.0.0
|
|
2129
2160
|
*/
|
|
2130
2161
|
export function Enum<A extends { [x: string]: string | number }>(enums: A): Enum<A> {
|
|
@@ -2142,14 +2173,16 @@ export function Enum<A extends { [x: string]: string | number }>(enums: A): Enum
|
|
|
2142
2173
|
* Schema for the `never` type. Always fails validation.
|
|
2143
2174
|
*
|
|
2144
2175
|
* @see {@link Never} for the schema value.
|
|
2145
|
-
* @
|
|
2176
|
+
* @category models
|
|
2177
|
+
* @since 3.10.0
|
|
2146
2178
|
*/
|
|
2147
2179
|
export interface Never extends Bottom<never, never, never, never, AST.Never, Never> {}
|
|
2148
2180
|
|
|
2149
2181
|
/**
|
|
2150
2182
|
* Schema for the `never` type. Always fails validation — no value satisfies it.
|
|
2151
2183
|
*
|
|
2152
|
-
* @
|
|
2184
|
+
* @category schemas
|
|
2185
|
+
* @since 3.10.0
|
|
2153
2186
|
*/
|
|
2154
2187
|
export const Never: Never = make(AST.never)
|
|
2155
2188
|
|
|
@@ -2157,7 +2190,8 @@ export const Never: Never = make(AST.never)
|
|
|
2157
2190
|
* Schema for the `any` type. Accepts any value without validation.
|
|
2158
2191
|
*
|
|
2159
2192
|
* @see {@link Any} for the schema value.
|
|
2160
|
-
* @
|
|
2193
|
+
* @category models
|
|
2194
|
+
* @since 3.10.0
|
|
2161
2195
|
*/
|
|
2162
2196
|
export interface Any extends Bottom<any, any, never, never, AST.Any, Any> {}
|
|
2163
2197
|
|
|
@@ -2165,7 +2199,8 @@ export interface Any extends Bottom<any, any, never, never, AST.Any, Any> {}
|
|
|
2165
2199
|
* Schema for the `any` type. Accepts any value without validation.
|
|
2166
2200
|
*
|
|
2167
2201
|
* @see {@link Unknown} for a safer alternative that uses `unknown`.
|
|
2168
|
-
* @
|
|
2202
|
+
* @category schemas
|
|
2203
|
+
* @since 3.10.0
|
|
2169
2204
|
*/
|
|
2170
2205
|
export const Any: Any = make(AST.any)
|
|
2171
2206
|
|
|
@@ -2173,7 +2208,8 @@ export const Any: Any = make(AST.any)
|
|
|
2173
2208
|
* Schema for the `unknown` type. Accepts any value without validation.
|
|
2174
2209
|
*
|
|
2175
2210
|
* @see {@link Unknown} for the schema value.
|
|
2176
|
-
* @
|
|
2211
|
+
* @category models
|
|
2212
|
+
* @since 3.10.0
|
|
2177
2213
|
*/
|
|
2178
2214
|
export interface Unknown extends Bottom<unknown, unknown, never, never, AST.Unknown, Unknown> {}
|
|
2179
2215
|
|
|
@@ -2181,7 +2217,8 @@ export interface Unknown extends Bottom<unknown, unknown, never, never, AST.Unkn
|
|
|
2181
2217
|
* Schema for the `unknown` type. Accepts any value without validation.
|
|
2182
2218
|
*
|
|
2183
2219
|
* @see {@link Any} for the `any` variant.
|
|
2184
|
-
* @
|
|
2220
|
+
* @category schemas
|
|
2221
|
+
* @since 3.10.0
|
|
2185
2222
|
*/
|
|
2186
2223
|
export const Unknown: Unknown = make(AST.unknown)
|
|
2187
2224
|
|
|
@@ -2189,7 +2226,8 @@ export const Unknown: Unknown = make(AST.unknown)
|
|
|
2189
2226
|
* Schema for the `null` literal. Validates that the input is strictly `null`.
|
|
2190
2227
|
*
|
|
2191
2228
|
* @see {@link Null} for the schema value.
|
|
2192
|
-
* @
|
|
2229
|
+
* @category models
|
|
2230
|
+
* @since 3.10.0
|
|
2193
2231
|
*/
|
|
2194
2232
|
export interface Null extends Bottom<null, null, never, never, AST.Null, Null> {}
|
|
2195
2233
|
|
|
@@ -2197,7 +2235,8 @@ export interface Null extends Bottom<null, null, never, never, AST.Null, Null> {
|
|
|
2197
2235
|
* Schema for the `null` literal. Validates that the input is strictly `null`.
|
|
2198
2236
|
*
|
|
2199
2237
|
* @see {@link NullOr} for a union with another schema.
|
|
2200
|
-
* @
|
|
2238
|
+
* @category schemas
|
|
2239
|
+
* @since 3.10.0
|
|
2201
2240
|
*/
|
|
2202
2241
|
export const Null: Null = make(AST.null)
|
|
2203
2242
|
|
|
@@ -2205,7 +2244,8 @@ export const Null: Null = make(AST.null)
|
|
|
2205
2244
|
* Schema for the `undefined` literal. Validates that the input is strictly `undefined`.
|
|
2206
2245
|
*
|
|
2207
2246
|
* @see {@link Undefined} for the schema value.
|
|
2208
|
-
* @
|
|
2247
|
+
* @category models
|
|
2248
|
+
* @since 3.10.0
|
|
2209
2249
|
*/
|
|
2210
2250
|
export interface Undefined extends Bottom<undefined, undefined, never, never, AST.Undefined, Undefined> {}
|
|
2211
2251
|
|
|
@@ -2213,7 +2253,8 @@ export interface Undefined extends Bottom<undefined, undefined, never, never, AS
|
|
|
2213
2253
|
* Schema for the `undefined` literal. Validates that the input is strictly `undefined`.
|
|
2214
2254
|
*
|
|
2215
2255
|
* @see {@link UndefinedOr} for a union with another schema.
|
|
2216
|
-
* @
|
|
2256
|
+
* @category schemas
|
|
2257
|
+
* @since 3.10.0
|
|
2217
2258
|
*/
|
|
2218
2259
|
export const Undefined: Undefined = make(AST.undefined)
|
|
2219
2260
|
|
|
@@ -2221,6 +2262,7 @@ export const Undefined: Undefined = make(AST.undefined)
|
|
|
2221
2262
|
* Schema for `string` values.
|
|
2222
2263
|
*
|
|
2223
2264
|
* @see {@link String} for the schema value.
|
|
2265
|
+
* @category models
|
|
2224
2266
|
* @since 4.0.0
|
|
2225
2267
|
*/
|
|
2226
2268
|
export interface String extends Bottom<string, string, never, never, AST.String, String> {}
|
|
@@ -2228,6 +2270,7 @@ export interface String extends Bottom<string, string, never, never, AST.String,
|
|
|
2228
2270
|
/**
|
|
2229
2271
|
* Schema for `string` values. Validates that the input is `typeof` `"string"`.
|
|
2230
2272
|
*
|
|
2273
|
+
* @category schemas
|
|
2231
2274
|
* @since 4.0.0
|
|
2232
2275
|
*/
|
|
2233
2276
|
export const String: String = make(AST.string)
|
|
@@ -2236,6 +2279,7 @@ export const String: String = make(AST.string)
|
|
|
2236
2279
|
* Schema for `number` values, including `NaN`, `Infinity`, and `-Infinity`.
|
|
2237
2280
|
*
|
|
2238
2281
|
* @see {@link Number} for the schema value.
|
|
2282
|
+
* @category models
|
|
2239
2283
|
* @since 4.0.0
|
|
2240
2284
|
*/
|
|
2241
2285
|
export interface Number extends Bottom<number, number, never, never, AST.Number, Number> {}
|
|
@@ -2249,6 +2293,7 @@ export interface Number extends Bottom<number, number, never, never, AST.Number,
|
|
|
2249
2293
|
* - Non-finite values are serialized as strings (`"NaN"`, `"Infinity"`, `"-Infinity"`).
|
|
2250
2294
|
*
|
|
2251
2295
|
* @see {@link Finite} for a schema that excludes non-finite values.
|
|
2296
|
+
* @category schemas
|
|
2252
2297
|
* @since 4.0.0
|
|
2253
2298
|
*/
|
|
2254
2299
|
export const Number: Number = make(AST.number)
|
|
@@ -2257,6 +2302,7 @@ export const Number: Number = make(AST.number)
|
|
|
2257
2302
|
* Schema for `boolean` values.
|
|
2258
2303
|
*
|
|
2259
2304
|
* @see {@link Boolean} for the schema value.
|
|
2305
|
+
* @category models
|
|
2260
2306
|
* @since 4.0.0
|
|
2261
2307
|
*/
|
|
2262
2308
|
export interface Boolean extends Bottom<boolean, boolean, never, never, AST.Boolean, Boolean> {}
|
|
@@ -2273,6 +2319,7 @@ export const Boolean: Boolean = make(AST.boolean)
|
|
|
2273
2319
|
* Schema for `symbol` values.
|
|
2274
2320
|
*
|
|
2275
2321
|
* @see {@link Symbol} for the schema value.
|
|
2322
|
+
* @category models
|
|
2276
2323
|
* @since 4.0.0
|
|
2277
2324
|
*/
|
|
2278
2325
|
export interface Symbol extends Bottom<symbol, symbol, never, never, AST.Symbol, Symbol> {}
|
|
@@ -2281,6 +2328,7 @@ export interface Symbol extends Bottom<symbol, symbol, never, never, AST.Symbol,
|
|
|
2281
2328
|
* Schema for `symbol` values. Validates that the input is `typeof` `"symbol"`.
|
|
2282
2329
|
*
|
|
2283
2330
|
* @see {@link UniqueSymbol} for a schema that matches a specific symbol.
|
|
2331
|
+
* @category schemas
|
|
2284
2332
|
* @since 4.0.0
|
|
2285
2333
|
*/
|
|
2286
2334
|
export const Symbol: Symbol = make(AST.symbol)
|
|
@@ -2289,6 +2337,7 @@ export const Symbol: Symbol = make(AST.symbol)
|
|
|
2289
2337
|
* Schema for `bigint` values.
|
|
2290
2338
|
*
|
|
2291
2339
|
* @see {@link BigInt} for the schema value.
|
|
2340
|
+
* @category models
|
|
2292
2341
|
* @since 4.0.0
|
|
2293
2342
|
*/
|
|
2294
2343
|
export interface BigInt extends Bottom<bigint, bigint, never, never, AST.BigInt, BigInt> {}
|
|
@@ -2296,6 +2345,7 @@ export interface BigInt extends Bottom<bigint, bigint, never, never, AST.BigInt,
|
|
|
2296
2345
|
/**
|
|
2297
2346
|
* Schema for `bigint` values. Validates that the input is `typeof` `"bigint"`.
|
|
2298
2347
|
*
|
|
2348
|
+
* @category schemas
|
|
2299
2349
|
* @since 4.0.0
|
|
2300
2350
|
*/
|
|
2301
2351
|
export const BigInt: BigInt = make(AST.bigInt)
|
|
@@ -2304,14 +2354,16 @@ export const BigInt: BigInt = make(AST.bigInt)
|
|
|
2304
2354
|
* Schema for the `void` type.
|
|
2305
2355
|
*
|
|
2306
2356
|
* @see {@link Void} for the schema value.
|
|
2307
|
-
* @
|
|
2357
|
+
* @category models
|
|
2358
|
+
* @since 3.10.0
|
|
2308
2359
|
*/
|
|
2309
2360
|
export interface Void extends Bottom<void, void, never, never, AST.Void, Void> {}
|
|
2310
2361
|
|
|
2311
2362
|
/**
|
|
2312
2363
|
* Schema for the `void` type. Accepts `undefined` as the encoded value.
|
|
2313
2364
|
*
|
|
2314
|
-
* @
|
|
2365
|
+
* @category schemas
|
|
2366
|
+
* @since 3.10.0
|
|
2315
2367
|
*/
|
|
2316
2368
|
export const Void: Void = make(AST.void)
|
|
2317
2369
|
|
|
@@ -2319,6 +2371,7 @@ export const Void: Void = make(AST.void)
|
|
|
2319
2371
|
* Schema for the `object` type keyword.
|
|
2320
2372
|
*
|
|
2321
2373
|
* @see {@link ObjectKeyword} for the schema value.
|
|
2374
|
+
* @category models
|
|
2322
2375
|
* @since 4.0.0
|
|
2323
2376
|
*/
|
|
2324
2377
|
export interface ObjectKeyword extends Bottom<object, object, never, never, AST.ObjectKeyword, ObjectKeyword> {}
|
|
@@ -2327,6 +2380,7 @@ export interface ObjectKeyword extends Bottom<object, object, never, never, AST.
|
|
|
2327
2380
|
* Schema for the `object` type. Validates that the input is a non-null object or function
|
|
2328
2381
|
* (i.e. `typeof value === "object" && value !== null || typeof value === "function"`).
|
|
2329
2382
|
*
|
|
2383
|
+
* @category schemas
|
|
2330
2384
|
* @since 4.0.0
|
|
2331
2385
|
*/
|
|
2332
2386
|
export const ObjectKeyword: ObjectKeyword = make(AST.objectKeyword)
|
|
@@ -2335,6 +2389,7 @@ export const ObjectKeyword: ObjectKeyword = make(AST.objectKeyword)
|
|
|
2335
2389
|
* Represents a schema for a specific unique symbol.
|
|
2336
2390
|
*
|
|
2337
2391
|
* @see {@link UniqueSymbol} for the constructor function.
|
|
2392
|
+
* @category models
|
|
2338
2393
|
* @since 4.0.0
|
|
2339
2394
|
*/
|
|
2340
2395
|
export interface UniqueSymbol<sym extends symbol>
|
|
@@ -2345,6 +2400,7 @@ export interface UniqueSymbol<sym extends symbol>
|
|
|
2345
2400
|
* Creates a schema for a specific symbol. Only that exact symbol satisfies the schema.
|
|
2346
2401
|
*
|
|
2347
2402
|
* **Example** (Specific symbol)
|
|
2403
|
+
*
|
|
2348
2404
|
* ```ts
|
|
2349
2405
|
* import { Schema } from "effect"
|
|
2350
2406
|
*
|
|
@@ -2353,6 +2409,7 @@ export interface UniqueSymbol<sym extends symbol>
|
|
|
2353
2409
|
* ```
|
|
2354
2410
|
*
|
|
2355
2411
|
* @see {@link Symbol} for a schema that accepts any symbol.
|
|
2412
|
+
* @category constructors
|
|
2356
2413
|
* @since 4.0.0
|
|
2357
2414
|
*/
|
|
2358
2415
|
export function UniqueSymbol<const sym extends symbol>(symbol: sym): UniqueSymbol<sym> {
|
|
@@ -2372,13 +2429,14 @@ export function UniqueSymbol<const sym extends symbol>(symbol: sym): UniqueSymbo
|
|
|
2372
2429
|
* - `Struct.MakeIn<F>` — constructor input (optional/defaulted fields may be omitted)
|
|
2373
2430
|
* - `Struct.DecodingServices<F>` / `Struct.EncodingServices<F>` — required services
|
|
2374
2431
|
*
|
|
2375
|
-
* @since
|
|
2432
|
+
* @since 3.10.0
|
|
2376
2433
|
*/
|
|
2377
2434
|
export declare namespace Struct {
|
|
2378
2435
|
/**
|
|
2379
2436
|
* Constraint for a struct field map: an object whose values are schemas.
|
|
2380
2437
|
*
|
|
2381
|
-
* @
|
|
2438
|
+
* @category utility types
|
|
2439
|
+
* @since 3.10.0
|
|
2382
2440
|
*/
|
|
2383
2441
|
export type Fields = { readonly [x: PropertyKey]: Top }
|
|
2384
2442
|
|
|
@@ -2409,7 +2467,8 @@ export declare namespace Struct {
|
|
|
2409
2467
|
* Field schemas contribute their decoded `Type`. `optionalKey` and `optional`
|
|
2410
2468
|
* produce optional properties, while `mutableKey` produces writable properties.
|
|
2411
2469
|
*
|
|
2412
|
-
* @
|
|
2470
|
+
* @category utility types
|
|
2471
|
+
* @since 3.10.0
|
|
2413
2472
|
*/
|
|
2414
2473
|
export type Type<F extends Fields> = Simplify<Type_<F>>
|
|
2415
2474
|
|
|
@@ -2431,6 +2490,7 @@ export declare namespace Struct {
|
|
|
2431
2490
|
* The resulting property optionality and mutability follow the same field
|
|
2432
2491
|
* modifiers used by `Struct.Type`.
|
|
2433
2492
|
*
|
|
2493
|
+
* @category utility types
|
|
2434
2494
|
* @since 4.0.0
|
|
2435
2495
|
*/
|
|
2436
2496
|
export type Iso<F extends Fields> = Simplify<Iso_<F>>
|
|
@@ -2463,7 +2523,8 @@ export declare namespace Struct {
|
|
|
2463
2523
|
* mutability modifiers determine whether properties are optional or writable in
|
|
2464
2524
|
* the encoded shape.
|
|
2465
2525
|
*
|
|
2466
|
-
* @
|
|
2526
|
+
* @category utility types
|
|
2527
|
+
* @since 3.10.0
|
|
2467
2528
|
*/
|
|
2468
2529
|
export type Encoded<F extends Fields> = Simplify<Encoded_<F>>
|
|
2469
2530
|
|
|
@@ -2471,6 +2532,7 @@ export declare namespace Struct {
|
|
|
2471
2532
|
* Union of all decoding service requirements needed by the schemas in a struct
|
|
2472
2533
|
* field map.
|
|
2473
2534
|
*
|
|
2535
|
+
* @category utility types
|
|
2474
2536
|
* @since 4.0.0
|
|
2475
2537
|
*/
|
|
2476
2538
|
export type DecodingServices<F extends Fields> = { readonly [K in keyof F]: F[K]["DecodingServices"] }[keyof F]
|
|
@@ -2479,6 +2541,7 @@ export declare namespace Struct {
|
|
|
2479
2541
|
* Union of all encoding service requirements needed by the schemas in a struct
|
|
2480
2542
|
* field map.
|
|
2481
2543
|
*
|
|
2544
|
+
* @category utility types
|
|
2482
2545
|
* @since 4.0.0
|
|
2483
2546
|
*/
|
|
2484
2547
|
export type EncodingServices<F extends Fields> = { readonly [K in keyof F]: F[K]["EncodingServices"] }[keyof F]
|
|
@@ -2502,6 +2565,7 @@ export declare namespace Struct {
|
|
|
2502
2565
|
* Required fields use each field schema's `~type.make` input. Fields marked
|
|
2503
2566
|
* optional or with a constructor default may be omitted.
|
|
2504
2567
|
*
|
|
2568
|
+
* @category utility types
|
|
2505
2569
|
* @since 4.0.0
|
|
2506
2570
|
*/
|
|
2507
2571
|
export type MakeIn<F extends Fields> = Simplify<MakeIn_<F>>
|
|
@@ -2515,7 +2579,8 @@ export declare namespace Struct {
|
|
|
2515
2579
|
* The `fields` property exposes the original field map for reuse, and
|
|
2516
2580
|
* `mapFields` creates a new struct schema by transforming that field map.
|
|
2517
2581
|
*
|
|
2518
|
-
* @
|
|
2582
|
+
* @category models
|
|
2583
|
+
* @since 3.10.0
|
|
2519
2584
|
*/
|
|
2520
2585
|
export interface Struct<Fields extends Struct.Fields> extends
|
|
2521
2586
|
Bottom<
|
|
@@ -2617,8 +2682,8 @@ function makeStruct<const Fields extends Struct.Fields>(ast: AST.Objects, fields
|
|
|
2617
2682
|
* // { name: 'Alice', age: 30 }
|
|
2618
2683
|
* ```
|
|
2619
2684
|
*
|
|
2620
|
-
* @category
|
|
2621
|
-
* @since
|
|
2685
|
+
* @category constructors
|
|
2686
|
+
* @since 3.10.0
|
|
2622
2687
|
*/
|
|
2623
2688
|
export function Struct<const Fields extends Struct.Fields>(fields: Fields): Struct<Fields> {
|
|
2624
2689
|
return makeStruct(AST.struct(fields, undefined), fields)
|
|
@@ -2649,6 +2714,7 @@ interface fieldsAssign<NewFields extends Struct.Fields> extends Lambda {
|
|
|
2649
2714
|
* ]).mapMembers(Tuple.map(Schema.fieldsAssign({ c: Schema.Number })))
|
|
2650
2715
|
* ```
|
|
2651
2716
|
*
|
|
2717
|
+
* @category combinators
|
|
2652
2718
|
* @since 4.0.0
|
|
2653
2719
|
*/
|
|
2654
2720
|
export function fieldsAssign<const NewFields extends Struct.Fields>(fields: NewFields) {
|
|
@@ -2659,6 +2725,7 @@ export function fieldsAssign<const NewFields extends Struct.Fields>(fields: NewF
|
|
|
2659
2725
|
* Schema type for a struct with renamed encoded keys. Produced by
|
|
2660
2726
|
* {@link encodeKeys}.
|
|
2661
2727
|
*
|
|
2728
|
+
* @category transforming
|
|
2662
2729
|
* @since 4.0.0
|
|
2663
2730
|
*/
|
|
2664
2731
|
export interface encodeKeys<
|
|
@@ -2698,7 +2765,7 @@ export interface encodeKeys<
|
|
|
2698
2765
|
* // { name: 'Alice', age: 30 }
|
|
2699
2766
|
* ```
|
|
2700
2767
|
*
|
|
2701
|
-
* @category
|
|
2768
|
+
* @category transforming
|
|
2702
2769
|
* @since 4.0.0
|
|
2703
2770
|
*/
|
|
2704
2771
|
export function encodeKeys<
|
|
@@ -2753,8 +2820,8 @@ export function encodeKeys<
|
|
|
2753
2820
|
* // Alice Smith
|
|
2754
2821
|
* ```
|
|
2755
2822
|
*
|
|
2823
|
+
* @category transforming
|
|
2756
2824
|
* @since 4.0.0
|
|
2757
|
-
* @experimental
|
|
2758
2825
|
*/
|
|
2759
2826
|
export function extendTo<S extends Struct<Struct.Fields>, const Fields extends Struct.Fields>(
|
|
2760
2827
|
/** The new fields to add */
|
|
@@ -2800,7 +2867,7 @@ export function extendTo<S extends Struct<Struct.Fields>, const Fields extends S
|
|
|
2800
2867
|
* - `Record.Type<K, V>` — decoded type of the record
|
|
2801
2868
|
* - `Record.Encoded<K, V>` — encoded type of the record
|
|
2802
2869
|
*
|
|
2803
|
-
* @since
|
|
2870
|
+
* @since 3.10.0
|
|
2804
2871
|
*/
|
|
2805
2872
|
export declare namespace Record {
|
|
2806
2873
|
/**
|
|
@@ -2810,6 +2877,7 @@ export declare namespace Record {
|
|
|
2810
2877
|
* The key schema must decode and encode property keys (`string`, `number`, or
|
|
2811
2878
|
* `symbol`) so it can describe object property names.
|
|
2812
2879
|
*
|
|
2880
|
+
* @category utility types
|
|
2813
2881
|
* @since 4.0.0
|
|
2814
2882
|
*/
|
|
2815
2883
|
export interface Key extends Codec<PropertyKey, PropertyKey, unknown, unknown> {
|
|
@@ -2826,7 +2894,8 @@ export declare namespace Record {
|
|
|
2826
2894
|
* property's decoded `Type`. Optional and mutable value schemas affect the
|
|
2827
2895
|
* resulting property optionality and writability.
|
|
2828
2896
|
*
|
|
2829
|
-
* @
|
|
2897
|
+
* @category utility types
|
|
2898
|
+
* @since 3.10.0
|
|
2830
2899
|
*/
|
|
2831
2900
|
export type Type<Key extends Record.Key, Value extends Top> = Value extends
|
|
2832
2901
|
{ readonly "~type.optionality": "optional" } ?
|
|
@@ -2839,6 +2908,7 @@ export declare namespace Record {
|
|
|
2839
2908
|
* Computes the iso object type for a record schema from the key schema's `Iso`
|
|
2840
2909
|
* keys and the value schema's `Iso` values.
|
|
2841
2910
|
*
|
|
2911
|
+
* @category utility types
|
|
2842
2912
|
* @since 4.0.0
|
|
2843
2913
|
*/
|
|
2844
2914
|
export type Iso<Key extends Record.Key, Value extends Top> = Value extends
|
|
@@ -2856,7 +2926,8 @@ export declare namespace Record {
|
|
|
2856
2926
|
* Encoded-side optionality and mutability on the value schema determine whether
|
|
2857
2927
|
* the encoded record properties are optional or writable.
|
|
2858
2928
|
*
|
|
2859
|
-
* @
|
|
2929
|
+
* @category utility types
|
|
2930
|
+
* @since 3.10.0
|
|
2860
2931
|
*/
|
|
2861
2932
|
export type Encoded<Key extends Record.Key, Value extends Top> = Value extends
|
|
2862
2933
|
{ readonly "~encoded.optionality": "optional" } ?
|
|
@@ -2869,6 +2940,7 @@ export declare namespace Record {
|
|
|
2869
2940
|
* Union of the decoding service requirements of a record's key schema and value
|
|
2870
2941
|
* schema.
|
|
2871
2942
|
*
|
|
2943
|
+
* @category utility types
|
|
2872
2944
|
* @since 4.0.0
|
|
2873
2945
|
*/
|
|
2874
2946
|
export type DecodingServices<Key extends Record.Key, Value extends Top> =
|
|
@@ -2879,6 +2951,7 @@ export declare namespace Record {
|
|
|
2879
2951
|
* Union of the encoding service requirements of a record's key schema and value
|
|
2880
2952
|
* schema.
|
|
2881
2953
|
*
|
|
2954
|
+
* @category utility types
|
|
2882
2955
|
* @since 4.0.0
|
|
2883
2956
|
*/
|
|
2884
2957
|
export type EncodingServices<Key extends Record.Key, Value extends Top> =
|
|
@@ -2893,6 +2966,7 @@ export declare namespace Record {
|
|
|
2893
2966
|
* `~type.make` type. Value optionality and mutability determine whether
|
|
2894
2967
|
* properties are optional or writable.
|
|
2895
2968
|
*
|
|
2969
|
+
* @category utility types
|
|
2896
2970
|
* @since 4.0.0
|
|
2897
2971
|
*/
|
|
2898
2972
|
export type MakeIn<Key extends Record.Key, Value extends Top> = Value extends
|
|
@@ -2907,6 +2981,7 @@ export declare namespace Record {
|
|
|
2907
2981
|
* Companion type for a key-value record (map) with a typed key and value schema.
|
|
2908
2982
|
* Produced by {@link Record}.
|
|
2909
2983
|
*
|
|
2984
|
+
* @category models
|
|
2910
2985
|
* @since 4.0.0
|
|
2911
2986
|
*/
|
|
2912
2987
|
export interface $Record<Key extends Record.Key, Value extends Top> extends
|
|
@@ -2943,8 +3018,8 @@ export interface $Record<Key extends Record.Key, Value extends Top> extends
|
|
|
2943
3018
|
* // { a: 1, b: 2 }
|
|
2944
3019
|
* ```
|
|
2945
3020
|
*
|
|
2946
|
-
* @category
|
|
2947
|
-
* @since
|
|
3021
|
+
* @category constructors
|
|
3022
|
+
* @since 3.10.0
|
|
2948
3023
|
*/
|
|
2949
3024
|
export function Record<Key extends Record.Key, Value extends Top>(
|
|
2950
3025
|
key: Key,
|
|
@@ -2975,6 +3050,7 @@ export declare namespace StructWithRest {
|
|
|
2975
3050
|
* Constraint for object-like schemas that can be used as the fixed portion of a
|
|
2976
3051
|
* `StructWithRest` schema.
|
|
2977
3052
|
*
|
|
3053
|
+
* @category utility types
|
|
2978
3054
|
* @since 4.0.0
|
|
2979
3055
|
*/
|
|
2980
3056
|
export type Objects = Top & { readonly ast: AST.Objects }
|
|
@@ -2983,7 +3059,8 @@ export declare namespace StructWithRest {
|
|
|
2983
3059
|
* Readonly list of record schemas that provide the additional index signatures
|
|
2984
3060
|
* for a `StructWithRest` schema.
|
|
2985
3061
|
*
|
|
2986
|
-
* @
|
|
3062
|
+
* @category utility types
|
|
3063
|
+
* @since 3.10.0
|
|
2987
3064
|
*/
|
|
2988
3065
|
export type Records = ReadonlyArray<$Record<Record.Key, Top>>
|
|
2989
3066
|
|
|
@@ -2995,7 +3072,8 @@ export declare namespace StructWithRest {
|
|
|
2995
3072
|
* Computes the decoded type for `StructWithRest` by intersecting the base object
|
|
2996
3073
|
* schema's decoded `Type` with the decoded types of all rest record schemas.
|
|
2997
3074
|
*
|
|
2998
|
-
* @
|
|
3075
|
+
* @category utility types
|
|
3076
|
+
* @since 3.10.0
|
|
2999
3077
|
*/
|
|
3000
3078
|
export type Type<S extends Objects, Records extends StructWithRest.Records> =
|
|
3001
3079
|
& S["Type"]
|
|
@@ -3005,6 +3083,7 @@ export declare namespace StructWithRest {
|
|
|
3005
3083
|
* Computes the iso type for `StructWithRest` by intersecting the base object
|
|
3006
3084
|
* schema's `Iso` type with the `Iso` types of all rest record schemas.
|
|
3007
3085
|
*
|
|
3086
|
+
* @category utility types
|
|
3008
3087
|
* @since 4.0.0
|
|
3009
3088
|
*/
|
|
3010
3089
|
export type Iso<S extends Objects, Records extends StructWithRest.Records> =
|
|
@@ -3015,7 +3094,8 @@ export declare namespace StructWithRest {
|
|
|
3015
3094
|
* Computes the encoded type for `StructWithRest` by intersecting the base object
|
|
3016
3095
|
* schema's encoded type with the encoded types of all rest record schemas.
|
|
3017
3096
|
*
|
|
3018
|
-
* @
|
|
3097
|
+
* @category utility types
|
|
3098
|
+
* @since 3.10.0
|
|
3019
3099
|
*/
|
|
3020
3100
|
export type Encoded<S extends Objects, Records extends StructWithRest.Records> =
|
|
3021
3101
|
& S["Encoded"]
|
|
@@ -3025,6 +3105,7 @@ export declare namespace StructWithRest {
|
|
|
3025
3105
|
* Union of the decoding service requirements of the base object schema and all
|
|
3026
3106
|
* rest record schemas.
|
|
3027
3107
|
*
|
|
3108
|
+
* @category utility types
|
|
3028
3109
|
* @since 4.0.0
|
|
3029
3110
|
*/
|
|
3030
3111
|
export type DecodingServices<S extends Objects, Records extends StructWithRest.Records> =
|
|
@@ -3035,6 +3116,7 @@ export declare namespace StructWithRest {
|
|
|
3035
3116
|
* Union of the encoding service requirements of the base object schema and all
|
|
3036
3117
|
* rest record schemas.
|
|
3037
3118
|
*
|
|
3119
|
+
* @category utility types
|
|
3038
3120
|
* @since 4.0.0
|
|
3039
3121
|
*/
|
|
3040
3122
|
export type EncodingServices<S extends Objects, Records extends StructWithRest.Records> =
|
|
@@ -3046,6 +3128,7 @@ export declare namespace StructWithRest {
|
|
|
3046
3128
|
* intersecting the base object's make input with the make inputs of all rest
|
|
3047
3129
|
* record schemas.
|
|
3048
3130
|
*
|
|
3131
|
+
* @category utility types
|
|
3049
3132
|
* @since 4.0.0
|
|
3050
3133
|
*/
|
|
3051
3134
|
export type MakeIn<S extends Objects, Records extends StructWithRest.Records> =
|
|
@@ -3057,6 +3140,7 @@ export declare namespace StructWithRest {
|
|
|
3057
3140
|
* Companion type for a struct combined with one or more record schemas. Produced
|
|
3058
3141
|
* by {@link StructWithRest}.
|
|
3059
3142
|
*
|
|
3143
|
+
* @category models
|
|
3060
3144
|
* @since 4.0.0
|
|
3061
3145
|
*/
|
|
3062
3146
|
export interface StructWithRest<
|
|
@@ -3096,7 +3180,7 @@ export interface StructWithRest<
|
|
|
3096
3180
|
* type T = typeof schema.Type
|
|
3097
3181
|
* ```
|
|
3098
3182
|
*
|
|
3099
|
-
* @category
|
|
3183
|
+
* @category constructors
|
|
3100
3184
|
* @since 4.0.0
|
|
3101
3185
|
*/
|
|
3102
3186
|
export function StructWithRest<
|
|
@@ -3117,14 +3201,15 @@ export function StructWithRest<
|
|
|
3117
3201
|
* - `Tuple.Encoded<E>` — encoded tuple type
|
|
3118
3202
|
* - `Tuple.MakeIn<E>` — constructor input tuple
|
|
3119
3203
|
*
|
|
3120
|
-
* @since
|
|
3204
|
+
* @since 3.10.0
|
|
3121
3205
|
*/
|
|
3122
3206
|
export declare namespace Tuple {
|
|
3123
3207
|
/**
|
|
3124
3208
|
* Constraint for the readonly array of element schemas used to define a
|
|
3125
3209
|
* fixed-length `Tuple` schema.
|
|
3126
3210
|
*
|
|
3127
|
-
* @
|
|
3211
|
+
* @category utility types
|
|
3212
|
+
* @since 3.10.0
|
|
3128
3213
|
*/
|
|
3129
3214
|
export type Elements = ReadonlyArray<Top>
|
|
3130
3215
|
|
|
@@ -3145,7 +3230,8 @@ export declare namespace Tuple {
|
|
|
3145
3230
|
* Each element contributes its decoded `Type`; optional element schemas produce
|
|
3146
3231
|
* optional tuple positions.
|
|
3147
3232
|
*
|
|
3148
|
-
* @
|
|
3233
|
+
* @category utility types
|
|
3234
|
+
* @since 3.10.0
|
|
3149
3235
|
*/
|
|
3150
3236
|
export type Type<E extends Elements> = Type_<E>
|
|
3151
3237
|
|
|
@@ -3163,6 +3249,7 @@ export declare namespace Tuple {
|
|
|
3163
3249
|
* Computes the iso tuple type for a tuple element schema array from each
|
|
3164
3250
|
* element schema's `Iso` type.
|
|
3165
3251
|
*
|
|
3252
|
+
* @category utility types
|
|
3166
3253
|
* @since 4.0.0
|
|
3167
3254
|
*/
|
|
3168
3255
|
export type Iso<E extends Elements> = Iso_<E>
|
|
@@ -3184,7 +3271,8 @@ export declare namespace Tuple {
|
|
|
3184
3271
|
* Each element contributes its `Encoded` type; encoded-side optional element
|
|
3185
3272
|
* schemas produce optional tuple positions.
|
|
3186
3273
|
*
|
|
3187
|
-
* @
|
|
3274
|
+
* @category utility types
|
|
3275
|
+
* @since 3.10.0
|
|
3188
3276
|
*/
|
|
3189
3277
|
export type Encoded<E extends Elements> = Encoded_<E>
|
|
3190
3278
|
|
|
@@ -3192,6 +3280,7 @@ export declare namespace Tuple {
|
|
|
3192
3280
|
* Union of all decoding service requirements needed by the tuple element
|
|
3193
3281
|
* schemas.
|
|
3194
3282
|
*
|
|
3283
|
+
* @category utility types
|
|
3195
3284
|
* @since 4.0.0
|
|
3196
3285
|
*/
|
|
3197
3286
|
export type DecodingServices<E extends Elements> = E[number]["DecodingServices"]
|
|
@@ -3200,6 +3289,7 @@ export declare namespace Tuple {
|
|
|
3200
3289
|
* Union of all encoding service requirements needed by the tuple element
|
|
3201
3290
|
* schemas.
|
|
3202
3291
|
*
|
|
3292
|
+
* @category utility types
|
|
3203
3293
|
* @since 4.0.0
|
|
3204
3294
|
*/
|
|
3205
3295
|
export type EncodingServices<E extends Elements> = E[number]["EncodingServices"]
|
|
@@ -3223,6 +3313,7 @@ export declare namespace Tuple {
|
|
|
3223
3313
|
* Each element uses its `~type.make` input type. Optional elements and elements
|
|
3224
3314
|
* with constructor defaults produce optional tuple positions.
|
|
3225
3315
|
*
|
|
3316
|
+
* @category utility types
|
|
3226
3317
|
* @since 4.0.0
|
|
3227
3318
|
*/
|
|
3228
3319
|
export type MakeIn<E extends Elements> = MakeIn_<E>
|
|
@@ -3231,7 +3322,8 @@ export declare namespace Tuple {
|
|
|
3231
3322
|
/**
|
|
3232
3323
|
* Companion type for a fixed-length tuple. Produced by {@link Tuple}.
|
|
3233
3324
|
*
|
|
3234
|
-
* @
|
|
3325
|
+
* @category models
|
|
3326
|
+
* @since 3.10.0
|
|
3235
3327
|
*/
|
|
3236
3328
|
export interface Tuple<Elements extends Tuple.Elements> extends
|
|
3237
3329
|
Bottom<
|
|
@@ -3299,8 +3391,8 @@ function makeTuple<Elements extends Tuple.Elements>(ast: AST.Arrays, elements: E
|
|
|
3299
3391
|
* // [ 'hello', 42 ]
|
|
3300
3392
|
* ```
|
|
3301
3393
|
*
|
|
3302
|
-
* @category
|
|
3303
|
-
* @since
|
|
3394
|
+
* @category constructors
|
|
3395
|
+
* @since 3.10.0
|
|
3304
3396
|
*/
|
|
3305
3397
|
export function Tuple<const Elements extends ReadonlyArray<Top>>(elements: Elements): Tuple<Elements> {
|
|
3306
3398
|
return makeTuple(AST.tuple(elements), elements)
|
|
@@ -3321,7 +3413,8 @@ export declare namespace TupleWithRest {
|
|
|
3321
3413
|
* Constraint for tuple-like schemas that can be used as the fixed leading
|
|
3322
3414
|
* portion of a `TupleWithRest` schema.
|
|
3323
3415
|
*
|
|
3324
|
-
* @
|
|
3416
|
+
* @category utility types
|
|
3417
|
+
* @since 3.10.0
|
|
3325
3418
|
*/
|
|
3326
3419
|
export type TupleType = Top & {
|
|
3327
3420
|
readonly Type: ReadonlyArray<unknown>
|
|
@@ -3338,7 +3431,8 @@ export declare namespace TupleWithRest {
|
|
|
3338
3431
|
* The first schema describes the repeated rest element. Additional schemas, when
|
|
3339
3432
|
* present, describe trailing tuple elements after the repeated rest segment.
|
|
3340
3433
|
*
|
|
3341
|
-
* @
|
|
3434
|
+
* @category utility types
|
|
3435
|
+
* @since 3.10.0
|
|
3342
3436
|
*/
|
|
3343
3437
|
export type Rest = readonly [Top, ...Array<Top>]
|
|
3344
3438
|
|
|
@@ -3350,7 +3444,8 @@ export declare namespace TupleWithRest {
|
|
|
3350
3444
|
* values decoded by the first rest schema, and includes any trailing rest schemas
|
|
3351
3445
|
* as fixed tuple positions.
|
|
3352
3446
|
*
|
|
3353
|
-
* @
|
|
3447
|
+
* @category utility types
|
|
3448
|
+
* @since 3.10.0
|
|
3354
3449
|
*/
|
|
3355
3450
|
export type Type<T extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
|
|
3356
3451
|
readonly [infer Head extends Top, ...infer Tail extends ReadonlyArray<Top>] ? Readonly<[
|
|
@@ -3368,6 +3463,7 @@ export declare namespace TupleWithRest {
|
|
|
3368
3463
|
* or more values using the first rest schema's `Iso`, and includes any trailing
|
|
3369
3464
|
* rest schemas as fixed tuple positions.
|
|
3370
3465
|
*
|
|
3466
|
+
* @category utility types
|
|
3371
3467
|
* @since 4.0.0
|
|
3372
3468
|
*/
|
|
3373
3469
|
export type Iso<T extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
|
|
@@ -3386,7 +3482,8 @@ export declare namespace TupleWithRest {
|
|
|
3386
3482
|
* first rest schema may repeat zero or more times, and the encoded types of any
|
|
3387
3483
|
* additional rest schemas become required trailing tuple elements.
|
|
3388
3484
|
*
|
|
3389
|
-
* @
|
|
3485
|
+
* @category utility types
|
|
3486
|
+
* @since 3.10.0
|
|
3390
3487
|
*/
|
|
3391
3488
|
export type Encoded<E extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
|
|
3392
3489
|
readonly [infer Head extends Top, ...infer Tail extends ReadonlyArray<Top>] ? readonly [
|
|
@@ -3404,6 +3501,7 @@ export declare namespace TupleWithRest {
|
|
|
3404
3501
|
* the first rest schema may repeat zero or more times, and the make input types
|
|
3405
3502
|
* of any additional rest schemas become required trailing tuple elements.
|
|
3406
3503
|
*
|
|
3504
|
+
* @category utility types
|
|
3407
3505
|
* @since 4.0.0
|
|
3408
3506
|
*/
|
|
3409
3507
|
export type MakeIn<M extends ReadonlyArray<unknown>, Rest extends TupleWithRest.Rest> = Rest extends
|
|
@@ -3419,6 +3517,7 @@ export declare namespace TupleWithRest {
|
|
|
3419
3517
|
* Companion type for a tuple with additional rest elements. Produced by
|
|
3420
3518
|
* {@link TupleWithRest}.
|
|
3421
3519
|
*
|
|
3520
|
+
* @category models
|
|
3422
3521
|
* @since 4.0.0
|
|
3423
3522
|
*/
|
|
3424
3523
|
export interface TupleWithRest<
|
|
@@ -3466,7 +3565,7 @@ export interface TupleWithRest<
|
|
|
3466
3565
|
* // [ 'hello', 1, true, false ]
|
|
3467
3566
|
* ```
|
|
3468
3567
|
*
|
|
3469
|
-
* @category
|
|
3568
|
+
* @category constructors
|
|
3470
3569
|
* @since 4.0.0
|
|
3471
3570
|
*/
|
|
3472
3571
|
export function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extends TupleWithRest.Rest>(
|
|
@@ -3484,6 +3583,7 @@ export function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extend
|
|
|
3484
3583
|
* `ReadonlyArray<S["Encoded"]>`, and the element schema is available as
|
|
3485
3584
|
* `schema`.
|
|
3486
3585
|
*
|
|
3586
|
+
* @category models
|
|
3487
3587
|
* @since 4.0.0
|
|
3488
3588
|
*/
|
|
3489
3589
|
export interface $Array<S extends Top> extends
|
|
@@ -3507,7 +3607,7 @@ interface ArrayLambda extends Lambda {
|
|
|
3507
3607
|
}
|
|
3508
3608
|
|
|
3509
3609
|
/**
|
|
3510
|
-
* @category
|
|
3610
|
+
* @category constructors
|
|
3511
3611
|
* @since 4.0.0
|
|
3512
3612
|
*/
|
|
3513
3613
|
const ArraySchema = Struct_.lambda<ArrayLambda>((schema) => make(new AST.Arrays(false, [], [schema.ast]), { schema }))
|
|
@@ -3528,7 +3628,7 @@ export {
|
|
|
3528
3628
|
* // [ 'a', 'b', 'c' ]
|
|
3529
3629
|
* ```
|
|
3530
3630
|
*
|
|
3531
|
-
* @category
|
|
3631
|
+
* @category constructors
|
|
3532
3632
|
* @since 4.0.0
|
|
3533
3633
|
*/
|
|
3534
3634
|
ArraySchema as Array
|
|
@@ -3537,7 +3637,8 @@ export {
|
|
|
3537
3637
|
/**
|
|
3538
3638
|
* Companion type for a non-empty `ReadonlyArray`. Produced by {@link NonEmptyArray}.
|
|
3539
3639
|
*
|
|
3540
|
-
* @
|
|
3640
|
+
* @category models
|
|
3641
|
+
* @since 3.10.0
|
|
3541
3642
|
*/
|
|
3542
3643
|
export interface NonEmptyArray<S extends Top> extends
|
|
3543
3644
|
Bottom<
|
|
@@ -3574,8 +3675,8 @@ interface NonEmptyArrayLambda extends Lambda {
|
|
|
3574
3675
|
* Schema.decodeUnknownSync(schema)([]) // throws
|
|
3575
3676
|
* ```
|
|
3576
3677
|
*
|
|
3577
|
-
* @category
|
|
3578
|
-
* @since
|
|
3678
|
+
* @category constructors
|
|
3679
|
+
* @since 3.10.0
|
|
3579
3680
|
*/
|
|
3580
3681
|
export const NonEmptyArray = Struct_.lambda<NonEmptyArrayLambda>((schema) =>
|
|
3581
3682
|
make(new AST.Arrays(false, [schema.ast], [schema.ast]), { schema })
|
|
@@ -3590,7 +3691,7 @@ export const NonEmptyArray = Struct_.lambda<NonEmptyArrayLambda>((schema) =>
|
|
|
3590
3691
|
* `ReadonlyArray<S["Type"]>`.
|
|
3591
3692
|
*
|
|
3592
3693
|
* @category Arrays
|
|
3593
|
-
* @since
|
|
3694
|
+
* @since 3.10.0
|
|
3594
3695
|
*/
|
|
3595
3696
|
export interface ArrayEnsure<S extends Top> extends decodeTo<$Array<toType<S>>, Union<readonly [S, $Array<S>]>> {
|
|
3596
3697
|
readonly "Rebuild": ArrayEnsure<S>
|
|
@@ -3609,7 +3710,7 @@ export interface ArrayEnsure<S extends Top> extends decodeTo<$Array<toType<S>>,
|
|
|
3609
3710
|
* arrays and arrays with two or more elements are encoded as arrays.
|
|
3610
3711
|
*
|
|
3611
3712
|
* @category Arrays
|
|
3612
|
-
* @since
|
|
3713
|
+
* @since 3.10.0
|
|
3613
3714
|
*/
|
|
3614
3715
|
export function ArrayEnsure<S extends Top>(schema: S): ArrayEnsure<S> {
|
|
3615
3716
|
return Union([schema, ArraySchema(schema)]).pipe(decodeTo(
|
|
@@ -3624,6 +3725,7 @@ export function ArrayEnsure<S extends Top>(schema: S): ArrayEnsure<S> {
|
|
|
3624
3725
|
/**
|
|
3625
3726
|
* Companion type for an array with unique elements. Produced by {@link UniqueArray}.
|
|
3626
3727
|
*
|
|
3728
|
+
* @category models
|
|
3627
3729
|
* @since 4.0.0
|
|
3628
3730
|
*/
|
|
3629
3731
|
export interface UniqueArray<S extends Top> extends $Array<S> {
|
|
@@ -3636,7 +3738,7 @@ export interface UniqueArray<S extends Top> extends $Array<S> {
|
|
|
3636
3738
|
* The equivalence used to determine uniqueness is the one provided by
|
|
3637
3739
|
* `Schema.toEquivalence(item)`.
|
|
3638
3740
|
*
|
|
3639
|
-
* @category
|
|
3741
|
+
* @category constructors
|
|
3640
3742
|
* @since 4.0.0
|
|
3641
3743
|
*/
|
|
3642
3744
|
export function UniqueArray<S extends Top>(item: S): UniqueArray<S> {
|
|
@@ -3647,7 +3749,8 @@ export function UniqueArray<S extends Top>(item: S): UniqueArray<S> {
|
|
|
3647
3749
|
* Schema type that makes array or tuple elements mutable (removes `readonly`).
|
|
3648
3750
|
* Produced by {@link mutable}.
|
|
3649
3751
|
*
|
|
3650
|
-
* @
|
|
3752
|
+
* @category transforming
|
|
3753
|
+
* @since 3.10.0
|
|
3651
3754
|
*/
|
|
3652
3755
|
export interface mutable<S extends Top & { readonly "ast": AST.Arrays }> extends
|
|
3653
3756
|
Bottom<
|
|
@@ -3692,7 +3795,8 @@ interface mutableLambda extends Lambda {
|
|
|
3692
3795
|
* type T = typeof schema.Type
|
|
3693
3796
|
* ```
|
|
3694
3797
|
*
|
|
3695
|
-
* @
|
|
3798
|
+
* @category transforming
|
|
3799
|
+
* @since 3.10.0
|
|
3696
3800
|
*/
|
|
3697
3801
|
export const mutable = Struct_.lambda<mutableLambda>((schema) => {
|
|
3698
3802
|
return make(new AST.Arrays(true, schema.ast.elements, schema.ast.rest), { schema })
|
|
@@ -3701,7 +3805,8 @@ export const mutable = Struct_.lambda<mutableLambda>((schema) => {
|
|
|
3701
3805
|
/**
|
|
3702
3806
|
* Companion type for a union of multiple schemas. Produced by {@link Union}.
|
|
3703
3807
|
*
|
|
3704
|
-
* @
|
|
3808
|
+
* @category models
|
|
3809
|
+
* @since 3.10.0
|
|
3705
3810
|
*/
|
|
3706
3811
|
export interface Union<Members extends ReadonlyArray<Top>> extends
|
|
3707
3812
|
Bottom<
|
|
@@ -3779,8 +3884,8 @@ function makeUnion<Members extends ReadonlyArray<Top>>(
|
|
|
3779
3884
|
* Schema.decodeUnknownSync(schema)(42) // 42
|
|
3780
3885
|
* ```
|
|
3781
3886
|
*
|
|
3782
|
-
* @category
|
|
3783
|
-
* @since
|
|
3887
|
+
* @category constructors
|
|
3888
|
+
* @since 3.10.0
|
|
3784
3889
|
*/
|
|
3785
3890
|
export function Union<const Members extends ReadonlyArray<Top>>(
|
|
3786
3891
|
members: Members,
|
|
@@ -3793,6 +3898,7 @@ export function Union<const Members extends ReadonlyArray<Top>>(
|
|
|
3793
3898
|
* Represents a union schema of multiple literal values.
|
|
3794
3899
|
*
|
|
3795
3900
|
* @see {@link Literals} for the constructor function.
|
|
3901
|
+
* @category models
|
|
3796
3902
|
* @since 4.0.0
|
|
3797
3903
|
*/
|
|
3798
3904
|
export interface Literals<L extends ReadonlyArray<AST.LiteralValue>>
|
|
@@ -3816,6 +3922,7 @@ export interface Literals<L extends ReadonlyArray<AST.LiteralValue>>
|
|
|
3816
3922
|
* Creates a union schema from an array of literal values.
|
|
3817
3923
|
*
|
|
3818
3924
|
* **Example** (Status codes)
|
|
3925
|
+
*
|
|
3819
3926
|
* ```ts
|
|
3820
3927
|
* import { Schema } from "effect"
|
|
3821
3928
|
*
|
|
@@ -3824,7 +3931,7 @@ export interface Literals<L extends ReadonlyArray<AST.LiteralValue>>
|
|
|
3824
3931
|
* ```
|
|
3825
3932
|
*
|
|
3826
3933
|
* @see {@link Literal} for a schema that represents a single literal.
|
|
3827
|
-
* @category
|
|
3934
|
+
* @category constructors
|
|
3828
3935
|
* @since 4.0.0
|
|
3829
3936
|
*/
|
|
3830
3937
|
export function Literals<const L extends ReadonlyArray<AST.LiteralValue>>(literals: L): Literals<L> {
|
|
@@ -3852,7 +3959,8 @@ export function Literals<const L extends ReadonlyArray<AST.LiteralValue>>(litera
|
|
|
3852
3959
|
/**
|
|
3853
3960
|
* Companion type for `S | null`. Produced by {@link NullOr}.
|
|
3854
3961
|
*
|
|
3855
|
-
* @
|
|
3962
|
+
* @category models
|
|
3963
|
+
* @since 3.10.0
|
|
3856
3964
|
*/
|
|
3857
3965
|
export interface NullOr<S extends Top> extends Union<readonly [S, Null]> {
|
|
3858
3966
|
readonly "Rebuild": NullOr<S>
|
|
@@ -3866,15 +3974,16 @@ interface NullOrLambda extends Lambda {
|
|
|
3866
3974
|
/**
|
|
3867
3975
|
* Creates a union schema of `S | null`.
|
|
3868
3976
|
*
|
|
3869
|
-
* @category
|
|
3870
|
-
* @since
|
|
3977
|
+
* @category constructors
|
|
3978
|
+
* @since 3.10.0
|
|
3871
3979
|
*/
|
|
3872
3980
|
export const NullOr = Struct_.lambda<NullOrLambda>((self) => Union([self, Null]))
|
|
3873
3981
|
|
|
3874
3982
|
/**
|
|
3875
3983
|
* Companion type for `S | undefined`. Produced by {@link UndefinedOr}.
|
|
3876
3984
|
*
|
|
3877
|
-
* @
|
|
3985
|
+
* @category models
|
|
3986
|
+
* @since 3.10.0
|
|
3878
3987
|
*/
|
|
3879
3988
|
export interface UndefinedOr<S extends Top> extends Union<readonly [S, Undefined]> {
|
|
3880
3989
|
readonly "Rebuild": UndefinedOr<S>
|
|
@@ -3888,14 +3997,15 @@ interface UndefinedOrLambda extends Lambda {
|
|
|
3888
3997
|
/**
|
|
3889
3998
|
* Creates a union schema of `S | undefined`.
|
|
3890
3999
|
*
|
|
3891
|
-
* @category
|
|
3892
|
-
* @since
|
|
4000
|
+
* @category constructors
|
|
4001
|
+
* @since 3.10.0
|
|
3893
4002
|
*/
|
|
3894
4003
|
export const UndefinedOr = Struct_.lambda<UndefinedOrLambda>((self) => Union([self, Undefined]))
|
|
3895
4004
|
|
|
3896
4005
|
/**
|
|
3897
4006
|
* Companion type for `S | null | undefined`. Produced by {@link NullishOr}.
|
|
3898
|
-
* @
|
|
4007
|
+
* @category models
|
|
4008
|
+
* @since 3.10.0
|
|
3899
4009
|
*/
|
|
3900
4010
|
export interface NullishOr<S extends Top> extends Union<readonly [S, Null, Undefined]> {
|
|
3901
4011
|
readonly "Rebuild": NullishOr<S>
|
|
@@ -3908,14 +4018,15 @@ interface NullishOrLambda extends Lambda {
|
|
|
3908
4018
|
|
|
3909
4019
|
/**
|
|
3910
4020
|
* Creates a union schema of `S | null | undefined`.
|
|
3911
|
-
* @category
|
|
3912
|
-
* @since
|
|
4021
|
+
* @category constructors
|
|
4022
|
+
* @since 3.10.0
|
|
3913
4023
|
*/
|
|
3914
4024
|
export const NullishOr = Struct_.lambda<NullishOrLambda>((self) => Union([self, Null, Undefined]))
|
|
3915
4025
|
|
|
3916
4026
|
/**
|
|
3917
4027
|
* Schema type wrapping a lazily-evaluated schema. Produced by {@link suspend}.
|
|
3918
|
-
* @
|
|
4028
|
+
* @category models
|
|
4029
|
+
* @since 3.10.0
|
|
3919
4030
|
*/
|
|
3920
4031
|
export interface suspend<S extends Top> extends
|
|
3921
4032
|
Bottom<
|
|
@@ -3943,6 +4054,7 @@ export interface suspend<S extends Top> extends
|
|
|
3943
4054
|
* preventing infinite recursion during schema definition.
|
|
3944
4055
|
*
|
|
3945
4056
|
* **Example** (Recursive tree schema)
|
|
4057
|
+
*
|
|
3946
4058
|
* ```ts
|
|
3947
4059
|
* import { Schema } from "effect"
|
|
3948
4060
|
*
|
|
@@ -3957,8 +4069,8 @@ export interface suspend<S extends Top> extends
|
|
|
3957
4069
|
* })
|
|
3958
4070
|
* ```
|
|
3959
4071
|
*
|
|
3960
|
-
* @category
|
|
3961
|
-
* @since
|
|
4072
|
+
* @category constructors
|
|
4073
|
+
* @since 3.10.0
|
|
3962
4074
|
*/
|
|
3963
4075
|
export function suspend<S extends Top>(f: () => S): suspend<S> {
|
|
3964
4076
|
return make(new AST.Suspend(() => f().ast))
|
|
@@ -3969,6 +4081,7 @@ export function suspend<S extends Top>(f: () => S): suspend<S> {
|
|
|
3969
4081
|
* changing the TypeScript type.
|
|
3970
4082
|
*
|
|
3971
4083
|
* **Example** (Adding checks to a schema)
|
|
4084
|
+
*
|
|
3972
4085
|
* ```ts
|
|
3973
4086
|
* import { Schema } from "effect"
|
|
3974
4087
|
*
|
|
@@ -3977,7 +4090,7 @@ export function suspend<S extends Top>(f: () => S): suspend<S> {
|
|
|
3977
4090
|
* )
|
|
3978
4091
|
* ```
|
|
3979
4092
|
*
|
|
3980
|
-
* @category
|
|
4093
|
+
* @category filtering
|
|
3981
4094
|
* @since 4.0.0
|
|
3982
4095
|
*/
|
|
3983
4096
|
export function check<S extends Top>(...checks: readonly [AST.Check<S["Type"]>, ...Array<AST.Check<S["Type"]>>]) {
|
|
@@ -3988,7 +4101,8 @@ export function check<S extends Top>(...checks: readonly [AST.Check<S["Type"]>,
|
|
|
3988
4101
|
* The output type of {@link refine}, narrowing the schema's `Type` to `T` via a
|
|
3989
4102
|
* type guard.
|
|
3990
4103
|
*
|
|
3991
|
-
* @
|
|
4104
|
+
* @category filtering
|
|
4105
|
+
* @since 3.10.0
|
|
3992
4106
|
*/
|
|
3993
4107
|
export interface refine<T extends S["Type"], S extends Top> extends
|
|
3994
4108
|
Bottom<
|
|
@@ -4022,8 +4136,8 @@ export interface refine<T extends S["Type"], S extends Top> extends
|
|
|
4022
4136
|
* names type-level failures before the refinement runs; it does not name the
|
|
4023
4137
|
* failed refinement itself.
|
|
4024
4138
|
*
|
|
4025
|
-
* @category
|
|
4026
|
-
* @since
|
|
4139
|
+
* @category filtering
|
|
4140
|
+
* @since 3.10.0
|
|
4027
4141
|
*/
|
|
4028
4142
|
export function refine<S extends Top, T extends S["Type"]>(
|
|
4029
4143
|
refinement: (value: S["Type"]) => value is T,
|
|
@@ -4039,7 +4153,8 @@ type DistributeBrands<B> = UnionToIntersection<B extends infer U extends string
|
|
|
4039
4153
|
* The output type of {@link brand}, intersecting the schema's `Type` with one or
|
|
4040
4154
|
* more {@link Brand.Brand} tags.
|
|
4041
4155
|
*
|
|
4042
|
-
* @
|
|
4156
|
+
* @category branding
|
|
4157
|
+
* @since 3.10.0
|
|
4043
4158
|
*/
|
|
4044
4159
|
export interface brand<S extends Top, B> extends
|
|
4045
4160
|
Bottom<
|
|
@@ -4068,8 +4183,8 @@ export interface brand<S extends Top, B> extends
|
|
|
4068
4183
|
* Adds a nominal brand to a schema, intersecting the output type with
|
|
4069
4184
|
* `Brand.Brand<B>` to prevent accidental mixing of structurally identical types.
|
|
4070
4185
|
*
|
|
4071
|
-
* @category
|
|
4072
|
-
* @since
|
|
4186
|
+
* @category branding
|
|
4187
|
+
* @since 3.10.0
|
|
4073
4188
|
*/
|
|
4074
4189
|
export function brand<B extends string>(identifier: B) {
|
|
4075
4190
|
return <S extends Top>(schema: S): brand<S["Rebuild"], B> =>
|
|
@@ -4080,8 +4195,8 @@ export function brand<B extends string>(identifier: B) {
|
|
|
4080
4195
|
* Creates a branded schema from a {@link Brand.Constructor}, applying the
|
|
4081
4196
|
* constructor's checks and brand tag to the underlying schema.
|
|
4082
4197
|
*
|
|
4083
|
-
* @category
|
|
4084
|
-
* @since
|
|
4198
|
+
* @category branding
|
|
4199
|
+
* @since 3.10.0
|
|
4085
4200
|
*/
|
|
4086
4201
|
export function fromBrand<A extends Brand.Brand<any>>(identifier: string, ctor: Brand.Constructor<A>) {
|
|
4087
4202
|
return <S extends Top & { readonly "Type": Brand.Brand.Unbranded<A> }>(
|
|
@@ -4098,6 +4213,7 @@ export function fromBrand<A extends Brand.Brand<any>>(identifier: string, ctor:
|
|
|
4098
4213
|
* or augment it — including adding service requirements via `RD`.
|
|
4099
4214
|
*
|
|
4100
4215
|
* @see {@link middlewareDecoding} for the constructor
|
|
4216
|
+
* @category decoding
|
|
4101
4217
|
* @since 4.0.0
|
|
4102
4218
|
*/
|
|
4103
4219
|
export interface middlewareDecoding<S extends Top, RD> extends
|
|
@@ -4142,6 +4258,7 @@ export interface middlewareDecoding<S extends Top, RD> extends
|
|
|
4142
4258
|
* ```
|
|
4143
4259
|
*
|
|
4144
4260
|
* @see {@link catchDecoding} for a simpler error-recovery variant
|
|
4261
|
+
* @category decoding
|
|
4145
4262
|
* @since 4.0.0
|
|
4146
4263
|
*/
|
|
4147
4264
|
export function middlewareDecoding<S extends Top, RD>(
|
|
@@ -4164,6 +4281,7 @@ export function middlewareDecoding<S extends Top, RD>(
|
|
|
4164
4281
|
* or augment it — including adding service requirements via `RE`.
|
|
4165
4282
|
*
|
|
4166
4283
|
* @see {@link middlewareEncoding} for the constructor
|
|
4284
|
+
* @category encoding
|
|
4167
4285
|
* @since 4.0.0
|
|
4168
4286
|
*/
|
|
4169
4287
|
export interface middlewareEncoding<S extends Top, RE> extends
|
|
@@ -4208,6 +4326,7 @@ export interface middlewareEncoding<S extends Top, RE> extends
|
|
|
4208
4326
|
* ```
|
|
4209
4327
|
*
|
|
4210
4328
|
* @see {@link catchEncoding} for a simpler error-recovery variant
|
|
4329
|
+
* @category encoding
|
|
4211
4330
|
* @since 4.0.0
|
|
4212
4331
|
*/
|
|
4213
4332
|
export function middlewareEncoding<S extends Top, RE>(
|
|
@@ -4240,6 +4359,7 @@ export function middlewareEncoding<S extends Top, RE>(
|
|
|
4240
4359
|
* ```
|
|
4241
4360
|
*
|
|
4242
4361
|
* @see {@link catchDecodingWithContext} to add service requirements to the handler
|
|
4362
|
+
* @category error handling
|
|
4243
4363
|
* @since 4.0.0
|
|
4244
4364
|
*/
|
|
4245
4365
|
export function catchDecoding<S extends Top>(
|
|
@@ -4251,6 +4371,7 @@ export function catchDecoding<S extends Top>(
|
|
|
4251
4371
|
/**
|
|
4252
4372
|
* Like {@link catchDecoding}, but the handler may require Effect services (`R`).
|
|
4253
4373
|
*
|
|
4374
|
+
* @category error handling
|
|
4254
4375
|
* @since 4.0.0
|
|
4255
4376
|
*/
|
|
4256
4377
|
export function catchDecodingWithContext<S extends Top, R = never>(
|
|
@@ -4267,6 +4388,7 @@ export function catchDecodingWithContext<S extends Top, R = never>(
|
|
|
4267
4388
|
* succeeds with a fallback value or re-fails with a (possibly different) issue.
|
|
4268
4389
|
*
|
|
4269
4390
|
* @see {@link catchEncodingWithContext} to add service requirements to the handler
|
|
4391
|
+
* @category error handling
|
|
4270
4392
|
* @since 4.0.0
|
|
4271
4393
|
*/
|
|
4272
4394
|
export function catchEncoding<S extends Top>(
|
|
@@ -4278,6 +4400,7 @@ export function catchEncoding<S extends Top>(
|
|
|
4278
4400
|
/**
|
|
4279
4401
|
* Like {@link catchEncoding}, but the handler may require Effect services (`R`).
|
|
4280
4402
|
*
|
|
4403
|
+
* @category error handling
|
|
4281
4404
|
* @since 4.0.0
|
|
4282
4405
|
*/
|
|
4283
4406
|
export function catchEncodingWithContext<S extends Top, R = never>(
|
|
@@ -4297,6 +4420,7 @@ export function catchEncodingWithContext<S extends Top, R = never>(
|
|
|
4297
4420
|
* services are `To["EncodingServices"] | From["EncodingServices"] | RE`.
|
|
4298
4421
|
*
|
|
4299
4422
|
* @see {@link compose} for the passthrough (no transformation) variant
|
|
4423
|
+
* @category transforming
|
|
4300
4424
|
* @since 4.0.0
|
|
4301
4425
|
*/
|
|
4302
4426
|
export interface decodeTo<To extends Top, From extends Top, RD = never, RE = never> extends
|
|
@@ -4329,7 +4453,8 @@ export interface decodeTo<To extends Top, From extends Top, RD = never, RE = nev
|
|
|
4329
4453
|
* are composed using their natural encoding/decoding chain.
|
|
4330
4454
|
*
|
|
4331
4455
|
* @see {@link decodeTo} for the transformation variant
|
|
4332
|
-
* @
|
|
4456
|
+
* @category transforming
|
|
4457
|
+
* @since 3.10.0
|
|
4333
4458
|
*/
|
|
4334
4459
|
export interface compose<To extends Top, From extends Top> extends decodeTo<To, From> {}
|
|
4335
4460
|
|
|
@@ -4373,6 +4498,7 @@ export interface compose<To extends Top, From extends Top> extends decodeTo<To,
|
|
|
4373
4498
|
* // result: 123
|
|
4374
4499
|
* ```
|
|
4375
4500
|
*
|
|
4501
|
+
* @category transforming
|
|
4376
4502
|
* @since 4.0.0
|
|
4377
4503
|
*/
|
|
4378
4504
|
export function decodeTo<To extends Top>(to: To): <From extends Top>(from: From) => compose<To, From>
|
|
@@ -4440,7 +4566,8 @@ export function decodeTo<To extends Top, From extends Top, RD = never, RE = neve
|
|
|
4440
4566
|
* // result: "hello"
|
|
4441
4567
|
* ```
|
|
4442
4568
|
*
|
|
4443
|
-
* @
|
|
4569
|
+
* @category transforming
|
|
4570
|
+
* @since 3.10.0
|
|
4444
4571
|
*/
|
|
4445
4572
|
export function decode<S extends Top, RD = never, RE = never>(transformation: {
|
|
4446
4573
|
readonly decode: Getter.Getter<S["Type"], S["Type"], RD>
|
|
@@ -4471,6 +4598,7 @@ export function decode<S extends Top, RD = never, RE = never>(transformation: {
|
|
|
4471
4598
|
* )
|
|
4472
4599
|
* ```
|
|
4473
4600
|
*
|
|
4601
|
+
* @category transforming
|
|
4474
4602
|
* @since 4.0.0
|
|
4475
4603
|
*/
|
|
4476
4604
|
export function encodeTo<To extends Top>(
|
|
@@ -4517,7 +4645,8 @@ export function encodeTo<To extends Top, From extends Top, RD = never, RE = neve
|
|
|
4517
4645
|
* )
|
|
4518
4646
|
* ```
|
|
4519
4647
|
*
|
|
4520
|
-
* @
|
|
4648
|
+
* @category transforming
|
|
4649
|
+
* @since 3.10.0
|
|
4521
4650
|
*/
|
|
4522
4651
|
export function encode<S extends Top, RD = never, RE = never>(transformation: {
|
|
4523
4652
|
readonly decode: Getter.Getter<S["Encoded"], S["Encoded"], RD>
|
|
@@ -4533,6 +4662,7 @@ export function encode<S extends Top, RD = never, RE = never>(transformation: {
|
|
|
4533
4662
|
*
|
|
4534
4663
|
* Only schemas that satisfy this constraint can be passed to {@link withConstructorDefault}.
|
|
4535
4664
|
*
|
|
4665
|
+
* @category models
|
|
4536
4666
|
* @since 4.0.0
|
|
4537
4667
|
*/
|
|
4538
4668
|
export interface WithoutConstructorDefault {
|
|
@@ -4550,7 +4680,8 @@ export interface WithoutConstructorDefault {
|
|
|
4550
4680
|
* added.
|
|
4551
4681
|
*
|
|
4552
4682
|
* @see {@link withConstructorDefault} for the constructor
|
|
4553
|
-
* @
|
|
4683
|
+
* @category constructors
|
|
4684
|
+
* @since 3.10.0
|
|
4554
4685
|
*/
|
|
4555
4686
|
export interface withConstructorDefault<S extends Top & WithoutConstructorDefault> extends
|
|
4556
4687
|
Bottom<
|
|
@@ -4596,7 +4727,8 @@ export interface withConstructorDefault<S extends Top & WithoutConstructorDefaul
|
|
|
4596
4727
|
* // value: { name: "anonymous" }
|
|
4597
4728
|
* ```
|
|
4598
4729
|
*
|
|
4599
|
-
* @
|
|
4730
|
+
* @category constructors
|
|
4731
|
+
* @since 3.10.0
|
|
4600
4732
|
*/
|
|
4601
4733
|
export function withConstructorDefault<S extends Top & WithoutConstructorDefault>(
|
|
4602
4734
|
// `S["~type.make.in"]` instead of `S["Type"]` is intentional here because
|
|
@@ -4612,6 +4744,7 @@ export function withConstructorDefault<S extends Top & WithoutConstructorDefault
|
|
|
4612
4744
|
* side is `optionalKey` and that fills in a default `Encoded` value during decoding.
|
|
4613
4745
|
*
|
|
4614
4746
|
* @see {@link withDecodingDefaultKey} for the constructor
|
|
4747
|
+
* @category decoding
|
|
4615
4748
|
* @since 4.0.0
|
|
4616
4749
|
*/
|
|
4617
4750
|
export interface withDecodingDefaultKey<S extends Top, R = never> extends decodeTo<S, optionalKey<toEncoded<S>>, R> {
|
|
@@ -4625,6 +4758,7 @@ export interface withDecodingDefaultKey<S extends Top, R = never> extends decode
|
|
|
4625
4758
|
* - `"passthrough"` (default): pass the value through during encoding
|
|
4626
4759
|
* - `"omit"`: omit the key from the encoded output
|
|
4627
4760
|
*
|
|
4761
|
+
* @category models
|
|
4628
4762
|
* @since 4.0.0
|
|
4629
4763
|
*/
|
|
4630
4764
|
export type DecodingDefaultOptions = {
|
|
@@ -4660,6 +4794,7 @@ export type DecodingDefaultOptions = {
|
|
|
4660
4794
|
*
|
|
4661
4795
|
* @see {@link withDecodingDefault} for the value-level variant (key absent **or** `undefined`)
|
|
4662
4796
|
* @see {@link withDecodingDefaultTypeKey} for the variant where the default is a `Type` value
|
|
4797
|
+
* @category decoding
|
|
4663
4798
|
* @since 4.0.0
|
|
4664
4799
|
*/
|
|
4665
4800
|
export function withDecodingDefaultKey<S extends Top, R = never>(
|
|
@@ -4681,6 +4816,7 @@ export function withDecodingDefaultKey<S extends Top, R = never>(
|
|
|
4681
4816
|
* during decoding.
|
|
4682
4817
|
*
|
|
4683
4818
|
* @see {@link withDecodingDefaultTypeKey} for the constructor
|
|
4819
|
+
* @category decoding
|
|
4684
4820
|
* @since 4.0.0
|
|
4685
4821
|
*/
|
|
4686
4822
|
export interface withDecodingDefaultTypeKey<S extends Top, R = never>
|
|
@@ -4706,6 +4842,7 @@ export interface withDecodingDefaultTypeKey<S extends Top, R = never>
|
|
|
4706
4842
|
*
|
|
4707
4843
|
* @see {@link withDecodingDefaultKey} for the variant where the default is an `Encoded` value
|
|
4708
4844
|
* @see {@link withDecodingDefaultType} for the value-level variant
|
|
4845
|
+
* @category decoding
|
|
4709
4846
|
* @since 4.0.0
|
|
4710
4847
|
*/
|
|
4711
4848
|
export function withDecodingDefaultTypeKey<S extends Top, R = never>(
|
|
@@ -4725,7 +4862,8 @@ export function withDecodingDefaultTypeKey<S extends Top, R = never>(
|
|
|
4725
4862
|
* side is `optional` and that fills in a default `Encoded` value during decoding.
|
|
4726
4863
|
*
|
|
4727
4864
|
* @see {@link withDecodingDefault} for the constructor
|
|
4728
|
-
* @
|
|
4865
|
+
* @category decoding
|
|
4866
|
+
* @since 3.10.0
|
|
4729
4867
|
*/
|
|
4730
4868
|
export interface withDecodingDefault<S extends Top, R = never> extends decodeTo<S, optional<toEncoded<S>>, R> {
|
|
4731
4869
|
readonly "Rebuild": withDecodingDefault<S, R>
|
|
@@ -4760,7 +4898,8 @@ export interface withDecodingDefault<S extends Top, R = never> extends decodeTo<
|
|
|
4760
4898
|
*
|
|
4761
4899
|
* @see {@link withDecodingDefaultKey} for the key-level variant (key absent only, not `undefined`)
|
|
4762
4900
|
* @see {@link withDecodingDefaultType} for the variant where the default is a `Type` value
|
|
4763
|
-
* @
|
|
4901
|
+
* @category decoding
|
|
4902
|
+
* @since 3.10.0
|
|
4764
4903
|
*/
|
|
4765
4904
|
export function withDecodingDefault<S extends Top, R = never>(
|
|
4766
4905
|
defaultValue: Effect.Effect<S["Encoded"], SchemaError, R>,
|
|
@@ -4781,6 +4920,7 @@ export function withDecodingDefault<S extends Top, R = never>(
|
|
|
4781
4920
|
* decoding.
|
|
4782
4921
|
*
|
|
4783
4922
|
* @see {@link withDecodingDefaultType} for the constructor
|
|
4923
|
+
* @category decoding
|
|
4784
4924
|
* @since 4.0.0
|
|
4785
4925
|
*/
|
|
4786
4926
|
export interface withDecodingDefaultType<S extends Top, R = never>
|
|
@@ -4806,6 +4946,7 @@ export interface withDecodingDefaultType<S extends Top, R = never>
|
|
|
4806
4946
|
*
|
|
4807
4947
|
* @see {@link withDecodingDefault} for the variant where the default is an `Encoded` value
|
|
4808
4948
|
* @see {@link withDecodingDefaultTypeKey} for the key-level variant
|
|
4949
|
+
* @category decoding
|
|
4809
4950
|
* @since 4.0.0
|
|
4810
4951
|
*/
|
|
4811
4952
|
export function withDecodingDefaultType<S extends Top, R = never>(
|
|
@@ -4826,7 +4967,8 @@ export function withDecodingDefaultType<S extends Top, R = never>(
|
|
|
4826
4967
|
* Used as the type of the `_tag` field in {@link TaggedStruct} and related helpers.
|
|
4827
4968
|
*
|
|
4828
4969
|
* @see {@link tag} for the constructor
|
|
4829
|
-
* @
|
|
4970
|
+
* @category constructors
|
|
4971
|
+
* @since 3.10.0
|
|
4830
4972
|
*/
|
|
4831
4973
|
export interface tag<Tag extends AST.LiteralValue> extends withConstructorDefault<Literal<Tag>> {}
|
|
4832
4974
|
|
|
@@ -4849,7 +4991,8 @@ export interface tag<Tag extends AST.LiteralValue> extends withConstructorDefaul
|
|
|
4849
4991
|
*
|
|
4850
4992
|
* @see {@link tagDefaultOmit} to also omit the tag during encoding
|
|
4851
4993
|
* @see {@link TaggedStruct} for a shorthand that adds `_tag` automatically
|
|
4852
|
-
* @
|
|
4994
|
+
* @category constructors
|
|
4995
|
+
* @since 3.10.0
|
|
4853
4996
|
*/
|
|
4854
4997
|
export function tag<Tag extends AST.LiteralValue>(literal: Tag): tag<Tag> {
|
|
4855
4998
|
return Literal(literal).pipe(withConstructorDefault(Effect.succeed(literal)))
|
|
@@ -4876,6 +5019,7 @@ export function tag<Tag extends AST.LiteralValue>(literal: Tag): tag<Tag> {
|
|
|
4876
5019
|
* ```
|
|
4877
5020
|
*
|
|
4878
5021
|
* @see {@link tag} for the variant that keeps the tag during encoding
|
|
5022
|
+
* @category constructors
|
|
4879
5023
|
* @since 4.0.0
|
|
4880
5024
|
*/
|
|
4881
5025
|
export function tagDefaultOmit<Tag extends AST.LiteralValue>(literal: Tag) {
|
|
@@ -4886,7 +5030,8 @@ export function tagDefaultOmit<Tag extends AST.LiteralValue>(literal: Tag) {
|
|
|
4886
5030
|
* The type produced by {@link TaggedStruct} — a {@link Struct} with an extra `_tag` field of type {@link tag}.
|
|
4887
5031
|
*
|
|
4888
5032
|
* @see {@link TaggedStruct} for the constructor
|
|
4889
|
-
* @
|
|
5033
|
+
* @category models
|
|
5034
|
+
* @since 3.10.0
|
|
4890
5035
|
*/
|
|
4891
5036
|
export type TaggedStruct<Tag extends AST.LiteralValue, Fields extends Struct.Fields> = Struct<
|
|
4892
5037
|
Simplify<{ readonly _tag: tag<Tag> } & Fields>
|
|
@@ -4931,8 +5076,8 @@ export type TaggedStruct<Tag extends AST.LiteralValue, Fields extends Struct.Fie
|
|
|
4931
5076
|
* const literal = tagged.fields._tag.schema.literal
|
|
4932
5077
|
* ```
|
|
4933
5078
|
*
|
|
4934
|
-
* @category
|
|
4935
|
-
* @since
|
|
5079
|
+
* @category constructors
|
|
5080
|
+
* @since 3.10.0
|
|
4936
5081
|
*/
|
|
4937
5082
|
export function TaggedStruct<const Tag extends AST.LiteralValue, const Fields extends Struct.Fields>(
|
|
4938
5083
|
value: Tag,
|
|
@@ -4982,8 +5127,8 @@ type TaggedUnionUtils<
|
|
|
4982
5127
|
* The type produced by {@link toTaggedUnion} — a {@link Union} augmented with `cases`, `guards`, `isAnyOf`, and `match` utilities.
|
|
4983
5128
|
*
|
|
4984
5129
|
* @see {@link toTaggedUnion} for the constructor
|
|
5130
|
+
* @category combinators
|
|
4985
5131
|
* @since 4.0.0
|
|
4986
|
-
* @experimental
|
|
4987
5132
|
*/
|
|
4988
5133
|
export type toTaggedUnion<
|
|
4989
5134
|
Tag extends PropertyKey,
|
|
@@ -5011,8 +5156,8 @@ export type toTaggedUnion<
|
|
|
5011
5156
|
* ```
|
|
5012
5157
|
*
|
|
5013
5158
|
* @see {@link TaggedUnion} for a shorthand that builds the union from scratch
|
|
5159
|
+
* @category combinators
|
|
5014
5160
|
* @since 4.0.0
|
|
5015
|
-
* @experimental
|
|
5016
5161
|
*/
|
|
5017
5162
|
export function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag) {
|
|
5018
5163
|
return <const Members extends ReadonlyArray<Top & { readonly Type: { readonly [K in Tag]: PropertyKey } }>>(
|
|
@@ -5068,8 +5213,8 @@ export function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag) {
|
|
|
5068
5213
|
* Produced by {@link TaggedUnion}.
|
|
5069
5214
|
*
|
|
5070
5215
|
* @see {@link TaggedUnion} for the constructor
|
|
5216
|
+
* @category models
|
|
5071
5217
|
* @since 4.0.0
|
|
5072
|
-
* @experimental
|
|
5073
5218
|
*/
|
|
5074
5219
|
export interface TaggedUnion<Cases extends Record<string, Top>> extends
|
|
5075
5220
|
Bottom<
|
|
@@ -5121,7 +5266,7 @@ export interface TaggedUnion<Cases extends Record<string, Top>> extends
|
|
|
5121
5266
|
* ```
|
|
5122
5267
|
*
|
|
5123
5268
|
* @see {@link toTaggedUnion} to augment an existing union instead
|
|
5124
|
-
* @category
|
|
5269
|
+
* @category constructors
|
|
5125
5270
|
* @since 4.0.0
|
|
5126
5271
|
*/
|
|
5127
5272
|
export function TaggedUnion<const CasesByTag extends Record<string, Struct.Fields>>(
|
|
@@ -5143,6 +5288,7 @@ export function TaggedUnion<const CasesByTag extends Record<string, Struct.Field
|
|
|
5143
5288
|
* making the decoded value nominally distinct.
|
|
5144
5289
|
*
|
|
5145
5290
|
* @see {@link Opaque} for the constructor
|
|
5291
|
+
* @category models
|
|
5146
5292
|
* @since 4.0.0
|
|
5147
5293
|
*/
|
|
5148
5294
|
export interface Opaque<Self, S extends Top, Brand> extends
|
|
@@ -5188,6 +5334,7 @@ export interface Opaque<Self, S extends Top, Brand> extends
|
|
|
5188
5334
|
* // person: Person
|
|
5189
5335
|
* ```
|
|
5190
5336
|
*
|
|
5337
|
+
* @category constructors
|
|
5191
5338
|
* @since 4.0.0
|
|
5192
5339
|
*/
|
|
5193
5340
|
export function Opaque<Self, Brand = {}>() {
|
|
@@ -5202,7 +5349,8 @@ export function Opaque<Self, Brand = {}>() {
|
|
|
5202
5349
|
* The type produced by {@link instanceOf} — a declaration schema that validates class instances.
|
|
5203
5350
|
*
|
|
5204
5351
|
* @see {@link instanceOf} for the constructor
|
|
5205
|
-
* @
|
|
5352
|
+
* @category models
|
|
5353
|
+
* @since 3.10.0
|
|
5206
5354
|
*/
|
|
5207
5355
|
export interface instanceOf<T, Iso = T> extends declare<T, Iso> {
|
|
5208
5356
|
readonly "Rebuild": instanceOf<T, Iso>
|
|
@@ -5223,8 +5371,8 @@ export interface instanceOf<T, Iso = T> extends declare<T, Iso> {
|
|
|
5223
5371
|
* // decoded: Date
|
|
5224
5372
|
* ```
|
|
5225
5373
|
*
|
|
5226
|
-
* @category
|
|
5227
|
-
* @since
|
|
5374
|
+
* @category constructors
|
|
5375
|
+
* @since 3.10.0
|
|
5228
5376
|
*/
|
|
5229
5377
|
export function instanceOf<C extends abstract new(...args: any) => any, Iso = InstanceType<C>>(
|
|
5230
5378
|
constructor: C,
|
|
@@ -5237,6 +5385,7 @@ export function instanceOf<C extends abstract new(...args: any) => any, Iso = In
|
|
|
5237
5385
|
* Constructs an `AST.Link` that describes how a value of type `T` encodes to and decodes from a `To` schema.
|
|
5238
5386
|
* Used when building low-level AST transformations that bridge two schema types.
|
|
5239
5387
|
*
|
|
5388
|
+
* @category transforming
|
|
5240
5389
|
* @since 4.0.0
|
|
5241
5390
|
*/
|
|
5242
5391
|
export function link<T>() {
|
|
@@ -5331,8 +5480,8 @@ export const makeFilter: <T>(
|
|
|
5331
5480
|
* {@link Issue.Issue}; the result is wrapped in an {@link Issue.Pointer}
|
|
5332
5481
|
* at the given `path`.
|
|
5333
5482
|
*
|
|
5334
|
-
* @category
|
|
5335
|
-
* @since
|
|
5483
|
+
* @category models
|
|
5484
|
+
* @since 3.10.0
|
|
5336
5485
|
*/
|
|
5337
5486
|
export type FilterIssue = string | Issue.Issue | {
|
|
5338
5487
|
readonly path: ReadonlyArray<PropertyKey>
|
|
@@ -5357,8 +5506,8 @@ export type FilterIssue = string | Issue.Issue | {
|
|
|
5357
5506
|
* to returning that element directly; otherwise the entries are grouped
|
|
5358
5507
|
* into an {@link Issue.Composite}.
|
|
5359
5508
|
*
|
|
5360
|
-
* @category
|
|
5361
|
-
* @since
|
|
5509
|
+
* @category models
|
|
5510
|
+
* @since 3.10.0
|
|
5362
5511
|
*/
|
|
5363
5512
|
export type FilterOutput =
|
|
5364
5513
|
| undefined
|
|
@@ -6753,6 +6902,7 @@ export const isBetweenBigDecimal = makeIsBetween({
|
|
|
6753
6902
|
* length.
|
|
6754
6903
|
*
|
|
6755
6904
|
* **Example** (Minimum length check)
|
|
6905
|
+
*
|
|
6756
6906
|
* ```ts
|
|
6757
6907
|
* import { Schema } from "effect"
|
|
6758
6908
|
*
|
|
@@ -7230,7 +7380,7 @@ export function isUnique<T>(annotations?: Annotations.Filter) {
|
|
|
7230
7380
|
* strings with a length of at least one.
|
|
7231
7381
|
*
|
|
7232
7382
|
* @category String
|
|
7233
|
-
* @since
|
|
7383
|
+
* @since 3.10.0
|
|
7234
7384
|
*/
|
|
7235
7385
|
export interface NonEmptyString extends String {
|
|
7236
7386
|
readonly "Rebuild": NonEmptyString
|
|
@@ -7241,7 +7391,7 @@ export interface NonEmptyString extends String {
|
|
|
7241
7391
|
* character.
|
|
7242
7392
|
*
|
|
7243
7393
|
* @category String
|
|
7244
|
-
* @since
|
|
7394
|
+
* @since 3.10.0
|
|
7245
7395
|
*/
|
|
7246
7396
|
export const NonEmptyString: NonEmptyString = String.check(isNonEmpty())
|
|
7247
7397
|
|
|
@@ -7250,7 +7400,7 @@ export const NonEmptyString: NonEmptyString = String.check(isNonEmpty())
|
|
|
7250
7400
|
* length is exactly one.
|
|
7251
7401
|
*
|
|
7252
7402
|
* @category String
|
|
7253
|
-
* @since
|
|
7403
|
+
* @since 3.10.0
|
|
7254
7404
|
*/
|
|
7255
7405
|
export interface Char extends String {
|
|
7256
7406
|
readonly "Rebuild": Char
|
|
@@ -7260,7 +7410,7 @@ export interface Char extends String {
|
|
|
7260
7410
|
* A schema representing a single character.
|
|
7261
7411
|
*
|
|
7262
7412
|
* @category String
|
|
7263
|
-
* @since
|
|
7413
|
+
* @since 3.10.0
|
|
7264
7414
|
*/
|
|
7265
7415
|
export const Char: Char = String.check(isLengthBetween(1, 1))
|
|
7266
7416
|
|
|
@@ -7271,8 +7421,7 @@ export const Char: Char = String.check(isLengthBetween(1, 1))
|
|
|
7271
7421
|
* **Example** (Option schema)
|
|
7272
7422
|
*
|
|
7273
7423
|
* ```ts
|
|
7274
|
-
* import { Schema } from "effect"
|
|
7275
|
-
* import { Option } from "effect"
|
|
7424
|
+
* import { Option, Schema } from "effect"
|
|
7276
7425
|
*
|
|
7277
7426
|
* const schema = Schema.Option(Schema.Number)
|
|
7278
7427
|
*
|
|
@@ -7283,7 +7432,7 @@ export const Char: Char = String.check(isLengthBetween(1, 1))
|
|
|
7283
7432
|
* ```
|
|
7284
7433
|
*
|
|
7285
7434
|
* @category Option
|
|
7286
|
-
* @since
|
|
7435
|
+
* @since 3.10.0
|
|
7287
7436
|
*/
|
|
7288
7437
|
export interface Option<A extends Top> extends
|
|
7289
7438
|
declareConstructor<
|
|
@@ -7315,7 +7464,7 @@ export type OptionIso<A extends Top> =
|
|
|
7315
7464
|
* Creates a schema for `Option<A>`. See {@link Option} for details.
|
|
7316
7465
|
*
|
|
7317
7466
|
* @category Option
|
|
7318
|
-
* @since
|
|
7467
|
+
* @since 3.10.0
|
|
7319
7468
|
*/
|
|
7320
7469
|
export function Option<A extends Top>(value: A): Option<A> {
|
|
7321
7470
|
const schema = declareConstructor<
|
|
@@ -7383,7 +7532,7 @@ export function Option<A extends Top>(value: A): Option<A> {
|
|
|
7383
7532
|
* other values as `Some`.
|
|
7384
7533
|
*
|
|
7385
7534
|
* @category Option
|
|
7386
|
-
* @since
|
|
7535
|
+
* @since 3.10.0
|
|
7387
7536
|
*/
|
|
7388
7537
|
export interface OptionFromNullOr<S extends Top> extends decodeTo<Option<toType<S>>, NullOr<S>> {
|
|
7389
7538
|
readonly "Rebuild": OptionFromNullOr<S>
|
|
@@ -7401,7 +7550,7 @@ export interface OptionFromNullOr<S extends Top> extends decodeTo<Option<toType<
|
|
|
7401
7550
|
* - `Some` is encoded as the value
|
|
7402
7551
|
*
|
|
7403
7552
|
* @category Option
|
|
7404
|
-
* @since
|
|
7553
|
+
* @since 3.10.0
|
|
7405
7554
|
*/
|
|
7406
7555
|
export function OptionFromNullOr<S extends Top>(schema: S): OptionFromNullOr<S> {
|
|
7407
7556
|
return NullOr(schema).pipe(decodeTo(
|
|
@@ -7415,7 +7564,7 @@ export function OptionFromNullOr<S extends Top>(schema: S): OptionFromNullOr<S>
|
|
|
7415
7564
|
* all other values as `Some`.
|
|
7416
7565
|
*
|
|
7417
7566
|
* @category Option
|
|
7418
|
-
* @since
|
|
7567
|
+
* @since 3.10.0
|
|
7419
7568
|
*/
|
|
7420
7569
|
export interface OptionFromUndefinedOr<S extends Top> extends decodeTo<Option<toType<S>>, UndefinedOr<S>> {
|
|
7421
7570
|
readonly "Rebuild": OptionFromUndefinedOr<S>
|
|
@@ -7433,7 +7582,7 @@ export interface OptionFromUndefinedOr<S extends Top> extends decodeTo<Option<to
|
|
|
7433
7582
|
* - `Some` is encoded as the value
|
|
7434
7583
|
*
|
|
7435
7584
|
* @category Option
|
|
7436
|
-
* @since
|
|
7585
|
+
* @since 3.10.0
|
|
7437
7586
|
*/
|
|
7438
7587
|
export function OptionFromUndefinedOr<S extends Top>(schema: S): OptionFromUndefinedOr<S> {
|
|
7439
7588
|
return UndefinedOr(schema).pipe(decodeTo(
|
|
@@ -7447,7 +7596,7 @@ export function OptionFromUndefinedOr<S extends Top>(schema: S): OptionFromUndef
|
|
|
7447
7596
|
* `None` and all other values as `Some`.
|
|
7448
7597
|
*
|
|
7449
7598
|
* @category Option
|
|
7450
|
-
* @since
|
|
7599
|
+
* @since 3.10.0
|
|
7451
7600
|
*/
|
|
7452
7601
|
export interface OptionFromNullishOr<S extends Top> extends decodeTo<Option<toType<S>>, NullishOr<S>> {
|
|
7453
7602
|
readonly "Rebuild": OptionFromNullishOr<S>
|
|
@@ -7465,7 +7614,7 @@ export interface OptionFromNullishOr<S extends Top> extends decodeTo<Option<toTy
|
|
|
7465
7614
|
* - `Some` is encoded as the value
|
|
7466
7615
|
*
|
|
7467
7616
|
* @category Option
|
|
7468
|
-
* @since
|
|
7617
|
+
* @since 3.10.0
|
|
7469
7618
|
*/
|
|
7470
7619
|
export function OptionFromNullishOr<S extends Top>(
|
|
7471
7620
|
schema: S,
|
|
@@ -7711,7 +7860,7 @@ export function Result<A extends Top, E extends Top>(
|
|
|
7711
7860
|
* values. The inner value is hidden from error messages.
|
|
7712
7861
|
*
|
|
7713
7862
|
* @category Redacted
|
|
7714
|
-
* @since
|
|
7863
|
+
* @since 3.10.0
|
|
7715
7864
|
*/
|
|
7716
7865
|
export interface Redacted<S extends Top> extends
|
|
7717
7866
|
declareConstructor<
|
|
@@ -7745,7 +7894,7 @@ export interface Redacted<S extends Top> extends
|
|
|
7745
7894
|
* but it will deserialize a value into a `Redacted` instance.
|
|
7746
7895
|
*
|
|
7747
7896
|
* @category Redacted
|
|
7748
|
-
* @since
|
|
7897
|
+
* @since 3.10.0
|
|
7749
7898
|
*/
|
|
7750
7899
|
export function Redacted<S extends Top>(value: S, options?: {
|
|
7751
7900
|
readonly label?: string | undefined
|
|
@@ -8026,7 +8175,7 @@ function causeReasonToFormatter<E>(error: Formatter<E>, defect: Formatter<unknow
|
|
|
8026
8175
|
* unexpected defects.
|
|
8027
8176
|
*
|
|
8028
8177
|
* @category Cause
|
|
8029
|
-
* @since
|
|
8178
|
+
* @since 3.10.0
|
|
8030
8179
|
*/
|
|
8031
8180
|
export interface Cause<E extends Top, D extends Top> extends
|
|
8032
8181
|
declareConstructor<
|
|
@@ -8055,7 +8204,7 @@ export type CauseIso<E extends Top, D extends Top> = ReadonlyArray<CauseReasonIs
|
|
|
8055
8204
|
* and unexpected defects.
|
|
8056
8205
|
*
|
|
8057
8206
|
* @category Cause
|
|
8058
|
-
* @since
|
|
8207
|
+
* @since 3.10.0
|
|
8059
8208
|
*/
|
|
8060
8209
|
export function Cause<E extends Top, D extends Top>(error: E, defect: D): Cause<E, D> {
|
|
8061
8210
|
const schema = declareConstructor<Cause_.Cause<E["Type"]>, Cause_.Cause<E["Encoded"]>, CauseIso<E, D>>()(
|
|
@@ -8138,7 +8287,7 @@ const ErrorJsonEncoded = Struct({
|
|
|
8138
8287
|
* and decodes that object back into an `Error`. The stack trace is omitted from
|
|
8139
8288
|
* the encoded form for security.
|
|
8140
8289
|
*
|
|
8141
|
-
* @category
|
|
8290
|
+
* @category schemas
|
|
8142
8291
|
* @since 4.0.0
|
|
8143
8292
|
*/
|
|
8144
8293
|
export const Error: Error = instanceOf(globalThis.Error, {
|
|
@@ -8162,7 +8311,7 @@ export const Error: Error = instanceOf(globalThis.Error, {
|
|
|
8162
8311
|
* Encodes an `Error` as an object with `message`, optional `name`, and optional
|
|
8163
8312
|
* `stack` properties, and decodes that object back into an `Error`.
|
|
8164
8313
|
*
|
|
8165
|
-
* @category
|
|
8314
|
+
* @category schemas
|
|
8166
8315
|
* @since 4.0.0
|
|
8167
8316
|
*/
|
|
8168
8317
|
export const ErrorWithStack: Error = instanceOf(globalThis.Error, {
|
|
@@ -8189,7 +8338,7 @@ export const ErrorWithStack: Error = instanceOf(globalThis.Error, {
|
|
|
8189
8338
|
* `Error` values and arbitrary unknown defect values.
|
|
8190
8339
|
*
|
|
8191
8340
|
* @category Defect
|
|
8192
|
-
* @since
|
|
8341
|
+
* @since 3.10.0
|
|
8193
8342
|
*/
|
|
8194
8343
|
export interface Defect extends
|
|
8195
8344
|
Union<
|
|
@@ -8228,8 +8377,8 @@ const defectTransformation = new Transformation.Transformation(
|
|
|
8228
8377
|
* Unknown defects are serialized with `JSON.stringify` when possible and fall
|
|
8229
8378
|
* back to Effect's formatted representation when JSON serialization fails.
|
|
8230
8379
|
*
|
|
8231
|
-
* @category
|
|
8232
|
-
* @since
|
|
8380
|
+
* @category constructors
|
|
8381
|
+
* @since 3.10.0
|
|
8233
8382
|
*/
|
|
8234
8383
|
export const Defect: Defect = Union([
|
|
8235
8384
|
ErrorJsonEncoded.pipe(decodeTo(Error, Transformation.errorFromErrorJsonEncoded())),
|
|
@@ -8270,7 +8419,7 @@ export const DefectWithStack: Defect = Union([
|
|
|
8270
8419
|
* failure with a `Cause` containing typed errors and defects.
|
|
8271
8420
|
*
|
|
8272
8421
|
* @category Exit
|
|
8273
|
-
* @since
|
|
8422
|
+
* @since 3.10.0
|
|
8274
8423
|
*/
|
|
8275
8424
|
export interface Exit<A extends Top, E extends Top, D extends Top> extends
|
|
8276
8425
|
declareConstructor<
|
|
@@ -8309,7 +8458,7 @@ export type ExitIso<A extends Top, E extends Top, D extends Top> = {
|
|
|
8309
8458
|
* failure, and unexpected defect channels.
|
|
8310
8459
|
*
|
|
8311
8460
|
* @category Exit
|
|
8312
|
-
* @since
|
|
8461
|
+
* @since 3.10.0
|
|
8313
8462
|
*/
|
|
8314
8463
|
export function Exit<A extends Top, E extends Top, D extends Top>(value: A, error: E, defect: D): Exit<A, E, D> {
|
|
8315
8464
|
const schema = declareConstructor<
|
|
@@ -8439,7 +8588,7 @@ export type ReadonlyMapIso<Key extends Top, Value extends Top> = ReadonlyArray<r
|
|
|
8439
8588
|
* conform to the provided schemas.
|
|
8440
8589
|
*
|
|
8441
8590
|
* @category ReadonlyMap
|
|
8442
|
-
* @since
|
|
8591
|
+
* @since 3.10.0
|
|
8443
8592
|
*/
|
|
8444
8593
|
export function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value: Value): $ReadonlyMap<Key, Value> {
|
|
8445
8594
|
const schema = declareConstructor<
|
|
@@ -8507,7 +8656,7 @@ export function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value:
|
|
|
8507
8656
|
* provided schemas.
|
|
8508
8657
|
*
|
|
8509
8658
|
* @category HashMap
|
|
8510
|
-
* @since
|
|
8659
|
+
* @since 3.10.0
|
|
8511
8660
|
*/
|
|
8512
8661
|
export interface HashMap<Key extends Top, Value extends Top> extends
|
|
8513
8662
|
declareConstructor<
|
|
@@ -8536,7 +8685,7 @@ export type HashMapIso<Key extends Top, Value extends Top> = ReadonlyArray<reado
|
|
|
8536
8685
|
* conform to the provided schemas.
|
|
8537
8686
|
*
|
|
8538
8687
|
* @category HashMap
|
|
8539
|
-
* @since
|
|
8688
|
+
* @since 3.10.0
|
|
8540
8689
|
*/
|
|
8541
8690
|
export function HashMap<Key extends Top, Value extends Top>(key: Key, value: Value): HashMap<Key, Value> {
|
|
8542
8691
|
const schema = declareConstructor<
|
|
@@ -8633,7 +8782,7 @@ export type ReadonlySetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>
|
|
|
8633
8782
|
* provided element schema.
|
|
8634
8783
|
*
|
|
8635
8784
|
* @category ReadonlySet
|
|
8636
|
-
* @since
|
|
8785
|
+
* @since 3.10.0
|
|
8637
8786
|
*/
|
|
8638
8787
|
export function ReadonlySet<Value extends Top>(value: Value): $ReadonlySet<Value> {
|
|
8639
8788
|
const schema = declareConstructor<
|
|
@@ -8701,7 +8850,7 @@ export function ReadonlySet<Value extends Top>(value: Value): $ReadonlySet<Value
|
|
|
8701
8850
|
* schema.
|
|
8702
8851
|
*
|
|
8703
8852
|
* @category HashSet
|
|
8704
|
-
* @since
|
|
8853
|
+
* @since 3.10.0
|
|
8705
8854
|
*/
|
|
8706
8855
|
export interface HashSet<Value extends Top> extends
|
|
8707
8856
|
declareConstructor<
|
|
@@ -8729,7 +8878,7 @@ export type HashSetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>
|
|
|
8729
8878
|
* provided schema.
|
|
8730
8879
|
*
|
|
8731
8880
|
* @category HashSet
|
|
8732
|
-
* @since
|
|
8881
|
+
* @since 3.10.0
|
|
8733
8882
|
*/
|
|
8734
8883
|
export function HashSet<Value extends Top>(value: Value): HashSet<Value> {
|
|
8735
8884
|
const schema = declareConstructor<
|
|
@@ -8797,7 +8946,7 @@ export function HashSet<Value extends Top>(value: Value): HashSet<Value> {
|
|
|
8797
8946
|
* must conform to the provided schema.
|
|
8798
8947
|
*
|
|
8799
8948
|
* @category Chunk
|
|
8800
|
-
* @since
|
|
8949
|
+
* @since 3.10.0
|
|
8801
8950
|
*/
|
|
8802
8951
|
export interface Chunk<Value extends Top> extends
|
|
8803
8952
|
declareConstructor<
|
|
@@ -8825,7 +8974,7 @@ export type ChunkIso<Value extends Top> = ReadonlyArray<Value["Iso"]>
|
|
|
8825
8974
|
* provided schema.
|
|
8826
8975
|
*
|
|
8827
8976
|
* @category Chunk
|
|
8828
|
-
* @since
|
|
8977
|
+
* @since 3.10.0
|
|
8829
8978
|
*/
|
|
8830
8979
|
export function Chunk<Value extends Top>(value: Value): Chunk<Value> {
|
|
8831
8980
|
const schema = declareConstructor<
|
|
@@ -9088,7 +9237,7 @@ export const Date: Date = instanceOf(
|
|
|
9088
9237
|
* JavaScript `Date` instances.
|
|
9089
9238
|
*
|
|
9090
9239
|
* @category Date
|
|
9091
|
-
* @since
|
|
9240
|
+
* @since 3.10.0
|
|
9092
9241
|
*/
|
|
9093
9242
|
export interface DateFromString extends decodeTo<Date, String> {
|
|
9094
9243
|
readonly "Rebuild": DateFromString
|
|
@@ -9106,7 +9255,7 @@ export interface DateFromString extends decodeTo<Date, String> {
|
|
|
9106
9255
|
* `"Invalid Date"`.
|
|
9107
9256
|
*
|
|
9108
9257
|
* @category Date
|
|
9109
|
-
* @since
|
|
9258
|
+
* @since 3.10.0
|
|
9110
9259
|
*/
|
|
9111
9260
|
export const DateFromString: DateFromString = DateString.pipe(decodeTo(Date, Transformation.dateFromString))
|
|
9112
9261
|
|
|
@@ -9136,7 +9285,7 @@ export const DateValid: DateValid = Date.check(isDateValid())
|
|
|
9136
9285
|
* Type-level representation of the schema for Effect `Duration` values.
|
|
9137
9286
|
*
|
|
9138
9287
|
* @category Duration
|
|
9139
|
-
* @since
|
|
9288
|
+
* @since 3.10.0
|
|
9140
9289
|
*/
|
|
9141
9290
|
export interface Duration extends declare<Duration_.Duration> {
|
|
9142
9291
|
readonly "Rebuild": Duration
|
|
@@ -9151,8 +9300,7 @@ export interface Duration extends declare<Duration_.Duration> {
|
|
|
9151
9300
|
* **Example** (Duration schema)
|
|
9152
9301
|
*
|
|
9153
9302
|
* ```ts
|
|
9154
|
-
* import { Schema } from "effect"
|
|
9155
|
-
* import { Duration } from "effect"
|
|
9303
|
+
* import { Duration, Schema } from "effect"
|
|
9156
9304
|
*
|
|
9157
9305
|
* Schema.decodeUnknownSync(Schema.Duration)(Duration.seconds(5))
|
|
9158
9306
|
* // => Duration(5s)
|
|
@@ -9160,7 +9308,7 @@ export interface Duration extends declare<Duration_.Duration> {
|
|
|
9160
9308
|
*
|
|
9161
9309
|
* @category Duration
|
|
9162
9310
|
*
|
|
9163
|
-
* @since
|
|
9311
|
+
* @since 3.10.0
|
|
9164
9312
|
*/
|
|
9165
9313
|
export const Duration: Duration = declare(
|
|
9166
9314
|
Duration_.isDuration,
|
|
@@ -9256,7 +9404,7 @@ export const DurationFromString: DurationFromString = DurationString.pipe(
|
|
|
9256
9404
|
* nanosecond `bigint` values into `Duration` values.
|
|
9257
9405
|
*
|
|
9258
9406
|
* @category Duration
|
|
9259
|
-
* @since
|
|
9407
|
+
* @since 3.10.0
|
|
9260
9408
|
*/
|
|
9261
9409
|
export interface DurationFromNanos extends decodeTo<Duration, BigInt> {
|
|
9262
9410
|
readonly "Rebuild": DurationFromNanos
|
|
@@ -9277,7 +9425,7 @@ const bigint0 = globalThis.BigInt(0)
|
|
|
9277
9425
|
* `Duration.infinity`.
|
|
9278
9426
|
*
|
|
9279
9427
|
* @category Duration
|
|
9280
|
-
* @since
|
|
9428
|
+
* @since 3.10.0
|
|
9281
9429
|
*/
|
|
9282
9430
|
export const DurationFromNanos: DurationFromNanos = BigInt.check(isGreaterThanOrEqualToBigInt(bigint0)).pipe(
|
|
9283
9431
|
decodeTo(Duration, Transformation.durationFromNanos)
|
|
@@ -9288,7 +9436,7 @@ export const DurationFromNanos: DurationFromNanos = BigInt.check(isGreaterThanOr
|
|
|
9288
9436
|
* non-negative millisecond numbers into `Duration` values.
|
|
9289
9437
|
*
|
|
9290
9438
|
* @category Duration
|
|
9291
|
-
* @since
|
|
9439
|
+
* @since 3.10.0
|
|
9292
9440
|
*/
|
|
9293
9441
|
export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
9294
9442
|
readonly "Rebuild": DurationFromMillis
|
|
@@ -9308,7 +9456,7 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
|
9308
9456
|
* representing milliseconds
|
|
9309
9457
|
*
|
|
9310
9458
|
* @category Duration
|
|
9311
|
-
* @since
|
|
9459
|
+
* @since 3.10.0
|
|
9312
9460
|
*/
|
|
9313
9461
|
export const DurationFromMillis: DurationFromMillis = Number.check(isGreaterThanOrEqualTo(0)).pipe(
|
|
9314
9462
|
decodeTo(Duration, Transformation.durationFromMillis)
|
|
@@ -9318,7 +9466,7 @@ export const DurationFromMillis: DurationFromMillis = Number.check(isGreaterThan
|
|
|
9318
9466
|
* Type-level representation of the schema for Effect `BigDecimal` values.
|
|
9319
9467
|
*
|
|
9320
9468
|
* @category BigDecimal
|
|
9321
|
-
* @since
|
|
9469
|
+
* @since 3.10.0
|
|
9322
9470
|
*/
|
|
9323
9471
|
export interface BigDecimal extends declare<BigDecimal_.BigDecimal> {
|
|
9324
9472
|
readonly "Rebuild": BigDecimal
|
|
@@ -9334,7 +9482,7 @@ const BigDecimalString = String.annotate({ expected: "a string that will be deco
|
|
|
9334
9482
|
* - encodes `BigDecimal` as a `string`
|
|
9335
9483
|
*
|
|
9336
9484
|
* @category BigDecimal
|
|
9337
|
-
* @since
|
|
9485
|
+
* @since 3.10.0
|
|
9338
9486
|
*/
|
|
9339
9487
|
export const BigDecimal: BigDecimal = declare(
|
|
9340
9488
|
BigDecimal_.isBigDecimal,
|
|
@@ -9410,7 +9558,7 @@ export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
|
9410
9558
|
* - Any value is encoded as a JSON string using `JSON.stringify`.
|
|
9411
9559
|
* - If the value is not a valid JSON value, encoding fails.
|
|
9412
9560
|
*
|
|
9413
|
-
* **Example**
|
|
9561
|
+
* **Example** (Decoding unknown JSON strings)
|
|
9414
9562
|
*
|
|
9415
9563
|
* ```ts
|
|
9416
9564
|
* import { Schema } from "effect"
|
|
@@ -9445,7 +9593,7 @@ export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
|
9445
9593
|
* The resulting schema first parses the input string as JSON, and then runs the
|
|
9446
9594
|
* provided schema on the parsed result.
|
|
9447
9595
|
*
|
|
9448
|
-
* **Example**
|
|
9596
|
+
* **Example** (Decoding JSON strings with a schema)
|
|
9449
9597
|
*
|
|
9450
9598
|
* ```ts
|
|
9451
9599
|
* import { Schema } from "effect"
|
|
@@ -9463,7 +9611,7 @@ export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
|
9463
9611
|
* resulting schema will be a JSON Schema with a `contentSchema` property that
|
|
9464
9612
|
* contains the JSON Schema for the given schema.
|
|
9465
9613
|
*
|
|
9466
|
-
* **Example**
|
|
9614
|
+
* **Example** (Emitting JSON Schema for a JSON string decoder)
|
|
9467
9615
|
*
|
|
9468
9616
|
* ```ts
|
|
9469
9617
|
* import { Schema } from "effect"
|
|
@@ -9733,6 +9881,7 @@ export interface fromFormData<S extends Top> extends decodeTo<S, FormData> {
|
|
|
9733
9881
|
* // Success({"a":1}) // Note: the value is a number
|
|
9734
9882
|
* ```
|
|
9735
9883
|
*
|
|
9884
|
+
* @category decoding
|
|
9736
9885
|
* @since 4.0.0
|
|
9737
9886
|
*/
|
|
9738
9887
|
export function fromFormData<S extends Top>(schema: S): fromFormData<S> {
|
|
@@ -9860,6 +10009,7 @@ export interface fromURLSearchParams<S extends Top> extends decodeTo<S, URLSearc
|
|
|
9860
10009
|
* // Success({"a":1}) // Note: the value is a number
|
|
9861
10010
|
* ```
|
|
9862
10011
|
*
|
|
10012
|
+
* @category decoding
|
|
9863
10013
|
* @since 4.0.0
|
|
9864
10014
|
*/
|
|
9865
10015
|
export function fromURLSearchParams<S extends Top>(schema: S): fromURLSearchParams<S> {
|
|
@@ -9871,7 +10021,7 @@ export function fromURLSearchParams<S extends Top>(schema: S): fromURLSearchPara
|
|
|
9871
10021
|
* `Infinity`, and `-Infinity`.
|
|
9872
10022
|
*
|
|
9873
10023
|
* @category Number
|
|
9874
|
-
* @since
|
|
10024
|
+
* @since 3.10.0
|
|
9875
10025
|
*/
|
|
9876
10026
|
export interface Finite extends Number {
|
|
9877
10027
|
readonly "Rebuild": Finite
|
|
@@ -9881,7 +10031,7 @@ export interface Finite extends Number {
|
|
|
9881
10031
|
* A schema for finite numbers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
9882
10032
|
*
|
|
9883
10033
|
* @category Number
|
|
9884
|
-
* @since
|
|
10034
|
+
* @since 3.10.0
|
|
9885
10035
|
*/
|
|
9886
10036
|
export const Finite: Finite = Number.check(isFinite())
|
|
9887
10037
|
|
|
@@ -9890,7 +10040,7 @@ export const Finite: Finite = Number.check(isFinite())
|
|
|
9890
10040
|
* integer numbers.
|
|
9891
10041
|
*
|
|
9892
10042
|
* @category Number
|
|
9893
|
-
* @since
|
|
10043
|
+
* @since 3.10.0
|
|
9894
10044
|
*/
|
|
9895
10045
|
export interface Int extends Number {
|
|
9896
10046
|
readonly "Rebuild": Int
|
|
@@ -9900,7 +10050,7 @@ export interface Int extends Number {
|
|
|
9900
10050
|
* A schema for integers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
9901
10051
|
*
|
|
9902
10052
|
* @category Number
|
|
9903
|
-
* @since
|
|
10053
|
+
* @since 3.10.0
|
|
9904
10054
|
*/
|
|
9905
10055
|
export const Int: Int = Number.check(isInt())
|
|
9906
10056
|
|
|
@@ -9909,7 +10059,7 @@ export const Int: Int = Number.check(isInt())
|
|
|
9909
10059
|
* numbers using JavaScript number coercion.
|
|
9910
10060
|
*
|
|
9911
10061
|
* @category Number
|
|
9912
|
-
* @since
|
|
10062
|
+
* @since 3.10.0
|
|
9913
10063
|
*/
|
|
9914
10064
|
export interface NumberFromString extends decodeTo<Finite, String> {
|
|
9915
10065
|
readonly "Rebuild": NumberFromString
|
|
@@ -9928,7 +10078,7 @@ export interface NumberFromString extends decodeTo<Finite, String> {
|
|
|
9928
10078
|
* A number is encoded as a `string`.
|
|
9929
10079
|
*
|
|
9930
10080
|
* @category Number
|
|
9931
|
-
* @since
|
|
10081
|
+
* @since 3.10.0
|
|
9932
10082
|
*/
|
|
9933
10083
|
export const NumberFromString: NumberFromString = String.annotate({
|
|
9934
10084
|
expected: "a string that will be decoded as a number"
|
|
@@ -9994,7 +10144,7 @@ export const BigIntFromString: BigIntFromString = make<String>(AST.bigIntString)
|
|
|
9994
10144
|
* trailing whitespace.
|
|
9995
10145
|
*
|
|
9996
10146
|
* @category String
|
|
9997
|
-
* @since
|
|
10147
|
+
* @since 3.10.0
|
|
9998
10148
|
*/
|
|
9999
10149
|
export interface Trimmed extends String {
|
|
10000
10150
|
readonly "Rebuild": Trimmed
|
|
@@ -10004,7 +10154,7 @@ export interface Trimmed extends String {
|
|
|
10004
10154
|
* A schema for strings that contains no leading or trailing whitespaces.
|
|
10005
10155
|
*
|
|
10006
10156
|
* @category String
|
|
10007
|
-
* @since
|
|
10157
|
+
* @since 3.10.0
|
|
10008
10158
|
*/
|
|
10009
10159
|
export const Trimmed: Trimmed = String.check(isTrimmed())
|
|
10010
10160
|
|
|
@@ -10013,7 +10163,7 @@ export const Trimmed: Trimmed = String.check(isTrimmed())
|
|
|
10013
10163
|
* whitespace while decoding and encodes the trimmed string unchanged.
|
|
10014
10164
|
*
|
|
10015
10165
|
* @category String
|
|
10016
|
-
* @since
|
|
10166
|
+
* @since 3.10.0
|
|
10017
10167
|
*/
|
|
10018
10168
|
export interface Trim extends decodeTo<Trimmed, String> {
|
|
10019
10169
|
readonly "Rebuild": Trim
|
|
@@ -10029,7 +10179,7 @@ export interface Trim extends decodeTo<Trimmed, String> {
|
|
|
10029
10179
|
* - The trimmed string is encoded as is.
|
|
10030
10180
|
*
|
|
10031
10181
|
* @category String
|
|
10032
|
-
* @since
|
|
10182
|
+
* @since 3.10.0
|
|
10033
10183
|
*/
|
|
10034
10184
|
export const Trim: Trim = String.annotate({
|
|
10035
10185
|
expected: "a string that will be decoded as a trimmed string"
|
|
@@ -10040,7 +10190,7 @@ export const Trim: Trim = String.annotate({
|
|
|
10040
10190
|
* base64-encoded strings and UTF-8 strings.
|
|
10041
10191
|
*
|
|
10042
10192
|
* @category String
|
|
10043
|
-
* @since
|
|
10193
|
+
* @since 3.10.0
|
|
10044
10194
|
*/
|
|
10045
10195
|
export interface StringFromBase64 extends decodeTo<String, String> {
|
|
10046
10196
|
readonly "Rebuild": StringFromBase64
|
|
@@ -10056,7 +10206,7 @@ export interface StringFromBase64 extends decodeTo<String, String> {
|
|
|
10056
10206
|
* - A `string` is encoded as a base64-encoded string.
|
|
10057
10207
|
*
|
|
10058
10208
|
* @category String
|
|
10059
|
-
* @since
|
|
10209
|
+
* @since 3.10.0
|
|
10060
10210
|
*/
|
|
10061
10211
|
export const StringFromBase64: StringFromBase64 = String.annotate({
|
|
10062
10212
|
expected: "a base64 encoded string that will be decoded as a UTF-8 string"
|
|
@@ -10069,7 +10219,7 @@ export const StringFromBase64: StringFromBase64 = String.annotate({
|
|
|
10069
10219
|
* base64-encoded strings and UTF-8 strings.
|
|
10070
10220
|
*
|
|
10071
10221
|
* @category String
|
|
10072
|
-
* @since
|
|
10222
|
+
* @since 3.10.0
|
|
10073
10223
|
*/
|
|
10074
10224
|
export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
10075
10225
|
readonly "Rebuild": StringFromBase64Url
|
|
@@ -10085,7 +10235,7 @@ export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
|
10085
10235
|
* - A `string` is encoded as a base64 (URL) encoded string.
|
|
10086
10236
|
*
|
|
10087
10237
|
* @category String
|
|
10088
|
-
* @since
|
|
10238
|
+
* @since 3.10.0
|
|
10089
10239
|
*/
|
|
10090
10240
|
export const StringFromBase64Url: StringFromBase64Url = String.annotate({
|
|
10091
10241
|
expected: "a base64 (URL) encoded string that will be decoded as a UTF-8 string"
|
|
@@ -10098,7 +10248,7 @@ export const StringFromBase64Url: StringFromBase64Url = String.annotate({
|
|
|
10098
10248
|
* strings and UTF-8 strings.
|
|
10099
10249
|
*
|
|
10100
10250
|
* @category String
|
|
10101
|
-
* @since
|
|
10251
|
+
* @since 3.10.0
|
|
10102
10252
|
*/
|
|
10103
10253
|
export interface StringFromHex extends decodeTo<String, String> {
|
|
10104
10254
|
readonly "Rebuild": StringFromHex
|
|
@@ -10114,7 +10264,7 @@ export interface StringFromHex extends decodeTo<String, String> {
|
|
|
10114
10264
|
* - A `string` is encoded as a hex string.
|
|
10115
10265
|
*
|
|
10116
10266
|
* @category String
|
|
10117
|
-
* @since
|
|
10267
|
+
* @since 3.10.0
|
|
10118
10268
|
*/
|
|
10119
10269
|
export const StringFromHex: StringFromHex = String.annotate({
|
|
10120
10270
|
expected: "a hex encoded string that will be decoded as a UTF-8 string"
|
|
@@ -10127,7 +10277,7 @@ export const StringFromHex: StringFromHex = String.annotate({
|
|
|
10127
10277
|
* URI-component encoded strings and UTF-8 strings.
|
|
10128
10278
|
*
|
|
10129
10279
|
* @category String
|
|
10130
|
-
* @since
|
|
10280
|
+
* @since 3.12.0
|
|
10131
10281
|
*/
|
|
10132
10282
|
export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
10133
10283
|
readonly "Rebuild": StringFromUriComponent
|
|
@@ -10143,7 +10293,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
10143
10293
|
* Encoding:
|
|
10144
10294
|
* - A `string` is encoded as a URI component encoded string.
|
|
10145
10295
|
*
|
|
10146
|
-
* **Example**
|
|
10296
|
+
* **Example** (Decoding URI component strings)
|
|
10147
10297
|
*
|
|
10148
10298
|
* ```ts
|
|
10149
10299
|
* import { Schema } from "effect"
|
|
@@ -10162,7 +10312,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
10162
10312
|
* ```
|
|
10163
10313
|
*
|
|
10164
10314
|
* @category String
|
|
10165
|
-
* @since
|
|
10315
|
+
* @since 3.12.0
|
|
10166
10316
|
*/
|
|
10167
10317
|
export const StringFromUriComponent: StringFromUriComponent = String.annotate({
|
|
10168
10318
|
expected: "a URI component encoded string that will be decoded as a UTF-8 string"
|
|
@@ -10271,7 +10421,7 @@ export const Uint8Array: Uint8Array = instanceOf(globalThis.Uint8Array<ArrayBuff
|
|
|
10271
10421
|
* base64-encoded strings and `Uint8Array` values.
|
|
10272
10422
|
*
|
|
10273
10423
|
* @category Uint8Array
|
|
10274
|
-
* @since
|
|
10424
|
+
* @since 3.10.0
|
|
10275
10425
|
*/
|
|
10276
10426
|
export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
10277
10427
|
readonly "Rebuild": Uint8ArrayFromBase64
|
|
@@ -10288,7 +10438,7 @@ export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
|
10288
10438
|
* - A `Uint8Array` is encoded as a base64-encoded string.
|
|
10289
10439
|
*
|
|
10290
10440
|
* @category Uint8Array
|
|
10291
|
-
* @since
|
|
10441
|
+
* @since 3.10.0
|
|
10292
10442
|
*/
|
|
10293
10443
|
export const Uint8ArrayFromBase64: Uint8ArrayFromBase64 = Base64String.pipe(
|
|
10294
10444
|
decodeTo(Uint8Array, Transformation.uint8ArrayFromBase64String)
|
|
@@ -10299,7 +10449,7 @@ export const Uint8ArrayFromBase64: Uint8ArrayFromBase64 = Base64String.pipe(
|
|
|
10299
10449
|
* URL-safe base64-encoded strings and `Uint8Array` values.
|
|
10300
10450
|
*
|
|
10301
10451
|
* @category Uint8Array
|
|
10302
|
-
* @since
|
|
10452
|
+
* @since 3.10.0
|
|
10303
10453
|
*/
|
|
10304
10454
|
export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
10305
10455
|
readonly "Rebuild": Uint8ArrayFromBase64Url
|
|
@@ -10316,7 +10466,7 @@ export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
|
10316
10466
|
* - A `Uint8Array` is encoded as a base64 (URL) encoded string.
|
|
10317
10467
|
*
|
|
10318
10468
|
* @category Uint8Array
|
|
10319
|
-
* @since
|
|
10469
|
+
* @since 3.10.0
|
|
10320
10470
|
*/
|
|
10321
10471
|
export const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url = String.annotate({
|
|
10322
10472
|
expected: "a base64 (URL) encoded string that will be decoded as a Uint8Array"
|
|
@@ -10332,7 +10482,7 @@ export const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url = String.annotate(
|
|
|
10332
10482
|
* hex-encoded strings and `Uint8Array` values.
|
|
10333
10483
|
*
|
|
10334
10484
|
* @category Uint8Array
|
|
10335
|
-
* @since
|
|
10485
|
+
* @since 3.10.0
|
|
10336
10486
|
*/
|
|
10337
10487
|
export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
10338
10488
|
readonly "Rebuild": Uint8ArrayFromHex
|
|
@@ -10349,7 +10499,7 @@ export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
|
10349
10499
|
* - A `Uint8Array` is encoded as a hex encoded string.
|
|
10350
10500
|
*
|
|
10351
10501
|
* @category Uint8Array
|
|
10352
|
-
* @since
|
|
10502
|
+
* @since 3.10.0
|
|
10353
10503
|
*/
|
|
10354
10504
|
export const Uint8ArrayFromHex: Uint8ArrayFromHex = String.annotate({
|
|
10355
10505
|
expected: "a hex encoded string that will be decoded as a Uint8Array"
|
|
@@ -10365,7 +10515,7 @@ export const Uint8ArrayFromHex: Uint8ArrayFromHex = String.annotate({
|
|
|
10365
10515
|
* UTC ISO string JSON encoding.
|
|
10366
10516
|
*
|
|
10367
10517
|
* @category DateTime
|
|
10368
|
-
* @since
|
|
10518
|
+
* @since 3.10.0
|
|
10369
10519
|
*/
|
|
10370
10520
|
export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
10371
10521
|
readonly "Rebuild": DateTimeUtc
|
|
@@ -10379,7 +10529,7 @@ export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
|
10379
10529
|
* - encodes `DateTime.Utc` as a UTC ISO string
|
|
10380
10530
|
*
|
|
10381
10531
|
* @category DateTime
|
|
10382
|
-
* @since
|
|
10532
|
+
* @since 3.10.0
|
|
10383
10533
|
*/
|
|
10384
10534
|
export const DateTimeUtc: DateTimeUtc = declare(
|
|
10385
10535
|
(u) => DateTime.isDateTime(u) && DateTime.isUtc(u),
|
|
@@ -10410,7 +10560,7 @@ export const DateTimeUtc: DateTimeUtc = declare(
|
|
|
10410
10560
|
* JavaScript `Date` values to `DateTime.Utc`.
|
|
10411
10561
|
*
|
|
10412
10562
|
* @category DateTime
|
|
10413
|
-
* @since
|
|
10563
|
+
* @since 3.12.0
|
|
10414
10564
|
*/
|
|
10415
10565
|
export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
10416
10566
|
readonly "Rebuild": DateTimeUtcFromDate
|
|
@@ -10426,7 +10576,7 @@ export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
|
10426
10576
|
* - A `DateTime.Utc` is encoded as a `Date`
|
|
10427
10577
|
*
|
|
10428
10578
|
* @category DateTime
|
|
10429
|
-
* @since
|
|
10579
|
+
* @since 3.12.0
|
|
10430
10580
|
*/
|
|
10431
10581
|
export const DateTimeUtcFromDate: DateTimeUtcFromDate = DateValid.pipe(
|
|
10432
10582
|
decodeTo(DateTimeUtc, {
|
|
@@ -10505,7 +10655,7 @@ export const DateTimeUtcFromMillis: DateTimeUtcFromMillis = Number.pipe(
|
|
|
10505
10655
|
* `DateTime.TimeZone.Offset` values encoded as offset milliseconds.
|
|
10506
10656
|
*
|
|
10507
10657
|
* @category DateTime
|
|
10508
|
-
* @since
|
|
10658
|
+
* @since 3.10.0
|
|
10509
10659
|
*/
|
|
10510
10660
|
export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
10511
10661
|
readonly "Rebuild": TimeZoneOffset
|
|
@@ -10519,7 +10669,7 @@ export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
|
10519
10669
|
* - encodes `DateTime.TimeZone.Offset` as a number (offset in milliseconds)
|
|
10520
10670
|
*
|
|
10521
10671
|
* @category DateTime
|
|
10522
|
-
* @since
|
|
10672
|
+
* @since 3.10.0
|
|
10523
10673
|
*/
|
|
10524
10674
|
export const TimeZoneOffset: TimeZoneOffset = declare(
|
|
10525
10675
|
DateTime.isTimeZoneOffset,
|
|
@@ -10550,7 +10700,7 @@ export const TimeZoneOffset: TimeZoneOffset = declare(
|
|
|
10550
10700
|
* `DateTime.TimeZone.Named` values encoded as IANA time zone identifiers.
|
|
10551
10701
|
*
|
|
10552
10702
|
* @category DateTime
|
|
10553
|
-
* @since
|
|
10703
|
+
* @since 3.10.0
|
|
10554
10704
|
*/
|
|
10555
10705
|
export interface TimeZoneNamed extends declare<DateTime.TimeZone.Named> {
|
|
10556
10706
|
readonly "Rebuild": TimeZoneNamed
|
|
@@ -10566,7 +10716,7 @@ const TimeZoneNamedString = String.annotate({ expected: "an IANA time zone ident
|
|
|
10566
10716
|
* - encodes `DateTime.TimeZone.Named` as a string (IANA time zone identifier)
|
|
10567
10717
|
*
|
|
10568
10718
|
* @category DateTime
|
|
10569
|
-
* @since
|
|
10719
|
+
* @since 3.10.0
|
|
10570
10720
|
*/
|
|
10571
10721
|
export const TimeZoneNamed: TimeZoneNamed = declare(
|
|
10572
10722
|
DateTime.isTimeZoneNamed,
|
|
@@ -10628,7 +10778,7 @@ export const TimeZoneNamedFromString: TimeZoneNamedFromString = TimeZoneNamedStr
|
|
|
10628
10778
|
* encoded as either IANA identifiers or numeric offset strings.
|
|
10629
10779
|
*
|
|
10630
10780
|
* @category DateTime
|
|
10631
|
-
* @since
|
|
10781
|
+
* @since 3.10.0
|
|
10632
10782
|
*/
|
|
10633
10783
|
export interface TimeZone extends declare<DateTime.TimeZone> {
|
|
10634
10784
|
readonly "Rebuild": TimeZone
|
|
@@ -10647,7 +10797,7 @@ const TimeZoneString = String.annotate({
|
|
|
10647
10797
|
* `+03:00`)
|
|
10648
10798
|
*
|
|
10649
10799
|
* @category DateTime
|
|
10650
|
-
* @since
|
|
10800
|
+
* @since 3.10.0
|
|
10651
10801
|
*/
|
|
10652
10802
|
export const TimeZone: TimeZone = declare(
|
|
10653
10803
|
DateTime.isTimeZone,
|
|
@@ -10712,7 +10862,7 @@ export const TimeZoneFromString: TimeZoneFromString = TimeZoneString.pipe(
|
|
|
10712
10862
|
* with ISO offset or named-zone string JSON encoding.
|
|
10713
10863
|
*
|
|
10714
10864
|
* @category DateTime
|
|
10715
|
-
* @since
|
|
10865
|
+
* @since 3.10.0
|
|
10716
10866
|
*/
|
|
10717
10867
|
export interface DateTimeZoned extends declare<DateTime.Zoned> {
|
|
10718
10868
|
readonly "Rebuild": DateTimeZoned
|
|
@@ -10733,7 +10883,7 @@ const DateTimeZonedString = String.annotate({
|
|
|
10733
10883
|
* `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`
|
|
10734
10884
|
*
|
|
10735
10885
|
* @category DateTime
|
|
10736
|
-
* @since
|
|
10886
|
+
* @since 3.10.0
|
|
10737
10887
|
*/
|
|
10738
10888
|
export const DateTimeZoned: DateTimeZoned = declare(
|
|
10739
10889
|
(u) => DateTime.isDateTime(u) && DateTime.isZoned(u),
|
|
@@ -10807,7 +10957,8 @@ export const DateTimeZonedFromString: DateTimeZonedFromString = DateTimeZonedStr
|
|
|
10807
10957
|
* The interface exposes the schema's `fields`, an `identifier` string, and
|
|
10808
10958
|
* helpers such as `mapFields`, `annotate`, `check`, and `extend`.
|
|
10809
10959
|
*
|
|
10810
|
-
* @
|
|
10960
|
+
* @category models
|
|
10961
|
+
* @since 3.10.0
|
|
10811
10962
|
*/
|
|
10812
10963
|
export interface Class<Self, S extends Top & { readonly fields: Struct.Fields }, Inherited> extends
|
|
10813
10964
|
Bottom<
|
|
@@ -11063,8 +11214,8 @@ type MissingSelfGeneric<Usage extends string> =
|
|
|
11063
11214
|
* console.log(dog.breed) // "Labrador"
|
|
11064
11215
|
* ```
|
|
11065
11216
|
*
|
|
11066
|
-
* @category
|
|
11067
|
-
* @since
|
|
11217
|
+
* @category constructors
|
|
11218
|
+
* @since 3.10.0
|
|
11068
11219
|
*/
|
|
11069
11220
|
export const Class: {
|
|
11070
11221
|
/**
|
|
@@ -11108,8 +11259,8 @@ export const Class: {
|
|
|
11108
11259
|
* console.log(dog.breed) // "Labrador"
|
|
11109
11260
|
* ```
|
|
11110
11261
|
*
|
|
11111
|
-
* @category
|
|
11112
|
-
* @since
|
|
11262
|
+
* @category constructors
|
|
11263
|
+
* @since 3.10.0
|
|
11113
11264
|
*/
|
|
11114
11265
|
<Self = never, Brand = {}>(identifier: string): {
|
|
11115
11266
|
/**
|
|
@@ -11153,8 +11304,8 @@ export const Class: {
|
|
|
11153
11304
|
* console.log(dog.breed) // "Labrador"
|
|
11154
11305
|
* ```
|
|
11155
11306
|
*
|
|
11156
|
-
* @category
|
|
11157
|
-
* @since
|
|
11307
|
+
* @category constructors
|
|
11308
|
+
* @since 3.10.0
|
|
11158
11309
|
*/
|
|
11159
11310
|
<const Fields extends Struct.Fields>(
|
|
11160
11311
|
fields: Fields,
|
|
@@ -11201,8 +11352,8 @@ export const Class: {
|
|
|
11201
11352
|
* console.log(dog.breed) // "Labrador"
|
|
11202
11353
|
* ```
|
|
11203
11354
|
*
|
|
11204
|
-
* @category
|
|
11205
|
-
* @since
|
|
11355
|
+
* @category constructors
|
|
11356
|
+
* @since 3.10.0
|
|
11206
11357
|
*/
|
|
11207
11358
|
<S extends Struct<Struct.Fields>>(schema: S, annotations?: Annotations.Declaration<Self, readonly [S]>): [Self] extends [never] ? MissingSelfGeneric<"Schema.Class"> : Class<Self, S, Brand>
|
|
11208
11359
|
}
|
|
@@ -11247,8 +11398,8 @@ export const Class: {
|
|
|
11247
11398
|
* console.log(c.radius) // 5
|
|
11248
11399
|
* ```
|
|
11249
11400
|
*
|
|
11250
|
-
* @category
|
|
11251
|
-
* @since
|
|
11401
|
+
* @category constructors
|
|
11402
|
+
* @since 3.10.0
|
|
11252
11403
|
*/
|
|
11253
11404
|
export const TaggedClass: {
|
|
11254
11405
|
/**
|
|
@@ -11273,8 +11424,8 @@ export const TaggedClass: {
|
|
|
11273
11424
|
* console.log(c.radius) // 5
|
|
11274
11425
|
* ```
|
|
11275
11426
|
*
|
|
11276
|
-
* @category
|
|
11277
|
-
* @since
|
|
11427
|
+
* @category constructors
|
|
11428
|
+
* @since 3.10.0
|
|
11278
11429
|
*/
|
|
11279
11430
|
<Self = never, Brand = {}>(identifier?: string): {
|
|
11280
11431
|
/**
|
|
@@ -11299,8 +11450,8 @@ export const TaggedClass: {
|
|
|
11299
11450
|
* console.log(c.radius) // 5
|
|
11300
11451
|
* ```
|
|
11301
11452
|
*
|
|
11302
|
-
* @category
|
|
11303
|
-
* @since
|
|
11453
|
+
* @category constructors
|
|
11454
|
+
* @since 3.10.0
|
|
11304
11455
|
*/
|
|
11305
11456
|
<Tag extends string, const Fields extends Struct.Fields>(
|
|
11306
11457
|
tag: Tag,
|
|
@@ -11329,8 +11480,8 @@ export const TaggedClass: {
|
|
|
11329
11480
|
* console.log(c.radius) // 5
|
|
11330
11481
|
* ```
|
|
11331
11482
|
*
|
|
11332
|
-
* @category
|
|
11333
|
-
* @since
|
|
11483
|
+
* @category constructors
|
|
11484
|
+
* @since 3.10.0
|
|
11334
11485
|
*/
|
|
11335
11486
|
<Tag extends string, S extends Struct<Struct.Fields>>(
|
|
11336
11487
|
tag: Tag,
|
|
@@ -11380,7 +11531,7 @@ export const TaggedClass: {
|
|
|
11380
11531
|
* })
|
|
11381
11532
|
* ```
|
|
11382
11533
|
*
|
|
11383
|
-
* @category
|
|
11534
|
+
* @category constructors
|
|
11384
11535
|
* @since 4.0.0
|
|
11385
11536
|
*/
|
|
11386
11537
|
export const ErrorClass: {
|
|
@@ -11404,7 +11555,7 @@ export const ErrorClass: {
|
|
|
11404
11555
|
* })
|
|
11405
11556
|
* ```
|
|
11406
11557
|
*
|
|
11407
|
-
* @category
|
|
11558
|
+
* @category constructors
|
|
11408
11559
|
* @since 4.0.0
|
|
11409
11560
|
*/
|
|
11410
11561
|
<Self = never, Brand = {}>(identifier: string): {
|
|
@@ -11428,7 +11579,7 @@ export const ErrorClass: {
|
|
|
11428
11579
|
* })
|
|
11429
11580
|
* ```
|
|
11430
11581
|
*
|
|
11431
|
-
* @category
|
|
11582
|
+
* @category constructors
|
|
11432
11583
|
* @since 4.0.0
|
|
11433
11584
|
*/
|
|
11434
11585
|
<const Fields extends Struct.Fields>(
|
|
@@ -11456,7 +11607,7 @@ export const ErrorClass: {
|
|
|
11456
11607
|
* })
|
|
11457
11608
|
* ```
|
|
11458
11609
|
*
|
|
11459
|
-
* @category
|
|
11610
|
+
* @category constructors
|
|
11460
11611
|
* @since 4.0.0
|
|
11461
11612
|
*/
|
|
11462
11613
|
<S extends Struct<Struct.Fields>>(schema: S, annotations?: Annotations.Declaration<Self, readonly [S]>): [Self] extends [never] ? MissingSelfGeneric<"Schema.ErrorClass"> : Class<Self, S, Cause_.YieldableError & Brand>
|
|
@@ -11500,8 +11651,8 @@ export const ErrorClass: {
|
|
|
11500
11651
|
* })
|
|
11501
11652
|
* ```
|
|
11502
11653
|
*
|
|
11503
|
-
* @category
|
|
11504
|
-
* @since
|
|
11654
|
+
* @category constructors
|
|
11655
|
+
* @since 3.10.0
|
|
11505
11656
|
*/
|
|
11506
11657
|
export const TaggedErrorClass: {
|
|
11507
11658
|
/**
|
|
@@ -11523,8 +11674,8 @@ export const TaggedErrorClass: {
|
|
|
11523
11674
|
* })
|
|
11524
11675
|
* ```
|
|
11525
11676
|
*
|
|
11526
|
-
* @category
|
|
11527
|
-
* @since
|
|
11677
|
+
* @category constructors
|
|
11678
|
+
* @since 3.10.0
|
|
11528
11679
|
*/
|
|
11529
11680
|
<Self = never, Brand = {}>(identifier?: string): {
|
|
11530
11681
|
/**
|
|
@@ -11546,8 +11697,8 @@ export const TaggedErrorClass: {
|
|
|
11546
11697
|
* })
|
|
11547
11698
|
* ```
|
|
11548
11699
|
*
|
|
11549
|
-
* @category
|
|
11550
|
-
* @since
|
|
11700
|
+
* @category constructors
|
|
11701
|
+
* @since 3.10.0
|
|
11551
11702
|
*/
|
|
11552
11703
|
<Tag extends string, const Fields extends Struct.Fields>(
|
|
11553
11704
|
tag: Tag,
|
|
@@ -11574,8 +11725,8 @@ export const TaggedErrorClass: {
|
|
|
11574
11725
|
* })
|
|
11575
11726
|
* ```
|
|
11576
11727
|
*
|
|
11577
|
-
* @category
|
|
11578
|
-
* @since
|
|
11728
|
+
* @category constructors
|
|
11729
|
+
* @since 3.10.0
|
|
11579
11730
|
*/
|
|
11580
11731
|
<Tag extends string, S extends Struct<Struct.Fields>>(
|
|
11581
11732
|
tag: Tag,
|
|
@@ -11888,6 +12039,7 @@ export function toRepresentation(schema: Top): SchemaRepresentation.Document {
|
|
|
11888
12039
|
/**
|
|
11889
12040
|
* Options for {@link toJsonSchemaDocument}.
|
|
11890
12041
|
*
|
|
12042
|
+
* @category models
|
|
11891
12043
|
* @since 4.0.0
|
|
11892
12044
|
*/
|
|
11893
12045
|
export interface ToJsonSchemaOptions {
|
|
@@ -12642,7 +12794,7 @@ export function resolveAnnotationsKey<S extends Top>(schema: S): Annotations.Key
|
|
|
12642
12794
|
* Use {@link resolveAnnotations} to read the annotations attached to a schema at
|
|
12643
12795
|
* runtime.
|
|
12644
12796
|
*
|
|
12645
|
-
* @since
|
|
12797
|
+
* @since 3.10.0
|
|
12646
12798
|
*/
|
|
12647
12799
|
export declare namespace Annotations {
|
|
12648
12800
|
/**
|
|
@@ -12683,8 +12835,8 @@ export declare namespace Annotations {
|
|
|
12683
12835
|
* }
|
|
12684
12836
|
* ```
|
|
12685
12837
|
*
|
|
12686
|
-
* @category
|
|
12687
|
-
* @since
|
|
12838
|
+
* @category models
|
|
12839
|
+
* @since 3.10.0
|
|
12688
12840
|
*/
|
|
12689
12841
|
export interface Annotations {
|
|
12690
12842
|
readonly [x: string]: unknown
|
|
@@ -12694,6 +12846,7 @@ export declare namespace Annotations {
|
|
|
12694
12846
|
* Annotations shared by all schema nodes. These map to common JSON Schema /
|
|
12695
12847
|
* OpenAPI fields: `title`, `description`, `format`, etc.
|
|
12696
12848
|
*
|
|
12849
|
+
* @category models
|
|
12697
12850
|
* @since 4.0.0
|
|
12698
12851
|
*/
|
|
12699
12852
|
export interface Augment extends Annotations {
|
|
@@ -12720,6 +12873,7 @@ export declare namespace Annotations {
|
|
|
12720
12873
|
/**
|
|
12721
12874
|
* Extends {@link Augment} with type-parametric `default` and `examples` fields.
|
|
12722
12875
|
*
|
|
12876
|
+
* @category models
|
|
12723
12877
|
* @since 4.0.0
|
|
12724
12878
|
*/
|
|
12725
12879
|
export interface Documentation<T> extends Augment {
|
|
@@ -12732,7 +12886,7 @@ export declare namespace Annotations {
|
|
|
12732
12886
|
* with an optional `messageMissingKey` to override the error message when
|
|
12733
12887
|
* the property key is absent during decoding.
|
|
12734
12888
|
*
|
|
12735
|
-
* @category
|
|
12889
|
+
* @category models
|
|
12736
12890
|
* @since 4.0.0
|
|
12737
12891
|
*/
|
|
12738
12892
|
export interface Key<T> extends Documentation<T> {
|
|
@@ -12748,7 +12902,7 @@ export declare namespace Annotations {
|
|
|
12748
12902
|
* arbitrary generation hooks. {@link Declaration} and other annotation
|
|
12749
12903
|
* interfaces build on top of this.
|
|
12750
12904
|
*
|
|
12751
|
-
* @category
|
|
12905
|
+
* @category models
|
|
12752
12906
|
* @since 4.0.0
|
|
12753
12907
|
*/
|
|
12754
12908
|
export interface Bottom<T, TypeParameters extends ReadonlyArray<Top>> extends Documentation<T> {
|
|
@@ -12804,7 +12958,8 @@ export declare namespace Annotations {
|
|
|
12804
12958
|
* Maps declaration type-parameter schemas to codecs for their decoded `Type`
|
|
12805
12959
|
* values.
|
|
12806
12960
|
*
|
|
12807
|
-
* @
|
|
12961
|
+
* @category utility types
|
|
12962
|
+
* @since 3.10.0
|
|
12808
12963
|
*/
|
|
12809
12964
|
export type Type<TypeParameters extends ReadonlyArray<Top>> = {
|
|
12810
12965
|
readonly [K in keyof TypeParameters]: Codec<TypeParameters[K]["Type"]>
|
|
@@ -12812,7 +12967,8 @@ export declare namespace Annotations {
|
|
|
12812
12967
|
/**
|
|
12813
12968
|
* Maps declaration type-parameter schemas to codecs for their `Encoded` values.
|
|
12814
12969
|
*
|
|
12815
|
-
* @
|
|
12970
|
+
* @category utility types
|
|
12971
|
+
* @since 3.10.0
|
|
12816
12972
|
*/
|
|
12817
12973
|
export type Encoded<TypeParameters extends ReadonlyArray<Top>> = {
|
|
12818
12974
|
readonly [K in keyof TypeParameters]: Codec<TypeParameters[K]["Encoded"]>
|
|
@@ -12826,7 +12982,7 @@ export declare namespace Annotations {
|
|
|
12826
12982
|
* derived capabilities (JSON encoding, property testing, etc.) can be
|
|
12827
12983
|
* provided for the custom type.
|
|
12828
12984
|
*
|
|
12829
|
-
* @category
|
|
12985
|
+
* @category models
|
|
12830
12986
|
* @since 4.0.0
|
|
12831
12987
|
*/
|
|
12832
12988
|
export interface Declaration<T, TypeParameters extends ReadonlyArray<Top> = readonly []>
|
|
@@ -12866,8 +13022,8 @@ export declare namespace Annotations {
|
|
|
12866
13022
|
* {@link Augment} with an optional error message, identifier, and metadata.
|
|
12867
13023
|
* Filters are intentionally non-parametric to keep them covariant.
|
|
12868
13024
|
*
|
|
12869
|
-
* @category
|
|
12870
|
-
* @since
|
|
13025
|
+
* @category models
|
|
13026
|
+
* @since 3.10.0
|
|
12871
13027
|
*/
|
|
12872
13028
|
export interface Filter extends Augment {
|
|
12873
13029
|
/**
|
|
@@ -12914,6 +13070,7 @@ export declare namespace Annotations {
|
|
|
12914
13070
|
* fast-check string constraints plus optional regular-expression pattern strings
|
|
12915
13071
|
* used when deriving string arbitraries from schema checks.
|
|
12916
13072
|
*
|
|
13073
|
+
* @category models
|
|
12917
13074
|
* @since 4.0.0
|
|
12918
13075
|
*/
|
|
12919
13076
|
export interface StringConstraints extends FastCheck.StringSharedConstraints {
|
|
@@ -12924,6 +13081,7 @@ export declare namespace Annotations {
|
|
|
12924
13081
|
* fast-check floating-point constraints plus `isInteger`, which switches
|
|
12925
13082
|
* derived number arbitraries to integer generation.
|
|
12926
13083
|
*
|
|
13084
|
+
* @category models
|
|
12927
13085
|
* @since 4.0.0
|
|
12928
13086
|
*/
|
|
12929
13087
|
export interface NumberConstraints extends FastCheck.FloatConstraints {
|
|
@@ -12934,6 +13092,7 @@ export declare namespace Annotations {
|
|
|
12934
13092
|
* fast-check bigint constraints used when deriving arbitraries for bigint
|
|
12935
13093
|
* schemas.
|
|
12936
13094
|
*
|
|
13095
|
+
* @category models
|
|
12937
13096
|
* @since 4.0.0
|
|
12938
13097
|
*/
|
|
12939
13098
|
export interface BigIntConstraints extends FastCheck.BigIntConstraints {}
|
|
@@ -12942,6 +13101,7 @@ export declare namespace Annotations {
|
|
|
12942
13101
|
* fast-check array constraints plus an optional comparator used when deriving
|
|
12943
13102
|
* unique-array arbitraries.
|
|
12944
13103
|
*
|
|
13104
|
+
* @category models
|
|
12945
13105
|
* @since 4.0.0
|
|
12946
13106
|
*/
|
|
12947
13107
|
export interface ArrayConstraints extends FastCheck.ArrayConstraints {
|
|
@@ -12952,6 +13112,7 @@ export declare namespace Annotations {
|
|
|
12952
13112
|
* fast-check date constraints used when deriving arbitraries for `Date` and
|
|
12953
13113
|
* DateTime schemas.
|
|
12954
13114
|
*
|
|
13115
|
+
* @category models
|
|
12955
13116
|
* @since 4.0.0
|
|
12956
13117
|
*/
|
|
12957
13118
|
export interface DateConstraints extends FastCheck.DateConstraints {}
|
|
@@ -12960,6 +13121,7 @@ export declare namespace Annotations {
|
|
|
12960
13121
|
* Grouped arbitrary-generation constraints accumulated from schema checks and
|
|
12961
13122
|
* passed to `toArbitrary` derivation.
|
|
12962
13123
|
*
|
|
13124
|
+
* @category models
|
|
12963
13125
|
* @since 4.0.0
|
|
12964
13126
|
*/
|
|
12965
13127
|
export interface Constraint {
|
|
@@ -12975,7 +13137,8 @@ export declare namespace Annotations {
|
|
|
12975
13137
|
* constraints and an `isSuspend` flag used to limit recursion for suspended
|
|
12976
13138
|
* schemas.
|
|
12977
13139
|
*
|
|
12978
|
-
* @
|
|
13140
|
+
* @category models
|
|
13141
|
+
* @since 3.10.0
|
|
12979
13142
|
*/
|
|
12980
13143
|
export interface Context {
|
|
12981
13144
|
/**
|
|
@@ -12993,6 +13156,7 @@ export declare namespace Annotations {
|
|
|
12993
13156
|
* Given arbitraries for any type parameters, returns a function that receives the
|
|
12994
13157
|
* fast-check module and derivation context and produces an arbitrary for `T`.
|
|
12995
13158
|
*
|
|
13159
|
+
* @category models
|
|
12996
13160
|
* @since 4.0.0
|
|
12997
13161
|
*/
|
|
12998
13162
|
export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
|
|
@@ -13015,6 +13179,7 @@ export declare namespace Annotations {
|
|
|
13015
13179
|
*
|
|
13016
13180
|
* Given formatters for any type parameters, returns a formatter for `T`.
|
|
13017
13181
|
*
|
|
13182
|
+
* @category models
|
|
13018
13183
|
* @since 4.0.0
|
|
13019
13184
|
*/
|
|
13020
13185
|
export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
|
|
@@ -13037,6 +13202,7 @@ export declare namespace Annotations {
|
|
|
13037
13202
|
*
|
|
13038
13203
|
* Given equivalences for any type parameters, returns an `Equivalence` for `T`.
|
|
13039
13204
|
*
|
|
13205
|
+
* @category models
|
|
13040
13206
|
* @since 4.0.0
|
|
13041
13207
|
*/
|
|
13042
13208
|
export interface Declaration<T, TypeParameters extends ReadonlyArray<Top>> {
|
|
@@ -13052,7 +13218,7 @@ export declare namespace Annotations {
|
|
|
13052
13218
|
*
|
|
13053
13219
|
* The optional `message` field overrides the default issue message.
|
|
13054
13220
|
*
|
|
13055
|
-
* @category
|
|
13221
|
+
* @category models
|
|
13056
13222
|
* @since 4.0.0
|
|
13057
13223
|
*/
|
|
13058
13224
|
export interface Issue extends Annotations {
|
|
@@ -13065,6 +13231,7 @@ export declare namespace Annotations {
|
|
|
13065
13231
|
* Do not augment this interface with custom metadata; extend `MetaDefinitions`
|
|
13066
13232
|
* instead.
|
|
13067
13233
|
*
|
|
13234
|
+
* @category models
|
|
13068
13235
|
* @since 4.0.0
|
|
13069
13236
|
*/
|
|
13070
13237
|
export interface BuiltInMetaDefinitions {
|
|
@@ -13276,6 +13443,7 @@ export declare namespace Annotations {
|
|
|
13276
13443
|
/**
|
|
13277
13444
|
* Union of all metadata payloads defined by `BuiltInMetaDefinitions`.
|
|
13278
13445
|
*
|
|
13446
|
+
* @category utility types
|
|
13279
13447
|
* @since 4.0.0
|
|
13280
13448
|
*/
|
|
13281
13449
|
export type BuiltInMeta = BuiltInMetaDefinitions[keyof BuiltInMetaDefinitions]
|
|
@@ -13286,6 +13454,7 @@ export declare namespace Annotations {
|
|
|
13286
13454
|
* Extend this interface to add custom values accepted by annotation `meta`
|
|
13287
13455
|
* fields.
|
|
13288
13456
|
*
|
|
13457
|
+
* @category models
|
|
13289
13458
|
* @since 4.0.0
|
|
13290
13459
|
*/
|
|
13291
13460
|
export interface MetaDefinitions extends BuiltInMetaDefinitions {}
|
|
@@ -13293,6 +13462,7 @@ export declare namespace Annotations {
|
|
|
13293
13462
|
/**
|
|
13294
13463
|
* Union of built-in and user-augmented schema filter metadata payloads.
|
|
13295
13464
|
*
|
|
13465
|
+
* @category utility types
|
|
13296
13466
|
* @since 4.0.0
|
|
13297
13467
|
*/
|
|
13298
13468
|
export type Meta = MetaDefinitions[keyof MetaDefinitions]
|