effect 4.0.0 → 4.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ai-docs/package.json +2 -2
- package/ai-docs/tsconfig.json +2 -1
- package/dist/Array.d.ts +339 -0
- package/dist/Array.d.ts.map +1 -1
- package/dist/Array.js +143 -3
- package/dist/Array.js.map +1 -1
- package/dist/BigDecimal.d.ts +88 -0
- package/dist/BigDecimal.d.ts.map +1 -1
- package/dist/BigDecimal.js +44 -0
- package/dist/BigDecimal.js.map +1 -1
- package/dist/BigInt.d.ts +68 -0
- package/dist/BigInt.d.ts.map +1 -1
- package/dist/BigInt.js +36 -0
- package/dist/BigInt.js.map +1 -1
- package/dist/Boolean.d.ts +34 -0
- package/dist/Boolean.d.ts.map +1 -1
- package/dist/Boolean.js +18 -0
- package/dist/Boolean.js.map +1 -1
- package/dist/Brand.d.ts +9 -0
- package/dist/Brand.d.ts.map +1 -1
- package/dist/Brand.js +6 -0
- package/dist/Brand.js.map +1 -1
- package/dist/ByteSize.d.ts +86 -0
- package/dist/ByteSize.d.ts.map +1 -1
- package/dist/ByteSize.js +51 -0
- package/dist/ByteSize.js.map +1 -1
- package/dist/Cache.d.ts +38 -1
- package/dist/Cache.d.ts.map +1 -1
- package/dist/Cache.js +47 -23
- package/dist/Cache.js.map +1 -1
- package/dist/Cause.d.ts +82 -0
- package/dist/Cause.d.ts.map +1 -1
- package/dist/Cause.js +61 -1
- package/dist/Cause.js.map +1 -1
- package/dist/Channel.d.ts +327 -4
- package/dist/Channel.d.ts.map +1 -1
- package/dist/Channel.js +168 -8
- package/dist/Channel.js.map +1 -1
- package/dist/ChannelSchema.d.ts +11 -0
- package/dist/ChannelSchema.d.ts.map +1 -1
- package/dist/ChannelSchema.js +6 -0
- package/dist/ChannelSchema.js.map +1 -1
- package/dist/Chunk.d.ts +192 -0
- package/dist/Chunk.d.ts.map +1 -1
- package/dist/Chunk.js +78 -0
- package/dist/Chunk.js.map +1 -1
- package/dist/Clock.d.ts +7 -0
- package/dist/Clock.d.ts.map +1 -1
- package/dist/Clock.js +5 -0
- package/dist/Clock.js.map +1 -1
- package/dist/Combiner.d.ts +10 -0
- 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 +52 -12
- package/dist/Config.d.ts.map +1 -1
- package/dist/Config.js +55 -5
- package/dist/Config.js.map +1 -1
- package/dist/ConfigProvider.d.ts +28 -0
- package/dist/ConfigProvider.d.ts.map +1 -1
- package/dist/ConfigProvider.js +19 -0
- package/dist/ConfigProvider.js.map +1 -1
- package/dist/Console.d.ts +22 -0
- package/dist/Console.d.ts.map +1 -1
- package/dist/Console.js +20 -0
- package/dist/Console.js.map +1 -1
- package/dist/Context.d.ts +50 -0
- package/dist/Context.d.ts.map +1 -1
- package/dist/Context.js +21 -0
- package/dist/Context.js.map +1 -1
- package/dist/Cron.d.ts +16 -0
- package/dist/Cron.d.ts.map +1 -1
- package/dist/Cron.js +26 -1
- package/dist/Cron.js.map +1 -1
- package/dist/Crypto.d.ts +5 -0
- package/dist/Crypto.d.ts.map +1 -1
- package/dist/Crypto.js +3 -0
- package/dist/Crypto.js.map +1 -1
- package/dist/Data.d.ts +13 -0
- package/dist/Data.d.ts.map +1 -1
- package/dist/Data.js +5 -0
- package/dist/Data.js.map +1 -1
- package/dist/DateTime.d.ts +171 -0
- package/dist/DateTime.d.ts.map +1 -1
- package/dist/DateTime.js +89 -0
- package/dist/DateTime.js.map +1 -1
- package/dist/Deferred.d.ts +51 -0
- package/dist/Deferred.d.ts.map +1 -1
- package/dist/Deferred.js +22 -0
- package/dist/Deferred.js.map +1 -1
- package/dist/Differ.d.ts +2 -0
- package/dist/Differ.d.ts.map +1 -1
- package/dist/Differ.js +1 -0
- package/dist/Duration.d.ts +90 -0
- package/dist/Duration.d.ts.map +1 -1
- package/dist/Duration.js +53 -0
- package/dist/Duration.js.map +1 -1
- package/dist/Effect.d.ts +677 -22
- package/dist/Effect.d.ts.map +1 -1
- package/dist/Effect.js +251 -10
- package/dist/Effect.js.map +1 -1
- package/dist/Effectable.d.ts +4 -0
- package/dist/Effectable.d.ts.map +1 -1
- package/dist/Effectable.js +3 -0
- package/dist/Effectable.js.map +1 -1
- package/dist/Equal.d.ts +8 -0
- package/dist/Equal.d.ts.map +1 -1
- package/dist/Equal.js +9 -1
- package/dist/Equal.js.map +1 -1
- package/dist/Equivalence.d.ts +21 -0
- package/dist/Equivalence.d.ts.map +1 -1
- package/dist/Equivalence.js +16 -0
- package/dist/Equivalence.js.map +1 -1
- package/dist/ErrorReporter.d.ts +36 -0
- package/dist/ErrorReporter.d.ts.map +1 -1
- package/dist/ErrorReporter.js +11 -0
- package/dist/ErrorReporter.js.map +1 -1
- package/dist/ExecutionPlan.d.ts +49 -8
- package/dist/ExecutionPlan.d.ts.map +1 -1
- package/dist/ExecutionPlan.js +7 -0
- package/dist/ExecutionPlan.js.map +1 -1
- package/dist/Exit.d.ts +40 -0
- package/dist/Exit.d.ts.map +1 -1
- package/dist/Exit.js +27 -0
- package/dist/Exit.js.map +1 -1
- package/dist/Fiber.d.ts +20 -0
- package/dist/Fiber.d.ts.map +1 -1
- package/dist/Fiber.js +11 -0
- package/dist/Fiber.js.map +1 -1
- package/dist/FiberHandle.d.ts +21 -0
- package/dist/FiberHandle.d.ts.map +1 -1
- package/dist/FiberHandle.js +21 -4
- package/dist/FiberHandle.js.map +1 -1
- package/dist/FiberMap.d.ts +35 -0
- package/dist/FiberMap.d.ts.map +1 -1
- package/dist/FiberMap.js +19 -0
- package/dist/FiberMap.js.map +1 -1
- package/dist/FiberSet.d.ts +20 -0
- package/dist/FiberSet.d.ts.map +1 -1
- package/dist/FiberSet.js +14 -0
- package/dist/FiberSet.js.map +1 -1
- package/dist/FileSystem.d.ts +15 -0
- package/dist/FileSystem.d.ts.map +1 -1
- package/dist/FileSystem.js +8 -0
- package/dist/FileSystem.js.map +1 -1
- package/dist/Filter.d.ts +55 -0
- package/dist/Filter.d.ts.map +1 -1
- package/dist/Filter.js +28 -0
- package/dist/Filter.js.map +1 -1
- package/dist/Formatter.d.ts +3 -0
- package/dist/Formatter.d.ts.map +1 -1
- package/dist/Formatter.js +39 -1
- package/dist/Formatter.js.map +1 -1
- package/dist/Function.d.ts +30 -0
- package/dist/Function.d.ts.map +1 -1
- package/dist/Function.js +20 -0
- package/dist/Function.js.map +1 -1
- package/dist/Graph.d.ts +247 -12
- package/dist/Graph.d.ts.map +1 -1
- package/dist/Graph.js +149 -28
- package/dist/Graph.js.map +1 -1
- package/dist/HKT.d.ts +5 -0
- package/dist/HKT.d.ts.map +1 -1
- package/dist/Hash.d.ts +14 -0
- package/dist/Hash.d.ts.map +1 -1
- package/dist/Hash.js +12 -0
- package/dist/Hash.js.map +1 -1
- package/dist/HashMap.d.ts +91 -0
- package/dist/HashMap.d.ts.map +1 -1
- package/dist/HashMap.js +39 -0
- package/dist/HashMap.js.map +1 -1
- package/dist/HashRing.d.ts +17 -0
- package/dist/HashRing.d.ts.map +1 -1
- package/dist/HashRing.js +22 -5
- package/dist/HashRing.js.map +1 -1
- package/dist/HashSet.d.ts +49 -0
- package/dist/HashSet.d.ts.map +1 -1
- package/dist/HashSet.js +19 -0
- package/dist/HashSet.js.map +1 -1
- package/dist/Inspectable.d.ts +7 -0
- package/dist/Inspectable.d.ts.map +1 -1
- package/dist/Inspectable.js +6 -0
- package/dist/Inspectable.js.map +1 -1
- package/dist/Iterable.d.ts +127 -0
- package/dist/Iterable.d.ts.map +1 -1
- package/dist/Iterable.js +51 -0
- package/dist/Iterable.js.map +1 -1
- package/dist/JsonPatch.d.ts +4 -0
- package/dist/JsonPatch.d.ts.map +1 -1
- package/dist/JsonPatch.js +3 -0
- package/dist/JsonPatch.js.map +1 -1
- package/dist/JsonPointer.d.ts +5 -0
- package/dist/JsonPointer.d.ts.map +1 -1
- package/dist/JsonPointer.js +5 -0
- 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 +11 -0
- package/dist/JsonSchema.js.map +1 -1
- package/dist/Latch.d.ts +14 -0
- package/dist/Latch.d.ts.map +1 -1
- package/dist/Latch.js +10 -0
- package/dist/Latch.js.map +1 -1
- package/dist/Layer.d.ts +100 -0
- package/dist/Layer.d.ts.map +1 -1
- package/dist/Layer.js +45 -1
- package/dist/Layer.js.map +1 -1
- package/dist/LayerMap.d.ts +7 -0
- package/dist/LayerMap.d.ts.map +1 -1
- package/dist/LayerMap.js +4 -0
- package/dist/LayerMap.js.map +1 -1
- package/dist/LayerRef.d.ts +5 -0
- package/dist/LayerRef.d.ts.map +1 -1
- package/dist/LayerRef.js +3 -0
- package/dist/LayerRef.js.map +1 -1
- package/dist/LogLevel.d.ts +20 -0
- package/dist/LogLevel.d.ts.map +1 -1
- package/dist/LogLevel.js +9 -0
- package/dist/LogLevel.js.map +1 -1
- package/dist/Logger.d.ts +25 -0
- package/dist/Logger.d.ts.map +1 -1
- package/dist/Logger.js +30 -4
- package/dist/Logger.js.map +1 -1
- package/dist/ManagedRuntime.d.ts +5 -0
- package/dist/ManagedRuntime.d.ts.map +1 -1
- package/dist/ManagedRuntime.js +9 -1
- package/dist/ManagedRuntime.js.map +1 -1
- package/dist/Match.d.ts +51 -0
- package/dist/Match.d.ts.map +1 -1
- package/dist/Match.js +39 -0
- package/dist/Match.js.map +1 -1
- package/dist/Metric.d.ts +59 -0
- package/dist/Metric.d.ts.map +1 -1
- package/dist/Metric.js +31 -0
- package/dist/Metric.js.map +1 -1
- package/dist/MutableHashMap.d.ts +32 -0
- package/dist/MutableHashMap.d.ts.map +1 -1
- package/dist/MutableHashMap.js +16 -0
- package/dist/MutableHashMap.js.map +1 -1
- package/dist/MutableHashSet.d.ts +16 -0
- package/dist/MutableHashSet.d.ts.map +1 -1
- package/dist/MutableHashSet.js +10 -0
- package/dist/MutableHashSet.js.map +1 -1
- package/dist/MutableList.d.ts +20 -0
- package/dist/MutableList.d.ts.map +1 -1
- package/dist/MutableList.js +18 -0
- package/dist/MutableList.js.map +1 -1
- package/dist/MutableRef.d.ts +31 -0
- package/dist/MutableRef.d.ts.map +1 -1
- package/dist/MutableRef.js +17 -0
- package/dist/MutableRef.js.map +1 -1
- package/dist/Newtype.d.ts +9 -0
- package/dist/Newtype.d.ts.map +1 -1
- package/dist/Newtype.js +6 -0
- package/dist/Newtype.js.map +1 -1
- package/dist/NonEmptyIterable.d.ts +4 -0
- package/dist/NonEmptyIterable.d.ts.map +1 -1
- package/dist/NonEmptyIterable.js +2 -0
- package/dist/NonEmptyIterable.js.map +1 -1
- package/dist/Number.d.ts +61 -0
- package/dist/Number.d.ts.map +1 -1
- package/dist/Number.js +31 -0
- package/dist/Number.js.map +1 -1
- package/dist/Optic.d.ts +41 -0
- package/dist/Optic.d.ts.map +1 -1
- package/dist/Optic.js +20 -0
- package/dist/Optic.js.map +1 -1
- package/dist/Option.d.ts +134 -0
- package/dist/Option.d.ts.map +1 -1
- package/dist/Option.js +61 -0
- package/dist/Option.js.map +1 -1
- package/dist/Order.d.ts +29 -0
- package/dist/Order.d.ts.map +1 -1
- package/dist/Order.js +24 -0
- package/dist/Order.js.map +1 -1
- package/dist/Ordering.d.ts +7 -0
- package/dist/Ordering.d.ts.map +1 -1
- package/dist/Ordering.js +3 -0
- package/dist/Ordering.js.map +1 -1
- package/dist/PartitionedSemaphore.d.ts +24 -0
- package/dist/PartitionedSemaphore.d.ts.map +1 -1
- package/dist/PartitionedSemaphore.js +47 -21
- package/dist/PartitionedSemaphore.js.map +1 -1
- package/dist/Path.d.ts +6 -0
- package/dist/Path.d.ts.map +1 -1
- package/dist/Path.js +4 -0
- package/dist/Path.js.map +1 -1
- package/dist/Pipeable.d.ts +7 -0
- package/dist/Pipeable.d.ts.map +1 -1
- package/dist/Pipeable.js +5 -0
- package/dist/Pipeable.js.map +1 -1
- package/dist/PlatformError.d.ts +8 -0
- package/dist/PlatformError.d.ts.map +1 -1
- package/dist/PlatformError.js +7 -0
- package/dist/PlatformError.js.map +1 -1
- package/dist/Pool.d.ts +28 -5
- package/dist/Pool.d.ts.map +1 -1
- package/dist/Pool.js +42 -42
- package/dist/Pool.js.map +1 -1
- package/dist/Predicate.d.ts +84 -0
- package/dist/Predicate.d.ts.map +1 -1
- package/dist/Predicate.js +48 -0
- package/dist/Predicate.js.map +1 -1
- package/dist/PrimaryKey.d.ts +5 -0
- package/dist/PrimaryKey.d.ts.map +1 -1
- package/dist/PrimaryKey.js +4 -0
- package/dist/PrimaryKey.js.map +1 -1
- package/dist/PubSub.d.ts +67 -5
- package/dist/PubSub.d.ts.map +1 -1
- package/dist/PubSub.js +60 -8
- package/dist/PubSub.js.map +1 -1
- package/dist/Pull.d.ts +20 -0
- package/dist/Pull.d.ts.map +1 -1
- package/dist/Pull.js +10 -0
- package/dist/Pull.js.map +1 -1
- package/dist/Queue.d.ts +60 -0
- package/dist/Queue.d.ts.map +1 -1
- package/dist/Queue.js +58 -8
- package/dist/Queue.js.map +1 -1
- package/dist/Random.d.ts +13 -0
- package/dist/Random.d.ts.map +1 -1
- package/dist/Random.js +9 -0
- package/dist/Random.js.map +1 -1
- package/dist/RcMap.d.ts +23 -0
- package/dist/RcMap.d.ts.map +1 -1
- package/dist/RcMap.js +24 -1
- package/dist/RcMap.js.map +1 -1
- package/dist/RcRef.d.ts +6 -0
- package/dist/RcRef.d.ts.map +1 -1
- package/dist/RcRef.js +3 -0
- package/dist/RcRef.js.map +1 -1
- package/dist/Record.d.ts +100 -0
- package/dist/Record.d.ts.map +1 -1
- package/dist/Record.js +43 -0
- package/dist/Record.js.map +1 -1
- package/dist/Redactable.d.ts +6 -0
- package/dist/Redactable.d.ts.map +1 -1
- package/dist/Redactable.js +4 -0
- package/dist/Redactable.js.map +1 -1
- package/dist/Redacted.d.ts +8 -0
- package/dist/Redacted.d.ts.map +1 -1
- package/dist/Redacted.js +6 -0
- package/dist/Redacted.js.map +1 -1
- package/dist/Reducer.d.ts +4 -0
- package/dist/Reducer.d.ts.map +1 -1
- package/dist/Reducer.js +3 -0
- package/dist/Reducer.js.map +1 -1
- package/dist/Ref.d.ts +20 -0
- package/dist/Ref.d.ts.map +1 -1
- package/dist/Ref.js +16 -0
- package/dist/Ref.js.map +1 -1
- package/dist/References.d.ts +21 -0
- package/dist/References.d.ts.map +1 -1
- package/dist/References.js +19 -0
- package/dist/References.js.map +1 -1
- package/dist/RegExp.d.ts +3 -0
- package/dist/RegExp.d.ts.map +1 -1
- package/dist/RegExp.js +4 -0
- package/dist/RegExp.js.map +1 -1
- package/dist/Request.d.ts +32 -0
- package/dist/Request.d.ts.map +1 -1
- package/dist/Request.js +12 -0
- package/dist/Request.js.map +1 -1
- package/dist/RequestResolver.d.ts +42 -0
- package/dist/RequestResolver.d.ts.map +1 -1
- package/dist/RequestResolver.js +27 -6
- package/dist/RequestResolver.js.map +1 -1
- package/dist/Resource.d.ts +6 -0
- package/dist/Resource.d.ts.map +1 -1
- package/dist/Resource.js +6 -0
- package/dist/Resource.js.map +1 -1
- package/dist/Result.d.ts +91 -0
- package/dist/Result.d.ts.map +1 -1
- package/dist/Result.js +41 -0
- package/dist/Result.js.map +1 -1
- package/dist/Runtime.d.ts +9 -0
- package/dist/Runtime.d.ts.map +1 -1
- package/dist/Runtime.js +7 -0
- package/dist/Runtime.js.map +1 -1
- package/dist/Schedule.d.ts +57 -0
- package/dist/Schedule.d.ts.map +1 -1
- package/dist/Schedule.js +32 -0
- package/dist/Schedule.js.map +1 -1
- package/dist/Scheduler.d.ts +7 -0
- package/dist/Scheduler.d.ts.map +1 -1
- package/dist/Scheduler.js +5 -0
- package/dist/Scheduler.js.map +1 -1
- package/dist/Schema.d.ts +496 -1
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +280 -1
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +107 -0
- package/dist/SchemaAST.d.ts.map +1 -1
- package/dist/SchemaAST.js +81 -1
- package/dist/SchemaAST.js.map +1 -1
- package/dist/SchemaGetter.d.ts +69 -2
- package/dist/SchemaGetter.d.ts.map +1 -1
- package/dist/SchemaGetter.js +63 -4
- package/dist/SchemaGetter.js.map +1 -1
- package/dist/SchemaIssue.d.ts +33 -0
- package/dist/SchemaIssue.d.ts.map +1 -1
- package/dist/SchemaIssue.js +18 -0
- package/dist/SchemaIssue.js.map +1 -1
- package/dist/SchemaParser.d.ts +25 -0
- package/dist/SchemaParser.d.ts.map +1 -1
- package/dist/SchemaParser.js +26 -0
- package/dist/SchemaParser.js.map +1 -1
- package/dist/SchemaRepresentation.d.ts +147 -0
- package/dist/SchemaRepresentation.d.ts.map +1 -1
- package/dist/SchemaRepresentation.js +99 -0
- package/dist/SchemaRepresentation.js.map +1 -1
- package/dist/SchemaTransformation.d.ts +53 -0
- package/dist/SchemaTransformation.d.ts.map +1 -1
- package/dist/SchemaTransformation.js +46 -0
- package/dist/SchemaTransformation.js.map +1 -1
- package/dist/Scope.d.ts +19 -0
- package/dist/Scope.d.ts.map +1 -1
- package/dist/Scope.js +12 -0
- package/dist/Scope.js.map +1 -1
- package/dist/ScopedCache.d.ts +34 -0
- package/dist/ScopedCache.d.ts.map +1 -1
- package/dist/ScopedCache.js +50 -19
- package/dist/ScopedCache.js.map +1 -1
- package/dist/ScopedRef.d.ts +9 -0
- package/dist/ScopedRef.d.ts.map +1 -1
- package/dist/ScopedRef.js +6 -0
- package/dist/ScopedRef.js.map +1 -1
- package/dist/Semaphore.d.ts +26 -0
- package/dist/Semaphore.d.ts.map +1 -1
- package/dist/Semaphore.js +10 -0
- package/dist/Semaphore.js.map +1 -1
- package/dist/Sink.d.ts +125 -1
- package/dist/Sink.d.ts.map +1 -1
- package/dist/Sink.js +75 -1
- package/dist/Sink.js.map +1 -1
- package/dist/StandardSchema.d.ts +1 -0
- package/dist/StandardSchema.d.ts.map +1 -1
- package/dist/StandardSchema.js +1 -0
- package/dist/Stdio.d.ts +7 -0
- package/dist/Stdio.d.ts.map +1 -1
- package/dist/Stdio.js +5 -0
- package/dist/Stdio.js.map +1 -1
- package/dist/Stream.d.ts +603 -6
- package/dist/Stream.d.ts.map +1 -1
- package/dist/Stream.js +316 -57
- package/dist/Stream.js.map +1 -1
- package/dist/String.d.ts +87 -0
- package/dist/String.d.ts.map +1 -1
- package/dist/String.js +61 -0
- package/dist/String.js.map +1 -1
- package/dist/Struct.d.ts +46 -0
- package/dist/Struct.d.ts.map +1 -1
- package/dist/Struct.js +19 -0
- package/dist/Struct.js.map +1 -1
- package/dist/SubscriptionRef.d.ts +65 -0
- package/dist/SubscriptionRef.d.ts.map +1 -1
- package/dist/SubscriptionRef.js +25 -0
- package/dist/SubscriptionRef.js.map +1 -1
- package/dist/Symbol.d.ts +2 -0
- package/dist/Symbol.d.ts.map +1 -1
- package/dist/Symbol.js +2 -0
- package/dist/Symbol.js.map +1 -1
- package/dist/SynchronizedRef.d.ts +63 -0
- package/dist/SynchronizedRef.d.ts.map +1 -1
- package/dist/SynchronizedRef.js +24 -0
- package/dist/SynchronizedRef.js.map +1 -1
- package/dist/Take.d.ts +3 -0
- package/dist/Take.d.ts.map +1 -1
- package/dist/Take.js +1 -0
- package/dist/Take.js.map +1 -1
- package/dist/Terminal.d.ts +8 -0
- package/dist/Terminal.d.ts.map +1 -1
- package/dist/Terminal.js +4 -0
- package/dist/Terminal.js.map +1 -1
- package/dist/Tracer.d.ts +23 -0
- package/dist/Tracer.d.ts.map +1 -1
- package/dist/Tracer.js +12 -0
- package/dist/Tracer.js.map +1 -1
- package/dist/Trie.d.ts +68 -0
- package/dist/Trie.d.ts.map +1 -1
- package/dist/Trie.js +28 -0
- package/dist/Trie.js.map +1 -1
- package/dist/Tuple.d.ts +38 -0
- package/dist/Tuple.d.ts.map +1 -1
- package/dist/Tuple.js +18 -0
- package/dist/Tuple.js.map +1 -1
- package/dist/TxChunk.d.ts +52 -0
- package/dist/TxChunk.d.ts.map +1 -1
- package/dist/TxChunk.js +23 -0
- package/dist/TxChunk.js.map +1 -1
- package/dist/TxDeferred.d.ts +15 -0
- package/dist/TxDeferred.d.ts.map +1 -1
- package/dist/TxDeferred.js +8 -0
- package/dist/TxDeferred.js.map +1 -1
- package/dist/TxHashMap.d.ts +83 -0
- package/dist/TxHashMap.d.ts.map +1 -1
- package/dist/TxHashMap.js +52 -7
- package/dist/TxHashMap.js.map +1 -1
- package/dist/TxHashSet.d.ts +51 -0
- package/dist/TxHashSet.d.ts.map +1 -1
- package/dist/TxHashSet.js +29 -4
- package/dist/TxHashSet.js.map +1 -1
- package/dist/TxPriorityQueue.d.ts +30 -0
- package/dist/TxPriorityQueue.d.ts.map +1 -1
- package/dist/TxPriorityQueue.js +22 -1
- package/dist/TxPriorityQueue.js.map +1 -1
- package/dist/TxPubSub.d.ts +25 -0
- package/dist/TxPubSub.d.ts.map +1 -1
- package/dist/TxPubSub.js +19 -0
- package/dist/TxPubSub.js.map +1 -1
- package/dist/TxQueue.d.ts +51 -0
- package/dist/TxQueue.d.ts.map +1 -1
- package/dist/TxQueue.js +30 -0
- package/dist/TxQueue.js.map +1 -1
- package/dist/TxReentrantLock.d.ts +24 -0
- package/dist/TxReentrantLock.d.ts.map +1 -1
- package/dist/TxReentrantLock.js +32 -18
- package/dist/TxReentrantLock.js.map +1 -1
- package/dist/TxRef.d.ts +14 -0
- package/dist/TxRef.d.ts.map +1 -1
- package/dist/TxRef.js +7 -0
- package/dist/TxRef.js.map +1 -1
- package/dist/TxSemaphore.d.ts +25 -0
- package/dist/TxSemaphore.d.ts.map +1 -1
- package/dist/TxSemaphore.js +29 -13
- package/dist/TxSemaphore.js.map +1 -1
- package/dist/TxSubscriptionRef.d.ts +25 -0
- package/dist/TxSubscriptionRef.d.ts.map +1 -1
- package/dist/TxSubscriptionRef.js +12 -0
- package/dist/TxSubscriptionRef.js.map +1 -1
- package/dist/Types.d.ts +36 -0
- package/dist/Types.d.ts.map +1 -1
- package/dist/Types.js +1 -0
- package/dist/UndefinedOr.d.ts +15 -0
- package/dist/UndefinedOr.d.ts.map +1 -1
- package/dist/UndefinedOr.js +9 -0
- package/dist/UndefinedOr.js.map +1 -1
- package/dist/Unify.d.ts +15 -0
- package/dist/Unify.d.ts.map +1 -1
- package/dist/Unify.js +2 -0
- package/dist/Unify.js.map +1 -1
- package/dist/Utils.d.ts +4 -0
- package/dist/Utils.d.ts.map +1 -1
- package/dist/Utils.js +1 -0
- package/dist/Utils.js.map +1 -1
- package/dist/Version.d.ts +26 -0
- package/dist/Version.d.ts.map +1 -0
- package/dist/Version.js +36 -0
- package/dist/Version.js.map +1 -0
- package/dist/ai/Chat.js +1 -1
- package/dist/ai/Chat.js.map +1 -1
- package/dist/ai/DecisionModel.d.ts +22 -0
- package/dist/ai/DecisionModel.d.ts.map +1 -1
- package/dist/ai/DecisionModel.js +22 -4
- package/dist/ai/DecisionModel.js.map +1 -1
- package/dist/ai/LanguageModel.d.ts +8 -0
- package/dist/ai/LanguageModel.d.ts.map +1 -1
- package/dist/ai/LanguageModel.js +27 -15
- package/dist/ai/LanguageModel.js.map +1 -1
- package/dist/ai/McpSchema.d.ts +508 -508
- package/dist/ai/McpSchema.d.ts.map +1 -1
- package/dist/ai/McpSchema.js +1 -1
- package/dist/ai/McpSchema.js.map +1 -1
- package/dist/ai/McpServer.d.ts +32 -11
- package/dist/ai/McpServer.d.ts.map +1 -1
- package/dist/ai/McpServer.js +224 -172
- package/dist/ai/McpServer.js.map +1 -1
- package/dist/ai/Response.d.ts.map +1 -1
- package/dist/ai/Response.js +22 -12
- package/dist/ai/Response.js.map +1 -1
- package/dist/ai/Telemetry.d.ts +49 -41
- package/dist/ai/Telemetry.d.ts.map +1 -1
- package/dist/ai/Telemetry.js +6 -8
- package/dist/ai/Telemetry.js.map +1 -1
- package/dist/ai/internal/mcpProtocol/v2024_11_05.js +1 -0
- package/dist/ai/internal/mcpProtocol/v2024_11_05.js.map +1 -1
- package/dist/ai/internal/mcpProtocol/v2025_03_26.js +1 -0
- package/dist/ai/internal/mcpProtocol/v2025_03_26.js.map +1 -1
- package/dist/ai/internal/mcpProtocol/v2025_06_18.js +1 -0
- package/dist/ai/internal/mcpProtocol/v2025_06_18.js.map +1 -1
- package/dist/ai/internal/mcpProtocol/v2025_11_25.js +1 -0
- package/dist/ai/internal/mcpProtocol/v2025_11_25.js.map +1 -1
- package/dist/ai/internal/mcpRuntime.js +79 -46
- package/dist/ai/internal/mcpRuntime.js.map +1 -1
- package/dist/ai/internal/mcpSchema/v2024_11_05.js +3 -1
- package/dist/ai/internal/mcpSchema/v2024_11_05.js.map +1 -1
- package/dist/ai/internal/mcpStatefulRuntime.js +1 -0
- package/dist/ai/internal/mcpStatefulRuntime.js.map +1 -1
- package/dist/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
- package/dist/cluster/ClusterWorkflowEngine.js +11 -2
- package/dist/cluster/ClusterWorkflowEngine.js.map +1 -1
- package/dist/cluster/K8sHttpClient.d.ts.map +1 -1
- package/dist/cluster/K8sHttpClient.js +5 -2
- package/dist/cluster/K8sHttpClient.js.map +1 -1
- package/dist/cluster/Sharding.d.ts.map +1 -1
- package/dist/cluster/Sharding.js +14 -7
- package/dist/cluster/Sharding.js.map +1 -1
- package/dist/cluster/SqlMessageStorage.d.ts.map +1 -1
- package/dist/cluster/SqlMessageStorage.js +21 -12
- package/dist/cluster/SqlMessageStorage.js.map +1 -1
- package/dist/cluster/SqlRunnerStorage.d.ts.map +1 -1
- package/dist/cluster/SqlRunnerStorage.js +30 -44
- package/dist/cluster/SqlRunnerStorage.js.map +1 -1
- package/dist/cluster/internal/entityManager.js +63 -62
- package/dist/cluster/internal/entityManager.js.map +1 -1
- package/dist/cluster/internal/interruptors.js +8 -0
- package/dist/cluster/internal/interruptors.js.map +1 -1
- package/dist/cluster/internal/resourceMap.js +39 -14
- package/dist/cluster/internal/resourceMap.js.map +1 -1
- package/dist/cluster/internal/resourceRef.js +168 -87
- package/dist/cluster/internal/resourceRef.js.map +1 -1
- package/dist/encoding/Base64.d.ts +4 -0
- package/dist/encoding/Base64.d.ts.map +1 -1
- package/dist/encoding/Base64.js +4 -0
- package/dist/encoding/Base64.js.map +1 -1
- package/dist/encoding/Base64Url.d.ts +4 -0
- package/dist/encoding/Base64Url.d.ts.map +1 -1
- package/dist/encoding/Base64Url.js +4 -0
- package/dist/encoding/Base64Url.js.map +1 -1
- package/dist/encoding/EncodingError.d.ts +4 -0
- package/dist/encoding/EncodingError.d.ts.map +1 -1
- package/dist/encoding/EncodingError.js +4 -0
- package/dist/encoding/EncodingError.js.map +1 -1
- package/dist/encoding/Hex.d.ts +5 -0
- package/dist/encoding/Hex.d.ts.map +1 -1
- package/dist/encoding/Hex.js +5 -0
- package/dist/encoding/Hex.js.map +1 -1
- package/dist/encoding/Toml.js +2 -2
- package/dist/encoding/Toml.js.map +1 -1
- package/dist/encoding/Yaml.d.ts.map +1 -1
- package/dist/encoding/Yaml.js +6 -4
- package/dist/encoding/Yaml.js.map +1 -1
- package/dist/encoding/index.d.ts +4 -0
- package/dist/encoding/index.d.ts.map +1 -1
- package/dist/encoding/index.js +4 -0
- package/dist/encoding/index.js.map +1 -1
- package/dist/eventlog/SqlEventJournal.js +8 -4
- package/dist/eventlog/SqlEventJournal.js.map +1 -1
- package/dist/eventlog/SqlEventLogServerUnencrypted.d.ts +27 -10
- package/dist/eventlog/SqlEventLogServerUnencrypted.d.ts.map +1 -1
- package/dist/eventlog/SqlEventLogServerUnencrypted.js +49 -7
- package/dist/eventlog/SqlEventLogServerUnencrypted.js.map +1 -1
- package/dist/http/Headers.d.ts +3 -1
- package/dist/http/Headers.d.ts.map +1 -1
- package/dist/http/Headers.js +4 -2
- package/dist/http/Headers.js.map +1 -1
- package/dist/http/HttpClient.d.ts +9 -0
- package/dist/http/HttpClient.d.ts.map +1 -1
- package/dist/http/HttpClient.js +40 -21
- package/dist/http/HttpClient.js.map +1 -1
- package/dist/http/HttpClientResponse.js +3 -1
- package/dist/http/HttpClientResponse.js.map +1 -1
- package/dist/http/HttpEffect.d.ts +3 -0
- package/dist/http/HttpEffect.d.ts.map +1 -1
- package/dist/http/HttpEffect.js +5 -2
- package/dist/http/HttpEffect.js.map +1 -1
- package/dist/http/HttpMiddleware.d.ts +17 -0
- package/dist/http/HttpMiddleware.d.ts.map +1 -1
- package/dist/http/HttpMiddleware.js +58 -40
- package/dist/http/HttpMiddleware.js.map +1 -1
- package/dist/http/HttpServer.d.ts +1 -1
- package/dist/http/HttpServer.d.ts.map +1 -1
- package/dist/http/HttpStaticServer.d.ts.map +1 -1
- package/dist/http/HttpStaticServer.js +14 -0
- package/dist/http/HttpStaticServer.js.map +1 -1
- package/dist/http/HttpTraceContext.d.ts +1 -1
- package/dist/http/HttpTraceContext.d.ts.map +1 -1
- package/dist/http/HttpTraceContext.js +4 -4
- package/dist/http/HttpTraceContext.js.map +1 -1
- package/dist/http/internal/tracing.d.ts +2 -0
- package/dist/http/internal/tracing.d.ts.map +1 -0
- package/dist/http/internal/tracing.js +37 -0
- package/dist/http/internal/tracing.js.map +1 -0
- package/dist/http-api/HttpApiBuilder.js +2 -1
- package/dist/http-api/HttpApiBuilder.js.map +1 -1
- package/dist/http-api/HttpApiClient.d.ts +12 -3
- package/dist/http-api/HttpApiClient.d.ts.map +1 -1
- package/dist/http-api/HttpApiClient.js.map +1 -1
- package/dist/http-api/HttpApiError.d.ts +4 -2
- package/dist/http-api/HttpApiError.d.ts.map +1 -1
- package/dist/http-api/HttpApiError.js +7 -3
- package/dist/http-api/HttpApiError.js.map +1 -1
- package/dist/http-api/HttpApiSecurity.d.ts +8 -8
- package/dist/http-api/HttpApiSecurity.js +8 -8
- package/dist/index.d.ts +155 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +155 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/arbitrary/array.js +3 -3
- package/dist/internal/arbitrary/array.js.map +1 -1
- package/dist/internal/arbitrary/model.js +26 -11
- package/dist/internal/arbitrary/model.js.map +1 -1
- package/dist/internal/arbitrary/runner.js +8 -8
- package/dist/internal/arbitrary/runner.js.map +1 -1
- package/dist/internal/arbitrary/schema.js +4 -5
- package/dist/internal/arbitrary/schema.js.map +1 -1
- package/dist/internal/core.js +43 -2
- package/dist/internal/core.js.map +1 -1
- package/dist/internal/dateTime.js +1 -1
- package/dist/internal/dateTime.js.map +1 -1
- package/dist/internal/effect.js +104 -120
- package/dist/internal/effect.js.map +1 -1
- package/dist/internal/rcRef.js +59 -23
- package/dist/internal/rcRef.js.map +1 -1
- package/dist/internal/schedule.js +7 -5
- package/dist/internal/schedule.js.map +1 -1
- package/dist/internal/schema/fromJsonSchemaDocument.js +11 -8
- package/dist/internal/schema/fromJsonSchemaDocument.js.map +1 -1
- package/dist/internal/schema/standardSchema.js +2 -2
- package/dist/internal/schema/standardSchema.js.map +1 -1
- package/dist/internal/version.d.ts +2 -0
- package/dist/internal/version.d.ts.map +1 -0
- package/dist/internal/version.js +3 -0
- package/dist/internal/version.js.map +1 -0
- package/dist/observability/OtlpExporter.d.ts.map +1 -1
- package/dist/observability/OtlpExporter.js +5 -6
- package/dist/observability/OtlpExporter.js.map +1 -1
- package/dist/observability/OtlpLogger.d.ts.map +1 -1
- package/dist/observability/OtlpLogger.js +23 -27
- package/dist/observability/OtlpLogger.js.map +1 -1
- package/dist/observability/OtlpMetrics.d.ts +5 -3
- package/dist/observability/OtlpMetrics.d.ts.map +1 -1
- package/dist/observability/OtlpMetrics.js +21 -94
- package/dist/observability/OtlpMetrics.js.map +1 -1
- package/dist/observability/OtlpResource.d.ts +4 -3
- package/dist/observability/OtlpResource.d.ts.map +1 -1
- package/dist/observability/OtlpResource.js +20 -23
- package/dist/observability/OtlpResource.js.map +1 -1
- package/dist/observability/OtlpTracer.d.ts +1 -0
- package/dist/observability/OtlpTracer.d.ts.map +1 -1
- package/dist/observability/OtlpTracer.js +32 -36
- package/dist/observability/OtlpTracer.js.map +1 -1
- package/dist/observability/internal/otlpProtobuf.js +32 -1
- package/dist/observability/internal/otlpProtobuf.js.map +1 -1
- package/dist/reactivity/AsyncResult.d.ts +1 -1
- package/dist/reactivity/Atom.d.ts +5 -5
- package/dist/reactivity/Atom.d.ts.map +1 -1
- package/dist/reactivity/Atom.js +9 -5
- package/dist/reactivity/Atom.js.map +1 -1
- package/dist/reactivity/AtomHttpApi.d.ts +2 -2
- package/dist/reactivity/AtomHttpApi.d.ts.map +1 -1
- package/dist/reactivity/AtomRegistry.d.ts +8 -0
- package/dist/reactivity/AtomRegistry.d.ts.map +1 -1
- package/dist/reactivity/AtomRegistry.js.map +1 -1
- package/dist/rpc/RpcClient.d.ts +21 -3
- package/dist/rpc/RpcClient.d.ts.map +1 -1
- package/dist/rpc/RpcClient.js +58 -34
- package/dist/rpc/RpcClient.js.map +1 -1
- package/dist/rpc/RpcServer.d.ts.map +1 -1
- package/dist/rpc/RpcServer.js +20 -23
- package/dist/rpc/RpcServer.js.map +1 -1
- package/dist/rpc/Utils.d.ts +2 -3
- package/dist/rpc/Utils.d.ts.map +1 -1
- package/dist/rpc/Utils.js +3 -4
- package/dist/rpc/Utils.js.map +1 -1
- package/dist/rpc/internal/tracing.d.ts +2 -0
- package/dist/rpc/internal/tracing.d.ts.map +1 -0
- package/dist/rpc/internal/tracing.js +18 -0
- package/dist/rpc/internal/tracing.js.map +1 -0
- package/dist/schema/SchemaCompiler/runtime.js +9 -1
- package/dist/schema/SchemaCompiler/runtime.js.map +1 -1
- package/dist/sql/SqlClient.js +4 -4
- package/dist/sql/SqlClient.js.map +1 -1
- package/dist/sql/Statement.d.ts +21 -1
- package/dist/sql/Statement.d.ts.map +1 -1
- package/dist/sql/Statement.js +55 -7
- package/dist/sql/Statement.js.map +1 -1
- package/dist/testing/TestClock.d.ts +8 -0
- package/dist/testing/TestClock.d.ts.map +1 -1
- package/dist/testing/TestClock.js +7 -0
- package/dist/testing/TestClock.js.map +1 -1
- package/dist/testing/TestConsole.d.ts +7 -0
- package/dist/testing/TestConsole.d.ts.map +1 -1
- package/dist/testing/TestConsole.js +6 -0
- package/dist/testing/TestConsole.js.map +1 -1
- package/dist/testing/index.d.ts +3 -0
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +3 -0
- package/dist/testing/index.js.map +1 -1
- package/dist/workflow/WorkflowEngine.d.ts +2 -0
- package/dist/workflow/WorkflowEngine.d.ts.map +1 -1
- package/dist/workflow/WorkflowEngine.js +1 -0
- package/dist/workflow/WorkflowEngine.js.map +1 -1
- package/package.json +3 -3
- package/src/Array.ts +351 -3
- package/src/BigDecimal.ts +88 -0
- package/src/BigInt.ts +68 -0
- package/src/Boolean.ts +34 -0
- package/src/Brand.ts +10 -0
- package/src/ByteSize.ts +87 -0
- package/src/Cache.ts +72 -24
- package/src/Cause.ts +83 -1
- package/src/Channel.ts +368 -18
- package/src/ChannelSchema.ts +13 -0
- package/src/Chunk.ts +193 -0
- package/src/Clock.ts +7 -0
- package/src/Combiner.ts +10 -0
- package/src/Config.ts +82 -8
- package/src/ConfigProvider.ts +28 -0
- package/src/Console.ts +26 -0
- package/src/Context.ts +50 -0
- package/src/Cron.ts +32 -1
- package/src/Crypto.ts +5 -0
- package/src/Data.ts +13 -0
- package/src/DateTime.ts +171 -0
- package/src/Deferred.ts +51 -0
- package/src/Differ.ts +2 -0
- package/src/Duration.ts +90 -0
- package/src/Effect.ts +692 -27
- package/src/Effectable.ts +4 -0
- package/src/Equal.ts +12 -1
- package/src/Equivalence.ts +22 -0
- package/src/ErrorReporter.ts +36 -0
- package/src/ExecutionPlan.ts +58 -14
- package/src/Exit.ts +40 -0
- package/src/Fiber.ts +20 -0
- package/src/FiberHandle.ts +29 -4
- package/src/FiberMap.ts +38 -0
- package/src/FiberSet.ts +21 -0
- package/src/FileSystem.ts +16 -0
- package/src/Filter.ts +55 -0
- package/src/Formatter.ts +42 -1
- package/src/Function.ts +30 -0
- package/src/Graph.ts +317 -36
- package/src/HKT.ts +5 -0
- package/src/Hash.ts +15 -0
- package/src/HashMap.ts +91 -0
- package/src/HashRing.ts +32 -5
- package/src/HashSet.ts +53 -0
- package/src/Inspectable.ts +8 -0
- package/src/Iterable.ts +127 -0
- package/src/JsonPatch.ts +5 -0
- package/src/JsonPointer.ts +5 -0
- package/src/JsonSchema.ts +17 -0
- package/src/Latch.ts +14 -0
- package/src/Layer.ts +101 -1
- package/src/LayerMap.ts +7 -0
- package/src/LayerRef.ts +5 -0
- package/src/LogLevel.ts +20 -0
- package/src/Logger.ts +41 -5
- package/src/ManagedRuntime.ts +12 -1
- package/src/Match.ts +52 -0
- package/src/Metric.ts +69 -0
- package/src/MutableHashMap.ts +44 -0
- package/src/MutableHashSet.ts +17 -0
- package/src/MutableList.ts +21 -0
- package/src/MutableRef.ts +32 -0
- package/src/Newtype.ts +9 -0
- package/src/NonEmptyIterable.ts +4 -0
- package/src/Number.ts +61 -0
- package/src/Optic.ts +57 -0
- package/src/Option.ts +134 -0
- package/src/Order.ts +30 -0
- package/src/Ordering.ts +7 -0
- package/src/PartitionedSemaphore.ts +61 -22
- package/src/Path.ts +6 -0
- package/src/Pipeable.ts +7 -0
- package/src/PlatformError.ts +8 -0
- package/src/Pool.ts +48 -37
- package/src/Predicate.ts +85 -0
- package/src/PrimaryKey.ts +5 -0
- package/src/PubSub.ts +90 -9
- package/src/Pull.ts +20 -0
- package/src/Queue.ts +80 -10
- package/src/Random.ts +13 -0
- package/src/RcMap.ts +49 -2
- package/src/RcRef.ts +6 -0
- package/src/Record.ts +100 -0
- package/src/Redactable.ts +6 -0
- package/src/Redacted.ts +8 -0
- package/src/Reducer.ts +4 -0
- package/src/Ref.ts +42 -0
- package/src/References.ts +21 -0
- package/src/RegExp.ts +4 -0
- package/src/Request.ts +32 -0
- package/src/RequestResolver.ts +59 -10
- package/src/Resource.ts +7 -0
- package/src/Result.ts +93 -0
- package/src/Runtime.ts +10 -0
- package/src/Schedule.ts +61 -0
- package/src/Scheduler.ts +7 -0
- package/src/Schema.ts +499 -4
- package/src/SchemaAST.ts +115 -1
- package/src/SchemaGetter.ts +80 -4
- package/src/SchemaIssue.ts +34 -0
- package/src/SchemaParser.ts +26 -0
- package/src/SchemaRepresentation.ts +148 -0
- package/src/SchemaTransformation.ts +53 -0
- package/src/Scope.ts +19 -0
- package/src/ScopedCache.ts +82 -19
- package/src/ScopedRef.ts +9 -0
- package/src/Semaphore.ts +26 -0
- package/src/Sink.ts +126 -2
- package/src/StandardSchema.ts +1 -0
- package/src/Stdio.ts +7 -0
- package/src/Stream.ts +780 -103
- package/src/String.ts +87 -0
- package/src/Struct.ts +46 -0
- package/src/SubscriptionRef.ts +65 -0
- package/src/Symbol.ts +2 -0
- package/src/SynchronizedRef.ts +63 -0
- package/src/Take.ts +3 -0
- package/src/Terminal.ts +8 -0
- package/src/Tracer.ts +23 -0
- package/src/Trie.ts +68 -0
- package/src/Tuple.ts +38 -0
- package/src/TxChunk.ts +52 -0
- package/src/TxDeferred.ts +15 -0
- package/src/TxHashMap.ts +97 -6
- package/src/TxHashSet.ts +83 -3
- package/src/TxPriorityQueue.ts +34 -2
- package/src/TxPubSub.ts +26 -0
- package/src/TxQueue.ts +51 -0
- package/src/TxReentrantLock.ts +53 -36
- package/src/TxRef.ts +14 -0
- package/src/TxSemaphore.ts +47 -31
- package/src/TxSubscriptionRef.ts +25 -0
- package/src/Types.ts +36 -0
- package/src/UndefinedOr.ts +15 -0
- package/src/Unify.ts +15 -0
- package/src/Utils.ts +4 -0
- package/src/Version.ts +38 -0
- package/src/ai/Chat.ts +1 -1
- package/src/ai/DecisionModel.ts +42 -1
- package/src/ai/LanguageModel.ts +43 -21
- package/src/ai/McpSchema.ts +3 -3
- package/src/ai/McpServer.ts +119 -39
- package/src/ai/Response.ts +27 -12
- package/src/ai/Telemetry.ts +62 -58
- package/src/ai/internal/mcpProtocol/v2024_11_05.ts +1 -0
- package/src/ai/internal/mcpProtocol/v2025_03_26.ts +1 -0
- package/src/ai/internal/mcpProtocol/v2025_06_18.ts +1 -0
- package/src/ai/internal/mcpProtocol/v2025_11_25.ts +1 -0
- package/src/ai/internal/mcpRuntime.ts +84 -43
- package/src/ai/internal/mcpSchema/v2024_11_05.ts +4 -2
- package/src/ai/internal/mcpStatefulRuntime.ts +2 -0
- package/src/cluster/ClusterWorkflowEngine.ts +18 -4
- package/src/cluster/K8sHttpClient.ts +12 -2
- package/src/cluster/Sharding.ts +24 -24
- package/src/cluster/SqlMessageStorage.ts +26 -13
- package/src/cluster/SqlRunnerStorage.ts +85 -113
- package/src/cluster/internal/entityManager.ts +68 -80
- package/src/cluster/internal/interruptors.ts +13 -0
- package/src/cluster/internal/resourceMap.ts +55 -17
- package/src/cluster/internal/resourceRef.ts +189 -96
- package/src/encoding/Base64.ts +4 -0
- package/src/encoding/Base64Url.ts +4 -0
- package/src/encoding/EncodingError.ts +5 -0
- package/src/encoding/Hex.ts +5 -0
- package/src/encoding/Toml.ts +2 -2
- package/src/encoding/Yaml.ts +8 -4
- package/src/encoding/index.ts +4 -0
- package/src/eventlog/SqlEventJournal.ts +18 -4
- package/src/eventlog/SqlEventLogServerUnencrypted.ts +282 -235
- package/src/http/Headers.ts +8 -2
- package/src/http/HttpClient.ts +44 -27
- package/src/http/HttpClientResponse.ts +3 -1
- package/src/http/HttpEffect.ts +11 -2
- package/src/http/HttpMiddleware.ts +67 -46
- package/src/http/HttpServer.ts +1 -1
- package/src/http/HttpStaticServer.ts +16 -0
- package/src/http/HttpTraceContext.ts +8 -4
- package/src/http/internal/tracing.ts +52 -0
- package/src/http-api/HttpApiBuilder.ts +5 -1
- package/src/http-api/HttpApiClient.ts +13 -4
- package/src/http-api/HttpApiError.ts +8 -3
- package/src/http-api/HttpApiSecurity.ts +8 -8
- package/src/index.ts +156 -0
- package/src/internal/arbitrary/array.ts +3 -3
- package/src/internal/arbitrary/model.ts +37 -14
- package/src/internal/arbitrary/runner.ts +7 -7
- package/src/internal/arbitrary/schema.ts +4 -3
- package/src/internal/core.ts +56 -2
- package/src/internal/dateTime.ts +3 -1
- package/src/internal/effect.ts +156 -156
- package/src/internal/rcRef.ts +83 -33
- package/src/internal/schedule.ts +23 -17
- package/src/internal/schema/fromJsonSchemaDocument.ts +5 -3
- package/src/internal/schema/standardSchema.ts +2 -2
- package/src/internal/version.ts +2 -0
- package/src/observability/OtlpExporter.ts +9 -6
- package/src/observability/OtlpLogger.ts +20 -21
- package/src/observability/OtlpMetrics.ts +34 -93
- package/src/observability/OtlpResource.ts +18 -27
- package/src/observability/OtlpTracer.ts +34 -40
- package/src/observability/internal/otlpProtobuf.ts +60 -0
- package/src/reactivity/AsyncResult.ts +1 -1
- package/src/reactivity/Atom.ts +10 -6
- package/src/reactivity/AtomHttpApi.ts +2 -4
- package/src/reactivity/AtomRegistry.ts +7 -0
- package/src/rpc/RpcClient.ts +74 -46
- package/src/rpc/RpcServer.ts +28 -25
- package/src/rpc/Utils.ts +4 -10
- package/src/rpc/internal/tracing.ts +22 -0
- package/src/schema/SchemaCompiler/runtime.ts +4 -1
- package/src/sql/SqlClient.ts +4 -4
- package/src/sql/Statement.ts +59 -7
- package/src/testing/TestClock.ts +9 -0
- package/src/testing/TestConsole.ts +8 -0
- package/src/testing/index.ts +3 -0
- package/src/workflow/WorkflowEngine.ts +4 -0
package/src/Schema.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* generation, formatting, equivalence, optics, and differs derived from schema
|
|
10
10
|
* definitions.
|
|
11
11
|
*
|
|
12
|
+
* @stability stable
|
|
12
13
|
* @since 4.0.0
|
|
13
14
|
*/
|
|
14
15
|
|
|
@@ -87,6 +88,7 @@ const TypeId = InternalMake.TypeId
|
|
|
87
88
|
* @see {@link optionalKey} — mark a struct field as optional
|
|
88
89
|
* @see {@link optional} — mark a struct field as optional with `| undefined`
|
|
89
90
|
*
|
|
91
|
+
* @stability stable
|
|
90
92
|
* @category models
|
|
91
93
|
* @since 4.0.0
|
|
92
94
|
*/
|
|
@@ -96,6 +98,7 @@ export type Optionality = "required" | "optional"
|
|
|
96
98
|
*
|
|
97
99
|
* @see {@link mutableKey} — mark a struct field as mutable
|
|
98
100
|
*
|
|
101
|
+
* @stability stable
|
|
99
102
|
* @category models
|
|
100
103
|
* @since 4.0.0
|
|
101
104
|
*/
|
|
@@ -106,6 +109,7 @@ export type Mutability = "readonly" | "mutable"
|
|
|
106
109
|
* @see {@link withConstructorDefault} — add a default to a schema field
|
|
107
110
|
* @see {@link tag} — creates a literal field with a constructor default
|
|
108
111
|
*
|
|
112
|
+
* @stability stable
|
|
109
113
|
* @category models
|
|
110
114
|
* @since 4.0.0
|
|
111
115
|
*/
|
|
@@ -121,6 +125,7 @@ export type ConstructorDefault = "no-default" | "with-default"
|
|
|
121
125
|
* @see {@link BottomWithoutNew.makeEffect}
|
|
122
126
|
* @see {@link BottomWithoutNew.make}
|
|
123
127
|
*
|
|
128
|
+
* @stability stable
|
|
124
129
|
* @category options
|
|
125
130
|
* @since 3.13.4
|
|
126
131
|
*/
|
|
@@ -150,6 +155,7 @@ export interface MakeOptions {
|
|
|
150
155
|
* Use as the base for schema interfaces that provide a specialized construct
|
|
151
156
|
* signature.
|
|
152
157
|
*
|
|
158
|
+
* @stability stable
|
|
153
159
|
* @category models
|
|
154
160
|
* @since 4.0.0
|
|
155
161
|
*/
|
|
@@ -286,6 +292,7 @@ export interface BottomWithoutNew<
|
|
|
286
292
|
*
|
|
287
293
|
* @see {@link BottomWithoutNew} for the schema protocol without a construct signature
|
|
288
294
|
*
|
|
295
|
+
* @stability stable
|
|
289
296
|
* @category utility types
|
|
290
297
|
* @since 4.0.0
|
|
291
298
|
*/
|
|
@@ -347,6 +354,7 @@ export interface Bottom<
|
|
|
347
354
|
* @see {@link BottomWithoutNew} for the fully parameterized schema interface when every
|
|
348
355
|
* view must be supplied directly.
|
|
349
356
|
*
|
|
357
|
+
* @stability stable
|
|
350
358
|
* @category utility types
|
|
351
359
|
* @since 4.0.0
|
|
352
360
|
*/
|
|
@@ -395,6 +403,7 @@ export interface BottomLazyWithoutNew<
|
|
|
395
403
|
*
|
|
396
404
|
* @see {@link BottomLazyWithoutNew} for the lazy schema protocol without a construct signature
|
|
397
405
|
*
|
|
406
|
+
* @stability stable
|
|
398
407
|
* @category utility types
|
|
399
408
|
* @since 4.0.0
|
|
400
409
|
*/
|
|
@@ -424,6 +433,7 @@ export interface BottomLazy<
|
|
|
424
433
|
/**
|
|
425
434
|
* Type-level representation returned by {@link declareConstructor}.
|
|
426
435
|
*
|
|
436
|
+
* @stability stable
|
|
427
437
|
* @category constructors
|
|
428
438
|
* @since 4.0.0
|
|
429
439
|
*/
|
|
@@ -492,6 +502,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<C
|
|
|
492
502
|
* Effect.runSync(Schema.decodeUnknownEffect(schema)({ value: 1 })) // => { value: 1 }
|
|
493
503
|
* ```
|
|
494
504
|
*
|
|
505
|
+
* @stability stable
|
|
495
506
|
* @category constructors
|
|
496
507
|
* @since 4.0.0
|
|
497
508
|
*/
|
|
@@ -521,6 +532,7 @@ export function declareConstructor<T, E = T, Iso = T>() {
|
|
|
521
532
|
/**
|
|
522
533
|
* Type-level representation returned by {@link declare}.
|
|
523
534
|
*
|
|
535
|
+
* @stability stable
|
|
524
536
|
* @category constructors
|
|
525
537
|
* @since 3.13.3
|
|
526
538
|
*/
|
|
@@ -556,6 +568,7 @@ export interface declare<T, Iso = T> extends declareConstructor<T, T, readonly [
|
|
|
556
568
|
*
|
|
557
569
|
* @see {@link declareConstructor} for creating schemas for parametric types.
|
|
558
570
|
*
|
|
571
|
+
* @stability stable
|
|
559
572
|
* @category constructors
|
|
560
573
|
* @since 3.10.0
|
|
561
574
|
*/
|
|
@@ -598,6 +611,7 @@ export function declare<T, Iso = T>(
|
|
|
598
611
|
* type E = typeof bottom["Encoded"] // string
|
|
599
612
|
* ```
|
|
600
613
|
*
|
|
614
|
+
* @stability stable
|
|
601
615
|
* @category utility types
|
|
602
616
|
* @since 4.0.0
|
|
603
617
|
*/
|
|
@@ -648,6 +662,7 @@ export function revealBottom<S extends Top>(
|
|
|
648
662
|
*
|
|
649
663
|
* @see {@link annotateEncoded} to annotate the encoded side instead.
|
|
650
664
|
*
|
|
665
|
+
* @stability stable
|
|
651
666
|
* @category annotations
|
|
652
667
|
* @since 4.0.0
|
|
653
668
|
*/
|
|
@@ -680,6 +695,7 @@ export function annotate<S extends Top>(annotations: Annotations.Bottom<S["Type"
|
|
|
680
695
|
*
|
|
681
696
|
* @see {@link annotate} to annotate the type side instead.
|
|
682
697
|
*
|
|
698
|
+
* @stability stable
|
|
683
699
|
* @category annotations
|
|
684
700
|
* @since 4.0.0
|
|
685
701
|
*/
|
|
@@ -714,6 +730,7 @@ export function annotateEncoded<S extends Top>(annotations: Annotations.Bottom<S
|
|
|
714
730
|
* schema.fields.username.ast.context?.annotations?.messageMissingKey // => "Username is required"
|
|
715
731
|
* ```
|
|
716
732
|
*
|
|
733
|
+
* @stability stable
|
|
717
734
|
* @category annotations
|
|
718
735
|
* @since 4.0.0
|
|
719
736
|
*/
|
|
@@ -737,6 +754,7 @@ export function annotateKey<S extends Top>(annotations: Annotations.Key<S["Type"
|
|
|
737
754
|
* - {@link ConstraintDecoder}`<T, RD>` — for decode-only APIs
|
|
738
755
|
* - {@link ConstraintEncoder}`<E, RE>` — for encode-only APIs
|
|
739
756
|
*
|
|
757
|
+
* @stability stable
|
|
740
758
|
* @category models
|
|
741
759
|
* @since 4.0.0
|
|
742
760
|
*/
|
|
@@ -778,6 +796,7 @@ export interface Top extends
|
|
|
778
796
|
*
|
|
779
797
|
* @see {@link Top} for the complete schema protocol.
|
|
780
798
|
*
|
|
799
|
+
* @stability stable
|
|
781
800
|
* @category models
|
|
782
801
|
* @since 4.0.0
|
|
783
802
|
*/
|
|
@@ -814,6 +833,7 @@ export interface Constraint {
|
|
|
814
833
|
* @see {@link Constraint} for the generic lightweight schema constraint.
|
|
815
834
|
* @see {@link Codec} for the full schema protocol with codec type views.
|
|
816
835
|
*
|
|
836
|
+
* @stability stable
|
|
817
837
|
* @category models
|
|
818
838
|
* @since 4.0.0
|
|
819
839
|
*/
|
|
@@ -837,6 +857,7 @@ export interface ConstraintCodec<out T, out E = T, out RD = never, out RE = neve
|
|
|
837
857
|
* @see {@link ConstraintCodec} for APIs that need both decoded and encoded codec views.
|
|
838
858
|
* @see {@link Codec} for the full schema protocol with codec type views.
|
|
839
859
|
*
|
|
860
|
+
* @stability stable
|
|
840
861
|
* @category models
|
|
841
862
|
* @since 4.0.0
|
|
842
863
|
*/
|
|
@@ -855,6 +876,7 @@ export interface ConstraintDecoder<out T, out RD = never> extends ConstraintCode
|
|
|
855
876
|
* @see {@link ConstraintCodec} for APIs that need both decoded and encoded codec views.
|
|
856
877
|
* @see {@link Codec} for the full schema protocol with codec type views.
|
|
857
878
|
*
|
|
879
|
+
* @stability stable
|
|
858
880
|
* @category models
|
|
859
881
|
* @since 4.0.0
|
|
860
882
|
*/
|
|
@@ -869,6 +891,7 @@ export interface ConstraintEncoder<out E, out RE = never> extends ConstraintCode
|
|
|
869
891
|
* exposed by {@link Constraint}, but does not call methods such as `annotate`,
|
|
870
892
|
* `check`, `rebuild`, `make`, or `makeEffect`.
|
|
871
893
|
*
|
|
894
|
+
* @stability stable
|
|
872
895
|
* @category models
|
|
873
896
|
* @since 4.0.0
|
|
874
897
|
*/
|
|
@@ -878,6 +901,7 @@ export interface ConstraintRebuildable extends Constraint {
|
|
|
878
901
|
/**
|
|
879
902
|
* Namespace of type-level helpers for {@link Schema}.
|
|
880
903
|
*
|
|
904
|
+
* @stability stable
|
|
881
905
|
* @since 3.10.0
|
|
882
906
|
*/
|
|
883
907
|
export declare namespace Schema {
|
|
@@ -929,6 +953,7 @@ export declare namespace Schema {
|
|
|
929
953
|
* @see {@link Codec} — also tracks Encoded, DecodingServices, EncodingServices
|
|
930
954
|
* @see {@link Schema.Type} — extract the decoded type at the type level
|
|
931
955
|
*
|
|
956
|
+
* @stability stable
|
|
932
957
|
* @category models
|
|
933
958
|
* @since 3.10.0
|
|
934
959
|
*/
|
|
@@ -939,6 +964,7 @@ export interface Schema<out T> extends Top {
|
|
|
939
964
|
/**
|
|
940
965
|
* Namespace of type-level helpers for {@link Codec}.
|
|
941
966
|
*
|
|
967
|
+
* @stability stable
|
|
942
968
|
* @since 4.0.0
|
|
943
969
|
*/
|
|
944
970
|
export declare namespace Codec {
|
|
@@ -1034,6 +1060,7 @@ export declare namespace Codec {
|
|
|
1034
1060
|
* @see {@link Codec.EncodingServices} — extract required encoding services
|
|
1035
1061
|
* @see {@link revealCodec} — helper to make TypeScript infer the full Codec type
|
|
1036
1062
|
*
|
|
1063
|
+
* @stability stable
|
|
1037
1064
|
* @category models
|
|
1038
1065
|
* @since 4.0.0
|
|
1039
1066
|
*/
|
|
@@ -1056,6 +1083,7 @@ export interface Codec<out T, out E = T, out RD = never, out RE = never> extends
|
|
|
1056
1083
|
* @see {@link Codec} for preserving both decoded and encoded type information.
|
|
1057
1084
|
* @see {@link Encoder} for the encode-only view.
|
|
1058
1085
|
*
|
|
1086
|
+
* @stability stable
|
|
1059
1087
|
* @category models
|
|
1060
1088
|
* @since 4.0.0
|
|
1061
1089
|
*/
|
|
@@ -1078,6 +1106,7 @@ export interface Decoder<out T, out RD = never> extends Schema<T> {
|
|
|
1078
1106
|
* @see {@link Codec} for preserving both decoded and encoded type information.
|
|
1079
1107
|
* @see {@link Decoder} for the decode-only view.
|
|
1080
1108
|
*
|
|
1109
|
+
* @stability stable
|
|
1081
1110
|
* @category models
|
|
1082
1111
|
* @since 4.0.0
|
|
1083
1112
|
*/
|
|
@@ -1109,6 +1138,7 @@ export interface Encoder<out E, out RE = never> extends Schema<unknown> {
|
|
|
1109
1138
|
* type Enc = typeof codec["Encoded"] // string
|
|
1110
1139
|
* ```
|
|
1111
1140
|
*
|
|
1141
|
+
* @stability stable
|
|
1112
1142
|
* @category utility types
|
|
1113
1143
|
* @since 4.0.0
|
|
1114
1144
|
*/
|
|
@@ -1130,6 +1160,7 @@ export function revealCodec<T, E, RD, RE>(codec: Codec<T, E, RD, RE>) {
|
|
|
1130
1160
|
* `Optic` automatically. You normally interact with this interface through
|
|
1131
1161
|
* {@link Optic_} utilities rather than constructing it directly.
|
|
1132
1162
|
*
|
|
1163
|
+
* @stability stable
|
|
1133
1164
|
* @category models
|
|
1134
1165
|
* @since 4.0.0
|
|
1135
1166
|
*/
|
|
@@ -1166,6 +1197,7 @@ export interface Optic<out T, out Iso> extends Schema<T> {
|
|
|
1166
1197
|
* ```
|
|
1167
1198
|
*
|
|
1168
1199
|
* @see {@link isSchemaError} for narrowing unknown values
|
|
1200
|
+
* @stability stable
|
|
1169
1201
|
* @category errors
|
|
1170
1202
|
* @since 4.0.0
|
|
1171
1203
|
*/
|
|
@@ -1206,6 +1238,7 @@ export class SchemaError extends Data.TaggedError("SchemaError")<{
|
|
|
1206
1238
|
* Schema.isSchemaError(error) // => true
|
|
1207
1239
|
* ```
|
|
1208
1240
|
*
|
|
1241
|
+
* @stability stable
|
|
1209
1242
|
* @category guards
|
|
1210
1243
|
* @since 4.0.0
|
|
1211
1244
|
*/
|
|
@@ -1333,6 +1366,7 @@ function runSchemaErrorSync<A>(
|
|
|
1333
1366
|
* invalidResult.issues?.map((issue) => issue.path) // => [["name"], ["age"]]
|
|
1334
1367
|
* ```
|
|
1335
1368
|
*
|
|
1369
|
+
* @stability stable
|
|
1336
1370
|
* @category converting
|
|
1337
1371
|
* @since 4.0.0
|
|
1338
1372
|
*/
|
|
@@ -1353,6 +1387,7 @@ export function toStandardSchemaV1<S extends ConstraintDecoder<unknown>>(
|
|
|
1353
1387
|
*
|
|
1354
1388
|
* https://github.com/standard-schema/standard-schema/pull/134
|
|
1355
1389
|
*
|
|
1390
|
+
* @stability stable
|
|
1356
1391
|
* @category converting
|
|
1357
1392
|
* @since 4.0.0
|
|
1358
1393
|
*/
|
|
@@ -1395,6 +1430,7 @@ export function toStandardJSONSchemaV1<S extends Constraint>(
|
|
|
1395
1430
|
* }
|
|
1396
1431
|
* ```
|
|
1397
1432
|
*
|
|
1433
|
+
* @stability stable
|
|
1398
1434
|
* @category guards
|
|
1399
1435
|
* @since 3.10.0
|
|
1400
1436
|
*/
|
|
@@ -1444,6 +1480,7 @@ export const is: typeof SchemaParser.is = SchemaParser.is
|
|
|
1444
1480
|
* }
|
|
1445
1481
|
* ```
|
|
1446
1482
|
*
|
|
1483
|
+
* @stability stable
|
|
1447
1484
|
* @category guards
|
|
1448
1485
|
* @since 4.0.0
|
|
1449
1486
|
*/
|
|
@@ -1467,6 +1504,7 @@ export const asserts: <S extends Constraint, I>(schema: S, input: I) => asserts
|
|
|
1467
1504
|
*
|
|
1468
1505
|
* @see {@link SchemaParser.decodeUnknownEffect} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1469
1506
|
*
|
|
1507
|
+
* @stability stable
|
|
1470
1508
|
* @category decoding
|
|
1471
1509
|
* @since 4.0.0
|
|
1472
1510
|
*/
|
|
@@ -1497,6 +1535,7 @@ export function decodeUnknownEffect<S extends Constraint>(schema: S, options?: S
|
|
|
1497
1535
|
*
|
|
1498
1536
|
* @see {@link SchemaParser.decodeEffect} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1499
1537
|
*
|
|
1538
|
+
* @stability stable
|
|
1500
1539
|
* @category decoding
|
|
1501
1540
|
* @since 4.0.0
|
|
1502
1541
|
*/
|
|
@@ -1534,6 +1573,7 @@ export const decodeEffect: <S extends Constraint>(
|
|
|
1534
1573
|
*
|
|
1535
1574
|
* @see {@link SchemaParser.decodeUnknownExit} for the adapter whose failure contains `SchemaIssue.Issue` directly
|
|
1536
1575
|
*
|
|
1576
|
+
* @stability stable
|
|
1537
1577
|
* @category decoding
|
|
1538
1578
|
* @since 4.0.0
|
|
1539
1579
|
*/
|
|
@@ -1570,6 +1610,7 @@ export function decodeUnknownExit<S extends ConstraintDecoder<unknown>>(schema:
|
|
|
1570
1610
|
*
|
|
1571
1611
|
* @see {@link SchemaParser.decodeExit} for the adapter whose failure contains `SchemaIssue.Issue` directly
|
|
1572
1612
|
*
|
|
1613
|
+
* @stability stable
|
|
1573
1614
|
* @category decoding
|
|
1574
1615
|
* @since 4.0.0
|
|
1575
1616
|
*/
|
|
@@ -1600,6 +1641,7 @@ export const decodeExit: <S extends ConstraintDecoder<unknown>>(
|
|
|
1600
1641
|
* that contain defects, interruptions, or other non-schema reasons throw
|
|
1601
1642
|
* instead.
|
|
1602
1643
|
*
|
|
1644
|
+
* @stability stable
|
|
1603
1645
|
* @category decoding
|
|
1604
1646
|
* @since 3.10.0
|
|
1605
1647
|
*/
|
|
@@ -1629,6 +1671,7 @@ export const decodeUnknownOption: <S extends ConstraintDecoder<unknown>>(
|
|
|
1629
1671
|
* that contain defects, interruptions, or other non-schema reasons throw
|
|
1630
1672
|
* instead.
|
|
1631
1673
|
*
|
|
1674
|
+
* @stability stable
|
|
1632
1675
|
* @category decoding
|
|
1633
1676
|
* @since 3.10.0
|
|
1634
1677
|
*/
|
|
@@ -1662,6 +1705,7 @@ export const decodeOption: <S extends ConstraintDecoder<unknown>>(
|
|
|
1662
1705
|
*
|
|
1663
1706
|
* @see {@link SchemaParser.decodeUnknownResult} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1664
1707
|
*
|
|
1708
|
+
* @stability stable
|
|
1665
1709
|
* @category decoding
|
|
1666
1710
|
* @since 4.0.0
|
|
1667
1711
|
*/
|
|
@@ -1696,6 +1740,7 @@ export function decodeUnknownResult<S extends ConstraintDecoder<unknown>>(schema
|
|
|
1696
1740
|
*
|
|
1697
1741
|
* @see {@link SchemaParser.decodeResult} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1698
1742
|
*
|
|
1743
|
+
* @stability stable
|
|
1699
1744
|
* @category decoding
|
|
1700
1745
|
* @since 4.0.0
|
|
1701
1746
|
*/
|
|
@@ -1728,6 +1773,7 @@ export const decodeResult: <S extends ConstraintDecoder<unknown>>(
|
|
|
1728
1773
|
*
|
|
1729
1774
|
* @see {@link SchemaParser.decodeUnknownPromise} for the adapter that rejects with an `Error` whose cause is `SchemaIssue.Issue`
|
|
1730
1775
|
*
|
|
1776
|
+
* @stability stable
|
|
1731
1777
|
* @category decoding
|
|
1732
1778
|
* @since 3.10.0
|
|
1733
1779
|
*/
|
|
@@ -1764,6 +1810,7 @@ export function decodeUnknownPromise<S extends ConstraintDecoder<unknown>>(
|
|
|
1764
1810
|
*
|
|
1765
1811
|
* @see {@link SchemaParser.decodePromise} for the adapter that rejects with an `Error` whose cause is `SchemaIssue.Issue`
|
|
1766
1812
|
*
|
|
1813
|
+
* @stability stable
|
|
1767
1814
|
* @category decoding
|
|
1768
1815
|
* @since 3.10.0
|
|
1769
1816
|
*/
|
|
@@ -1805,6 +1852,7 @@ export const decodePromise: <S extends ConstraintDecoder<unknown>>(
|
|
|
1805
1852
|
*
|
|
1806
1853
|
* @see {@link SchemaParser.decodeUnknownSync} for the adapter that throws an `Error` whose cause is `SchemaIssue.Issue`
|
|
1807
1854
|
*
|
|
1855
|
+
* @stability stable
|
|
1808
1856
|
* @category decoding
|
|
1809
1857
|
* @since 4.0.0
|
|
1810
1858
|
*/
|
|
@@ -1837,6 +1885,7 @@ export function decodeUnknownSync<S extends ConstraintDecoder<unknown>>(schema:
|
|
|
1837
1885
|
*
|
|
1838
1886
|
* @see {@link SchemaParser.decodeSync} for the adapter that throws an `Error` whose cause is `SchemaIssue.Issue`
|
|
1839
1887
|
*
|
|
1888
|
+
* @stability stable
|
|
1840
1889
|
* @category decoding
|
|
1841
1890
|
* @since 4.0.0
|
|
1842
1891
|
*/
|
|
@@ -1872,6 +1921,7 @@ export const decodeSync: <S extends ConstraintDecoder<unknown>>(
|
|
|
1872
1921
|
*
|
|
1873
1922
|
* @see {@link SchemaParser.encodeUnknownEffect} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1874
1923
|
*
|
|
1924
|
+
* @stability stable
|
|
1875
1925
|
* @category encoding
|
|
1876
1926
|
* @since 4.0.0
|
|
1877
1927
|
*/
|
|
@@ -1902,6 +1952,7 @@ export function encodeUnknownEffect<S extends Constraint>(schema: S, options?: S
|
|
|
1902
1952
|
*
|
|
1903
1953
|
* @see {@link SchemaParser.encodeEffect} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
1904
1954
|
*
|
|
1955
|
+
* @stability stable
|
|
1905
1956
|
* @category encoding
|
|
1906
1957
|
* @since 4.0.0
|
|
1907
1958
|
*/
|
|
@@ -1938,6 +1989,7 @@ export const encodeEffect: <S extends Constraint>(
|
|
|
1938
1989
|
*
|
|
1939
1990
|
* @see {@link SchemaParser.encodeUnknownExit} for the adapter whose failure contains `SchemaIssue.Issue` directly
|
|
1940
1991
|
*
|
|
1992
|
+
* @stability stable
|
|
1941
1993
|
* @category encoding
|
|
1942
1994
|
* @since 4.0.0
|
|
1943
1995
|
*/
|
|
@@ -1974,6 +2026,7 @@ export function encodeUnknownExit<S extends ConstraintEncoder<unknown>>(schema:
|
|
|
1974
2026
|
*
|
|
1975
2027
|
* @see {@link SchemaParser.encodeExit} for the adapter whose failure contains `SchemaIssue.Issue` directly
|
|
1976
2028
|
*
|
|
2029
|
+
* @stability stable
|
|
1977
2030
|
* @category encoding
|
|
1978
2031
|
* @since 4.0.0
|
|
1979
2032
|
*/
|
|
@@ -2004,6 +2057,7 @@ export const encodeExit: <S extends ConstraintEncoder<unknown>>(
|
|
|
2004
2057
|
* that contain defects, interruptions, or other non-schema reasons throw
|
|
2005
2058
|
* instead.
|
|
2006
2059
|
*
|
|
2060
|
+
* @stability stable
|
|
2007
2061
|
* @category encoding
|
|
2008
2062
|
* @since 3.10.0
|
|
2009
2063
|
*/
|
|
@@ -2034,6 +2088,7 @@ export const encodeUnknownOption: <S extends ConstraintEncoder<unknown>>(
|
|
|
2034
2088
|
* that contain defects, interruptions, or other non-schema reasons throw
|
|
2035
2089
|
* instead.
|
|
2036
2090
|
*
|
|
2091
|
+
* @stability stable
|
|
2037
2092
|
* @category encoding
|
|
2038
2093
|
* @since 3.10.0
|
|
2039
2094
|
*/
|
|
@@ -2066,6 +2121,7 @@ export const encodeOption: <S extends ConstraintEncoder<unknown>>(
|
|
|
2066
2121
|
*
|
|
2067
2122
|
* @see {@link SchemaParser.encodeUnknownResult} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
2068
2123
|
*
|
|
2124
|
+
* @stability stable
|
|
2069
2125
|
* @category encoding
|
|
2070
2126
|
* @since 4.0.0
|
|
2071
2127
|
*/
|
|
@@ -2100,6 +2156,7 @@ export function encodeUnknownResult<S extends ConstraintEncoder<unknown>>(schema
|
|
|
2100
2156
|
*
|
|
2101
2157
|
* @see {@link SchemaParser.encodeResult} for the adapter that fails with `SchemaIssue.Issue` directly
|
|
2102
2158
|
*
|
|
2159
|
+
* @stability stable
|
|
2103
2160
|
* @category encoding
|
|
2104
2161
|
* @since 4.0.0
|
|
2105
2162
|
*/
|
|
@@ -2131,6 +2188,7 @@ export const encodeResult: <S extends ConstraintEncoder<unknown>>(
|
|
|
2131
2188
|
*
|
|
2132
2189
|
* @see {@link SchemaParser.encodeUnknownPromise} for the adapter that rejects with an `Error` whose cause is `SchemaIssue.Issue`
|
|
2133
2190
|
*
|
|
2191
|
+
* @stability stable
|
|
2134
2192
|
* @category encoding
|
|
2135
2193
|
* @since 3.10.0
|
|
2136
2194
|
*/
|
|
@@ -2167,6 +2225,7 @@ export function encodeUnknownPromise<S extends ConstraintEncoder<unknown>>(
|
|
|
2167
2225
|
*
|
|
2168
2226
|
* @see {@link SchemaParser.encodePromise} for the adapter that rejects with an `Error` whose cause is `SchemaIssue.Issue`
|
|
2169
2227
|
*
|
|
2228
|
+
* @stability stable
|
|
2170
2229
|
* @category encoding
|
|
2171
2230
|
* @since 3.10.0
|
|
2172
2231
|
*/
|
|
@@ -2197,6 +2256,7 @@ export const encodePromise: <S extends ConstraintEncoder<unknown>>(
|
|
|
2197
2256
|
*
|
|
2198
2257
|
* @see {@link SchemaParser.encodeUnknownSync} for the adapter that throws an `Error` whose cause is `SchemaIssue.Issue`
|
|
2199
2258
|
*
|
|
2259
|
+
* @stability stable
|
|
2200
2260
|
* @category encoding
|
|
2201
2261
|
* @since 4.0.0
|
|
2202
2262
|
*/
|
|
@@ -2227,6 +2287,7 @@ export function encodeUnknownSync<S extends ConstraintEncoder<unknown>>(schema:
|
|
|
2227
2287
|
*
|
|
2228
2288
|
* @see {@link SchemaParser.encodeSync} for the adapter that throws an `Error` whose cause is `SchemaIssue.Issue`
|
|
2229
2289
|
*
|
|
2290
|
+
* @stability stable
|
|
2230
2291
|
* @category encoding
|
|
2231
2292
|
* @since 4.0.0
|
|
2232
2293
|
*/
|
|
@@ -2248,6 +2309,7 @@ export const encodeSync: <S extends ConstraintEncoder<unknown>>(
|
|
|
2248
2309
|
* the bridge between the untyped AST representation and the strongly-typed
|
|
2249
2310
|
* schema.
|
|
2250
2311
|
*
|
|
2312
|
+
* @stability stable
|
|
2251
2313
|
* @category constructors
|
|
2252
2314
|
* @since 3.10.0
|
|
2253
2315
|
*/
|
|
@@ -2255,6 +2317,7 @@ export const make: <S extends Constraint>(ast: S["ast"], options?: object) => S
|
|
|
2255
2317
|
/**
|
|
2256
2318
|
* Checks whether a value is a `Schema`.
|
|
2257
2319
|
*
|
|
2320
|
+
* @stability stable
|
|
2258
2321
|
* @category guards
|
|
2259
2322
|
* @since 3.10.0
|
|
2260
2323
|
*/
|
|
@@ -2264,6 +2327,7 @@ export function isSchema(u: unknown): u is Top {
|
|
|
2264
2327
|
/**
|
|
2265
2328
|
* Type-level representation returned by {@link optionalKey}.
|
|
2266
2329
|
*
|
|
2330
|
+
* @stability stable
|
|
2267
2331
|
* @category models
|
|
2268
2332
|
* @since 4.0.0
|
|
2269
2333
|
*/
|
|
@@ -2311,6 +2375,7 @@ interface optionalKeyLambda extends Lambda {
|
|
|
2311
2375
|
* type Person = typeof schema["Type"]
|
|
2312
2376
|
* ```
|
|
2313
2377
|
*
|
|
2378
|
+
* @stability stable
|
|
2314
2379
|
* @category combinators
|
|
2315
2380
|
* @since 4.0.0
|
|
2316
2381
|
*/
|
|
@@ -2330,6 +2395,7 @@ interface requiredKeyLambda extends Lambda {
|
|
|
2330
2395
|
* Use to remove optional-key wrapping from a schema field that was previously
|
|
2331
2396
|
* wrapped with {@link optionalKey}.
|
|
2332
2397
|
*
|
|
2398
|
+
* @stability stable
|
|
2333
2399
|
* @category combinators
|
|
2334
2400
|
* @since 4.0.0
|
|
2335
2401
|
*/
|
|
@@ -2337,6 +2403,7 @@ export const requiredKey: requiredKeyLambda = Struct_.lambda<requiredKeyLambda>(
|
|
|
2337
2403
|
/**
|
|
2338
2404
|
* Type-level representation returned by {@link optional}.
|
|
2339
2405
|
*
|
|
2406
|
+
* @stability stable
|
|
2340
2407
|
* @category models
|
|
2341
2408
|
* @since 3.10.0
|
|
2342
2409
|
*/
|
|
@@ -2373,6 +2440,7 @@ interface optionalLambda extends Lambda {
|
|
|
2373
2440
|
* type Person = typeof schema.Type
|
|
2374
2441
|
* ```
|
|
2375
2442
|
*
|
|
2443
|
+
* @stability stable
|
|
2376
2444
|
* @category combinators
|
|
2377
2445
|
* @since 3.10.0
|
|
2378
2446
|
*/
|
|
@@ -2397,6 +2465,7 @@ interface requiredLambda extends Lambda {
|
|
|
2397
2465
|
*
|
|
2398
2466
|
* This also unwraps the `UndefinedOr` member added by `optional`.
|
|
2399
2467
|
*
|
|
2468
|
+
* @stability stable
|
|
2400
2469
|
* @category combinators
|
|
2401
2470
|
* @since 3.10.0
|
|
2402
2471
|
*/
|
|
@@ -2404,6 +2473,7 @@ export const required: requiredLambda = Struct_.lambda<requiredLambda>((self) =>
|
|
|
2404
2473
|
/**
|
|
2405
2474
|
* Type-level representation returned by {@link mutableKey}.
|
|
2406
2475
|
*
|
|
2476
|
+
* @stability stable
|
|
2407
2477
|
* @category models
|
|
2408
2478
|
* @since 4.0.0
|
|
2409
2479
|
*/
|
|
@@ -2436,6 +2506,7 @@ interface mutableKeyLambda extends Lambda {
|
|
|
2436
2506
|
* Makes a struct field mutable (removes the `readonly` modifier on the property).
|
|
2437
2507
|
* Use {@link readonlyKey} to reverse.
|
|
2438
2508
|
*
|
|
2509
|
+
* @stability stable
|
|
2439
2510
|
* @category combinators
|
|
2440
2511
|
* @since 4.0.0
|
|
2441
2512
|
*/
|
|
@@ -2455,6 +2526,7 @@ interface readonlyKeyLambda extends Lambda {
|
|
|
2455
2526
|
* Use to remove mutable-key wrapping from a schema field that was previously
|
|
2456
2527
|
* wrapped with {@link mutableKey}.
|
|
2457
2528
|
*
|
|
2529
|
+
* @stability stable
|
|
2458
2530
|
* @category combinators
|
|
2459
2531
|
* @since 4.0.0
|
|
2460
2532
|
*/
|
|
@@ -2462,6 +2534,7 @@ export const readonlyKey: readonlyKeyLambda = Struct_.lambda<readonlyKeyLambda>(
|
|
|
2462
2534
|
/**
|
|
2463
2535
|
* Type-level representation returned by {@link toType}.
|
|
2464
2536
|
*
|
|
2537
|
+
* @stability stable
|
|
2465
2538
|
* @category transforming
|
|
2466
2539
|
* @since 4.0.0
|
|
2467
2540
|
*/
|
|
@@ -2494,6 +2567,7 @@ interface toTypeLambda extends Lambda {
|
|
|
2494
2567
|
* Extracts the type-side schema: sets `Encoded` to equal the decoded `Type`,
|
|
2495
2568
|
* discarding the encoding transformation path.
|
|
2496
2569
|
*
|
|
2570
|
+
* @stability stable
|
|
2497
2571
|
* @category transforming
|
|
2498
2572
|
* @since 4.0.0
|
|
2499
2573
|
*/
|
|
@@ -2503,6 +2577,7 @@ export const toType: toTypeLambda = Struct_.lambda<toTypeLambda>((schema) =>
|
|
|
2503
2577
|
/**
|
|
2504
2578
|
* Type-level representation returned by {@link toEncoded}.
|
|
2505
2579
|
*
|
|
2580
|
+
* @stability stable
|
|
2506
2581
|
* @category transforming
|
|
2507
2582
|
* @since 4.0.0
|
|
2508
2583
|
*/
|
|
@@ -2535,6 +2610,7 @@ interface toEncodedLambda extends Lambda {
|
|
|
2535
2610
|
* Extracts the encoded-side schema: sets `Type` to equal the `Encoded`,
|
|
2536
2611
|
* discarding the decoding transformation path.
|
|
2537
2612
|
*
|
|
2613
|
+
* @stability stable
|
|
2538
2614
|
* @category transforming
|
|
2539
2615
|
* @since 4.0.0
|
|
2540
2616
|
*/
|
|
@@ -2545,6 +2621,7 @@ const FlipTypeId = "~effect/Schema/flip"
|
|
|
2545
2621
|
/**
|
|
2546
2622
|
* Type-level representation returned by {@link flip}.
|
|
2547
2623
|
*
|
|
2624
|
+
* @stability stable
|
|
2548
2625
|
* @category transforming
|
|
2549
2626
|
* @since 4.0.0
|
|
2550
2627
|
*/
|
|
@@ -2595,6 +2672,7 @@ function isFlip$(schema: Top): schema is flip<any> {
|
|
|
2595
2672
|
* Schema.decodeSync(flipped)(42) // => "42"
|
|
2596
2673
|
* ```
|
|
2597
2674
|
*
|
|
2675
|
+
* @stability stable
|
|
2598
2676
|
* @category transforming
|
|
2599
2677
|
* @since 4.0.0
|
|
2600
2678
|
*/
|
|
@@ -2608,6 +2686,7 @@ export function flip<S extends Top>(schema: S): flip<S> {
|
|
|
2608
2686
|
/**
|
|
2609
2687
|
* Type-level representation returned by {@link Literal}.
|
|
2610
2688
|
*
|
|
2689
|
+
* @stability stable
|
|
2611
2690
|
* @category models
|
|
2612
2691
|
* @since 3.10.0
|
|
2613
2692
|
*/
|
|
@@ -2633,6 +2712,7 @@ export interface Literal<L extends SchemaAST.LiteralValue>
|
|
|
2633
2712
|
* @see {@link Literals} for a schema that represents a union of literals.
|
|
2634
2713
|
* @see {@link tag} for a schema that represents a literal value that can be
|
|
2635
2714
|
* used as a discriminator field in tagged unions and has a constructor default.
|
|
2715
|
+
* @stability stable
|
|
2636
2716
|
* @category constructors
|
|
2637
2717
|
* @since 3.10.0
|
|
2638
2718
|
*/
|
|
@@ -2651,6 +2731,7 @@ export function Literal<L extends SchemaAST.LiteralValue>(literal: L): Literal<L
|
|
|
2651
2731
|
/**
|
|
2652
2732
|
* Namespace for {@link TemplateLiteral} helper types.
|
|
2653
2733
|
*
|
|
2734
|
+
* @stability stable
|
|
2654
2735
|
* @since 3.10.0
|
|
2655
2736
|
*/
|
|
2656
2737
|
export declare namespace TemplateLiteral {
|
|
@@ -2708,6 +2789,7 @@ export declare namespace TemplateLiteral {
|
|
|
2708
2789
|
/**
|
|
2709
2790
|
* Type-level representation returned by {@link TemplateLiteral}.
|
|
2710
2791
|
*
|
|
2792
|
+
* @stability stable
|
|
2711
2793
|
* @category models
|
|
2712
2794
|
* @since 3.10.0
|
|
2713
2795
|
*/
|
|
@@ -2759,6 +2841,7 @@ function templateLiteralParts(parts: TemplateLiteral.Parts) {
|
|
|
2759
2841
|
* ```
|
|
2760
2842
|
*
|
|
2761
2843
|
* @see {@link TemplateLiteralParser} for a schema that also parses matched parts into a tuple.
|
|
2844
|
+
* @stability stable
|
|
2762
2845
|
* @category constructors
|
|
2763
2846
|
* @since 3.10.0
|
|
2764
2847
|
*/
|
|
@@ -2768,6 +2851,7 @@ export function TemplateLiteral<const Parts extends TemplateLiteral.Parts>(parts
|
|
|
2768
2851
|
/**
|
|
2769
2852
|
* Namespace for {@link TemplateLiteralParser} helper types.
|
|
2770
2853
|
*
|
|
2854
|
+
* @stability stable
|
|
2771
2855
|
* @since 3.10.0
|
|
2772
2856
|
*/
|
|
2773
2857
|
export declare namespace TemplateLiteralParser {
|
|
@@ -2791,6 +2875,7 @@ export declare namespace TemplateLiteralParser {
|
|
|
2791
2875
|
/**
|
|
2792
2876
|
* Type-level representation returned by {@link TemplateLiteralParser}.
|
|
2793
2877
|
*
|
|
2878
|
+
* @stability stable
|
|
2794
2879
|
* @category models
|
|
2795
2880
|
* @since 3.10.0
|
|
2796
2881
|
*/
|
|
@@ -2841,6 +2926,7 @@ export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> exte
|
|
|
2841
2926
|
* ```
|
|
2842
2927
|
*
|
|
2843
2928
|
* @see {@link TemplateLiteral} for a validation-only version that keeps the string encoded.
|
|
2929
|
+
* @stability stable
|
|
2844
2930
|
* @category constructors
|
|
2845
2931
|
* @since 3.10.0
|
|
2846
2932
|
*/
|
|
@@ -2852,6 +2938,7 @@ export function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>
|
|
|
2852
2938
|
/**
|
|
2853
2939
|
* Type-level representation returned by {@link Enum}.
|
|
2854
2940
|
*
|
|
2941
|
+
* @stability stable
|
|
2855
2942
|
* @category models
|
|
2856
2943
|
* @since 4.0.0
|
|
2857
2944
|
*/
|
|
@@ -2882,6 +2969,7 @@ export interface Enum<A extends { [x: string]: string | number }>
|
|
|
2882
2969
|
* Schema.decodeSync(schema)(Direction.Up) // => "Up"
|
|
2883
2970
|
* ```
|
|
2884
2971
|
*
|
|
2972
|
+
* @stability stable
|
|
2885
2973
|
* @category constructors
|
|
2886
2974
|
* @since 4.0.0
|
|
2887
2975
|
*/
|
|
@@ -2898,6 +2986,7 @@ export function Enum<A extends { [x: string]: string | number }>(enums: A): Enum
|
|
|
2898
2986
|
/**
|
|
2899
2987
|
* Type-level representation of {@link Never}.
|
|
2900
2988
|
*
|
|
2989
|
+
* @stability stable
|
|
2901
2990
|
* @category models
|
|
2902
2991
|
* @since 3.10.0
|
|
2903
2992
|
*/
|
|
@@ -2905,6 +2994,7 @@ export interface Never extends Bottom<never, never, never, never, SchemaAST.Neve
|
|
|
2905
2994
|
/**
|
|
2906
2995
|
* Schema for the `never` type. Always fails validation — no value satisfies it.
|
|
2907
2996
|
*
|
|
2997
|
+
* @stability stable
|
|
2908
2998
|
* @category schemas
|
|
2909
2999
|
* @since 3.10.0
|
|
2910
3000
|
*/
|
|
@@ -2912,6 +3002,7 @@ export const Never: Never = make(SchemaAST.never)
|
|
|
2912
3002
|
/**
|
|
2913
3003
|
* Type-level representation of {@link Any}.
|
|
2914
3004
|
*
|
|
3005
|
+
* @stability stable
|
|
2915
3006
|
* @category models
|
|
2916
3007
|
* @since 3.10.0
|
|
2917
3008
|
*/
|
|
@@ -2920,6 +3011,7 @@ export interface Any extends Bottom<any, any, never, never, SchemaAST.Any, Any>
|
|
|
2920
3011
|
* Schema for the `any` type. Accepts any value without validation.
|
|
2921
3012
|
*
|
|
2922
3013
|
* @see {@link Unknown} for a safer alternative that uses `unknown`.
|
|
3014
|
+
* @stability stable
|
|
2923
3015
|
* @category schemas
|
|
2924
3016
|
* @since 3.10.0
|
|
2925
3017
|
*/
|
|
@@ -2927,6 +3019,7 @@ export const Any: Any = make(SchemaAST.any)
|
|
|
2927
3019
|
/**
|
|
2928
3020
|
* Type-level representation of {@link Unknown}.
|
|
2929
3021
|
*
|
|
3022
|
+
* @stability stable
|
|
2930
3023
|
* @category models
|
|
2931
3024
|
* @since 3.10.0
|
|
2932
3025
|
*/
|
|
@@ -2940,6 +3033,7 @@ export interface Unknown extends Bottom<unknown, unknown, never, never, SchemaAS
|
|
|
2940
3033
|
* TypeScript's `unknown` safety at use sites.
|
|
2941
3034
|
*
|
|
2942
3035
|
* @see {@link Any} for the `any` variant.
|
|
3036
|
+
* @stability stable
|
|
2943
3037
|
* @category schemas
|
|
2944
3038
|
* @since 3.10.0
|
|
2945
3039
|
*/
|
|
@@ -2947,6 +3041,7 @@ export const Unknown: Unknown = make(SchemaAST.unknown)
|
|
|
2947
3041
|
/**
|
|
2948
3042
|
* Type-level representation of {@link Null}.
|
|
2949
3043
|
*
|
|
3044
|
+
* @stability stable
|
|
2950
3045
|
* @category models
|
|
2951
3046
|
* @since 3.10.0
|
|
2952
3047
|
*/
|
|
@@ -2955,6 +3050,7 @@ export interface Null extends Bottom<null, null, never, never, SchemaAST.Null, N
|
|
|
2955
3050
|
* Schema for the `null` literal. Validates that the input is strictly `null`.
|
|
2956
3051
|
*
|
|
2957
3052
|
* @see {@link NullOr} for a union with another schema.
|
|
3053
|
+
* @stability stable
|
|
2958
3054
|
* @category schemas
|
|
2959
3055
|
* @since 3.10.0
|
|
2960
3056
|
*/
|
|
@@ -2962,6 +3058,7 @@ export const Null: Null = make(SchemaAST.null)
|
|
|
2962
3058
|
/**
|
|
2963
3059
|
* Type-level representation of {@link Undefined}.
|
|
2964
3060
|
*
|
|
3061
|
+
* @stability stable
|
|
2965
3062
|
* @category models
|
|
2966
3063
|
* @since 3.10.0
|
|
2967
3064
|
*/
|
|
@@ -2970,6 +3067,7 @@ export interface Undefined extends Bottom<undefined, undefined, never, never, Sc
|
|
|
2970
3067
|
* Schema for the `undefined` literal. Validates that the input is strictly `undefined`.
|
|
2971
3068
|
*
|
|
2972
3069
|
* @see {@link UndefinedOr} for a union with another schema.
|
|
3070
|
+
* @stability stable
|
|
2973
3071
|
* @category schemas
|
|
2974
3072
|
* @since 3.10.0
|
|
2975
3073
|
*/
|
|
@@ -2977,6 +3075,7 @@ export const Undefined: Undefined = make(SchemaAST.undefined)
|
|
|
2977
3075
|
/**
|
|
2978
3076
|
* Type-level representation of {@link String}.
|
|
2979
3077
|
*
|
|
3078
|
+
* @stability stable
|
|
2980
3079
|
* @category models
|
|
2981
3080
|
* @since 4.0.0
|
|
2982
3081
|
*/
|
|
@@ -2984,6 +3083,7 @@ export interface String extends Bottom<string, string, never, never, SchemaAST.S
|
|
|
2984
3083
|
/**
|
|
2985
3084
|
* Schema for `string` values. Validates that the input is `typeof` `"string"`.
|
|
2986
3085
|
*
|
|
3086
|
+
* @stability stable
|
|
2987
3087
|
* @category schemas
|
|
2988
3088
|
* @since 4.0.0
|
|
2989
3089
|
*/
|
|
@@ -2992,6 +3092,7 @@ export const String: String = make(SchemaAST.string)
|
|
|
2992
3092
|
/**
|
|
2993
3093
|
* Type-level representation of {@link StringForLiteralAutocomplete}.
|
|
2994
3094
|
*
|
|
3095
|
+
* @stability stable
|
|
2995
3096
|
* @category models
|
|
2996
3097
|
* @since 4.0.0
|
|
2997
3098
|
*/
|
|
@@ -3036,6 +3137,7 @@ export interface StringForLiteralAutocomplete extends
|
|
|
3036
3137
|
*
|
|
3037
3138
|
* @see {@link String} for a schema whose type is plain `string`.
|
|
3038
3139
|
* @see {@link Literals} for the known literals to include in the union.
|
|
3140
|
+
* @stability stable
|
|
3039
3141
|
* @category schemas
|
|
3040
3142
|
* @since 4.0.0
|
|
3041
3143
|
*/
|
|
@@ -3043,6 +3145,7 @@ export const StringForLiteralAutocomplete: StringForLiteralAutocomplete = String
|
|
|
3043
3145
|
/**
|
|
3044
3146
|
* Type-level representation of {@link Number}.
|
|
3045
3147
|
*
|
|
3148
|
+
* @stability stable
|
|
3046
3149
|
* @category models
|
|
3047
3150
|
* @since 4.0.0
|
|
3048
3151
|
*/
|
|
@@ -3058,6 +3161,7 @@ export interface Number extends Bottom<number, number, never, never, SchemaAST.N
|
|
|
3058
3161
|
* - Non-finite values are serialized as strings (`"NaN"`, `"Infinity"`, `"-Infinity"`).
|
|
3059
3162
|
*
|
|
3060
3163
|
* @see {@link Finite} for a schema that excludes non-finite values.
|
|
3164
|
+
* @stability stable
|
|
3061
3165
|
* @category schemas
|
|
3062
3166
|
* @since 4.0.0
|
|
3063
3167
|
*/
|
|
@@ -3065,6 +3169,7 @@ export const Number: Number = make(SchemaAST.number)
|
|
|
3065
3169
|
/**
|
|
3066
3170
|
* Type-level representation of {@link Boolean}.
|
|
3067
3171
|
*
|
|
3172
|
+
* @stability stable
|
|
3068
3173
|
* @category models
|
|
3069
3174
|
* @since 4.0.0
|
|
3070
3175
|
*/
|
|
@@ -3078,6 +3183,7 @@ export interface Boolean extends Bottom<boolean, boolean, never, never, SchemaAS
|
|
|
3078
3183
|
*
|
|
3079
3184
|
* @see {@link BooleanFromBit} for a schema that decodes bit literals `0` or `1` into a boolean
|
|
3080
3185
|
*
|
|
3186
|
+
* @stability stable
|
|
3081
3187
|
* @category schemas
|
|
3082
3188
|
* @since 4.0.0
|
|
3083
3189
|
*/
|
|
@@ -3085,6 +3191,7 @@ export const Boolean: Boolean = make(SchemaAST.boolean)
|
|
|
3085
3191
|
/**
|
|
3086
3192
|
* Type-level representation of {@link Symbol}.
|
|
3087
3193
|
*
|
|
3194
|
+
* @stability stable
|
|
3088
3195
|
* @category models
|
|
3089
3196
|
* @since 4.0.0
|
|
3090
3197
|
*/
|
|
@@ -3093,6 +3200,7 @@ export interface Symbol extends Bottom<symbol, symbol, never, never, SchemaAST.S
|
|
|
3093
3200
|
* Schema for `symbol` values. Validates that the input is `typeof` `"symbol"`.
|
|
3094
3201
|
*
|
|
3095
3202
|
* @see {@link UniqueSymbol} for a schema that matches a specific symbol.
|
|
3203
|
+
* @stability stable
|
|
3096
3204
|
* @category schemas
|
|
3097
3205
|
* @since 4.0.0
|
|
3098
3206
|
*/
|
|
@@ -3100,6 +3208,7 @@ export const Symbol: Symbol = make(SchemaAST.symbol)
|
|
|
3100
3208
|
/**
|
|
3101
3209
|
* Type-level representation of {@link BigInt}.
|
|
3102
3210
|
*
|
|
3211
|
+
* @stability stable
|
|
3103
3212
|
* @category models
|
|
3104
3213
|
* @since 4.0.0
|
|
3105
3214
|
*/
|
|
@@ -3114,6 +3223,7 @@ export interface BigInt extends Bottom<bigint, bigint, never, never, SchemaAST.B
|
|
|
3114
3223
|
*
|
|
3115
3224
|
* @see {@link BigIntFromString} for parsing string input into a bigint
|
|
3116
3225
|
*
|
|
3226
|
+
* @stability stable
|
|
3117
3227
|
* @category schemas
|
|
3118
3228
|
* @since 4.0.0
|
|
3119
3229
|
*/
|
|
@@ -3121,6 +3231,7 @@ export const BigInt: BigInt = make(SchemaAST.bigInt)
|
|
|
3121
3231
|
/**
|
|
3122
3232
|
* Type-level representation of {@link Void}.
|
|
3123
3233
|
*
|
|
3234
|
+
* @stability stable
|
|
3124
3235
|
* @category models
|
|
3125
3236
|
* @since 3.10.0
|
|
3126
3237
|
*/
|
|
@@ -3141,6 +3252,7 @@ export interface Void extends Bottom<void, void, never, never, SchemaAST.Void, V
|
|
|
3141
3252
|
* as `void`.
|
|
3142
3253
|
*
|
|
3143
3254
|
* @see {@link Undefined} for a schema that matches only the exact `undefined` value.
|
|
3255
|
+
* @stability stable
|
|
3144
3256
|
* @category schemas
|
|
3145
3257
|
* @since 3.10.0
|
|
3146
3258
|
*/
|
|
@@ -3148,6 +3260,7 @@ export const Void: Void = make(SchemaAST.void)
|
|
|
3148
3260
|
/**
|
|
3149
3261
|
* Type-level representation of {@link ObjectKeyword}.
|
|
3150
3262
|
*
|
|
3263
|
+
* @stability stable
|
|
3151
3264
|
* @category models
|
|
3152
3265
|
* @since 4.0.0
|
|
3153
3266
|
*/
|
|
@@ -3156,6 +3269,7 @@ export interface ObjectKeyword extends Bottom<object, object, never, never, Sche
|
|
|
3156
3269
|
* Schema for the `object` type. Validates that the input is a non-null object or function
|
|
3157
3270
|
* (i.e. `typeof value === "object" && value !== null || typeof value === "function"`).
|
|
3158
3271
|
*
|
|
3272
|
+
* @stability stable
|
|
3159
3273
|
* @category schemas
|
|
3160
3274
|
* @since 4.0.0
|
|
3161
3275
|
*/
|
|
@@ -3163,6 +3277,7 @@ export const ObjectKeyword: ObjectKeyword = make(SchemaAST.objectKeyword)
|
|
|
3163
3277
|
/**
|
|
3164
3278
|
* Type-level representation returned by {@link UniqueSymbol}.
|
|
3165
3279
|
*
|
|
3280
|
+
* @stability stable
|
|
3166
3281
|
* @category models
|
|
3167
3282
|
* @since 4.0.0
|
|
3168
3283
|
*/
|
|
@@ -3189,6 +3304,7 @@ export interface UniqueSymbol<sym extends symbol>
|
|
|
3189
3304
|
* ```
|
|
3190
3305
|
*
|
|
3191
3306
|
* @see {@link Symbol} for a schema that accepts any symbol.
|
|
3307
|
+
* @stability stable
|
|
3192
3308
|
* @category constructors
|
|
3193
3309
|
* @since 4.0.0
|
|
3194
3310
|
*/
|
|
@@ -3210,6 +3326,7 @@ export function UniqueSymbol<const sym extends symbol>(symbol: sym): UniqueSymbo
|
|
|
3210
3326
|
* - `Struct.MakeIn<F>` — constructor input (optional/defaulted fields may be omitted)
|
|
3211
3327
|
* - `Struct.DecodingServices<F>` / `Struct.EncodingServices<F>` — required services
|
|
3212
3328
|
*
|
|
3329
|
+
* @stability stable
|
|
3213
3330
|
* @since 3.10.0
|
|
3214
3331
|
*/
|
|
3215
3332
|
export declare namespace Struct {
|
|
@@ -3344,6 +3461,7 @@ export declare namespace Struct {
|
|
|
3344
3461
|
/**
|
|
3345
3462
|
* Type-level representation returned by {@link Struct}.
|
|
3346
3463
|
*
|
|
3464
|
+
* @stability stable
|
|
3347
3465
|
* @category models
|
|
3348
3466
|
* @since 3.10.0
|
|
3349
3467
|
*/
|
|
@@ -3448,6 +3566,7 @@ function makeStruct<const Fields extends Struct.Fields>(ast: SchemaAST.Objects,
|
|
|
3448
3566
|
* Schema.decodeUnknownSync(Person)({ name: "Alice", age: 30 }) // => { name: "Alice", age: 30 }
|
|
3449
3567
|
* ```
|
|
3450
3568
|
*
|
|
3569
|
+
* @stability stable
|
|
3451
3570
|
* @category constructors
|
|
3452
3571
|
* @since 3.10.0
|
|
3453
3572
|
*/
|
|
@@ -3487,6 +3606,7 @@ interface fieldsAssign<NewFields extends Struct.Fields> extends Lambda {
|
|
|
3487
3606
|
* Schema.decodeSync(schema)({ a: "a", c: 1 }) // => { a: "a", c: 1 }
|
|
3488
3607
|
* ```
|
|
3489
3608
|
*
|
|
3609
|
+
* @stability stable
|
|
3490
3610
|
* @category combinators
|
|
3491
3611
|
* @since 4.0.0
|
|
3492
3612
|
*/
|
|
@@ -3496,6 +3616,7 @@ export function fieldsAssign<const NewFields extends Struct.Fields>(fields: NewF
|
|
|
3496
3616
|
/**
|
|
3497
3617
|
* Type-level representation returned by {@link encodeKeys}.
|
|
3498
3618
|
*
|
|
3619
|
+
* @stability stable
|
|
3499
3620
|
* @category transforming
|
|
3500
3621
|
* @since 4.0.0
|
|
3501
3622
|
*/
|
|
@@ -3540,6 +3661,7 @@ const canonicalPropertyKey = (key: PropertyKey): string | symbol =>
|
|
|
3540
3661
|
* Schema.decodeUnknownSync(Encoded)({ full_name: "Alice", age: 30 }) // => { name: "Alice", age: 30 }
|
|
3541
3662
|
* ```
|
|
3542
3663
|
*
|
|
3664
|
+
* @stability stable
|
|
3543
3665
|
* @category transforming
|
|
3544
3666
|
* @since 4.0.0
|
|
3545
3667
|
*/
|
|
@@ -3603,6 +3725,7 @@ export function encodeKeys<
|
|
|
3603
3725
|
* alice.fullName // => "Alice Smith"
|
|
3604
3726
|
* ```
|
|
3605
3727
|
*
|
|
3728
|
+
* @stability stable
|
|
3606
3729
|
* @category transforming
|
|
3607
3730
|
* @since 4.0.0
|
|
3608
3731
|
*/
|
|
@@ -3649,6 +3772,7 @@ export function extendTo<S extends Struct<Struct.Fields>, const Fields extends S
|
|
|
3649
3772
|
* - `Record.Type<K, V>` — decoded type of the record
|
|
3650
3773
|
* - `Record.Encoded<K, V>` — encoded type of the record
|
|
3651
3774
|
*
|
|
3775
|
+
* @stability stable
|
|
3652
3776
|
* @since 3.10.0
|
|
3653
3777
|
*/
|
|
3654
3778
|
export declare namespace Record {
|
|
@@ -3807,6 +3931,7 @@ export declare namespace Record {
|
|
|
3807
3931
|
/**
|
|
3808
3932
|
* Type-level representation returned by {@link Record}.
|
|
3809
3933
|
*
|
|
3934
|
+
* @stability stable
|
|
3810
3935
|
* @category models
|
|
3811
3936
|
* @since 4.0.0
|
|
3812
3937
|
*/
|
|
@@ -3861,6 +3986,7 @@ export interface $Record<Key extends Record.Key, Value extends Constraint> exten
|
|
|
3861
3986
|
* Schema.decodeUnknownSync(schema)({ a: 1, b: 2 }) // => { a: 1, b: 2 }
|
|
3862
3987
|
* ```
|
|
3863
3988
|
*
|
|
3989
|
+
* @stability stable
|
|
3864
3990
|
* @category constructors
|
|
3865
3991
|
* @since 3.10.0
|
|
3866
3992
|
*/
|
|
@@ -3878,6 +4004,7 @@ export function Record<Key extends Record.Key, Value extends Constraint>(
|
|
|
3878
4004
|
* - `StructWithRest.Type<S, R>` — decoded type (struct type intersected with record types)
|
|
3879
4005
|
* - `StructWithRest.Encoded<S, R>` — encoded type
|
|
3880
4006
|
*
|
|
4007
|
+
* @stability stable
|
|
3881
4008
|
* @since 4.0.0
|
|
3882
4009
|
*/
|
|
3883
4010
|
export declare namespace StructWithRest {
|
|
@@ -4030,6 +4157,7 @@ export declare namespace StructWithRest {
|
|
|
4030
4157
|
/**
|
|
4031
4158
|
* Type-level representation returned by {@link StructWithRest}.
|
|
4032
4159
|
*
|
|
4160
|
+
* @stability stable
|
|
4033
4161
|
* @category models
|
|
4034
4162
|
* @since 4.0.0
|
|
4035
4163
|
*/
|
|
@@ -4077,6 +4205,7 @@ export interface StructWithRest<
|
|
|
4077
4205
|
* type T = typeof schema.Type
|
|
4078
4206
|
* ```
|
|
4079
4207
|
*
|
|
4208
|
+
* @stability stable
|
|
4080
4209
|
* @category constructors
|
|
4081
4210
|
* @since 4.0.0
|
|
4082
4211
|
*/
|
|
@@ -4099,6 +4228,7 @@ export function StructWithRest<
|
|
|
4099
4228
|
* - `Tuple.Encoded<E>` — encoded tuple type
|
|
4100
4229
|
* - `Tuple.MakeIn<E>` — constructor input tuple
|
|
4101
4230
|
*
|
|
4231
|
+
* @stability stable
|
|
4102
4232
|
* @since 3.10.0
|
|
4103
4233
|
*/
|
|
4104
4234
|
export declare namespace Tuple {
|
|
@@ -4212,6 +4342,7 @@ export declare namespace Tuple {
|
|
|
4212
4342
|
/**
|
|
4213
4343
|
* Type-level representation returned by {@link Tuple}.
|
|
4214
4344
|
*
|
|
4345
|
+
* @stability stable
|
|
4215
4346
|
* @category models
|
|
4216
4347
|
* @since 3.10.0
|
|
4217
4348
|
*/
|
|
@@ -4281,6 +4412,7 @@ function makeTuple<Elements extends Tuple.Elements>(ast: SchemaAST.Arrays, eleme
|
|
|
4281
4412
|
* Schema.decodeUnknownSync(schema)(["hello", 42]) // => ["hello", 42]
|
|
4282
4413
|
* ```
|
|
4283
4414
|
*
|
|
4415
|
+
* @stability stable
|
|
4284
4416
|
* @category constructors
|
|
4285
4417
|
* @since 3.10.0
|
|
4286
4418
|
*/
|
|
@@ -4297,6 +4429,7 @@ export function Tuple<const Elements extends ReadonlyArray<Constraint>>(elements
|
|
|
4297
4429
|
* - `TupleWithRest.Type<T, R>` — decoded type (fixed elements + rest)
|
|
4298
4430
|
* - `TupleWithRest.Encoded<T, R>` — encoded type
|
|
4299
4431
|
*
|
|
4432
|
+
* @stability stable
|
|
4300
4433
|
* @since 4.0.0
|
|
4301
4434
|
*/
|
|
4302
4435
|
export declare namespace TupleWithRest {
|
|
@@ -4414,6 +4547,7 @@ export declare namespace TupleWithRest {
|
|
|
4414
4547
|
/**
|
|
4415
4548
|
* Type-level representation returned by {@link TupleWithRest}.
|
|
4416
4549
|
*
|
|
4550
|
+
* @stability stable
|
|
4417
4551
|
* @category models
|
|
4418
4552
|
* @since 4.0.0
|
|
4419
4553
|
*/
|
|
@@ -4461,6 +4595,7 @@ export interface TupleWithRest<
|
|
|
4461
4595
|
* Schema.decodeUnknownSync(schema)(["hello", 1, true, false]) // => ["hello", 1, true, false]
|
|
4462
4596
|
* ```
|
|
4463
4597
|
*
|
|
4598
|
+
* @stability stable
|
|
4464
4599
|
* @category constructors
|
|
4465
4600
|
* @since 4.0.0
|
|
4466
4601
|
*/
|
|
@@ -4473,6 +4608,7 @@ export function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extend
|
|
|
4473
4608
|
/**
|
|
4474
4609
|
* Type-level representation returned by {@link Array}.
|
|
4475
4610
|
*
|
|
4611
|
+
* @stability stable
|
|
4476
4612
|
* @category models
|
|
4477
4613
|
* @since 4.0.0
|
|
4478
4614
|
*/
|
|
@@ -4516,6 +4652,7 @@ export {
|
|
|
4516
4652
|
* Schema.decodeUnknownSync(schema)(["a", "b", "c"]) // => ["a", "b", "c"]
|
|
4517
4653
|
* ```
|
|
4518
4654
|
*
|
|
4655
|
+
* @stability stable
|
|
4519
4656
|
* @category constructors
|
|
4520
4657
|
* @since 4.0.0
|
|
4521
4658
|
*/
|
|
@@ -4538,6 +4675,7 @@ export function withArrayLengthConstraints<Item extends Constraint>(
|
|
|
4538
4675
|
/**
|
|
4539
4676
|
* Type-level representation returned by {@link NonEmptyArray}.
|
|
4540
4677
|
*
|
|
4678
|
+
* @stability stable
|
|
4541
4679
|
* @category models
|
|
4542
4680
|
* @since 3.10.0
|
|
4543
4681
|
*/
|
|
@@ -4574,6 +4712,7 @@ interface NonEmptyArrayLambda extends Lambda {
|
|
|
4574
4712
|
* Schema.decodeUnknownSync(schema)([1, 2, 3]) // => [1, 2, 3]
|
|
4575
4713
|
* ```
|
|
4576
4714
|
*
|
|
4715
|
+
* @stability stable
|
|
4577
4716
|
* @category constructors
|
|
4578
4717
|
* @since 3.10.0
|
|
4579
4718
|
*/
|
|
@@ -4583,6 +4722,7 @@ export const NonEmptyArray: NonEmptyArrayLambda = Struct_.lambda<NonEmptyArrayLa
|
|
|
4583
4722
|
/**
|
|
4584
4723
|
* Type-level representation returned by {@link ArrayEnsure}.
|
|
4585
4724
|
*
|
|
4725
|
+
* @stability stable
|
|
4586
4726
|
* @category constructors
|
|
4587
4727
|
* @since 3.10.0
|
|
4588
4728
|
*/
|
|
@@ -4612,6 +4752,7 @@ export interface ArrayEnsure<S extends Constraint> extends decodeTo<$Array<toTyp
|
|
|
4612
4752
|
* @see {@link Array} for accepting only array input
|
|
4613
4753
|
* @see {@link NonEmptyArray} for requiring at least one decoded element
|
|
4614
4754
|
*
|
|
4755
|
+
* @stability stable
|
|
4615
4756
|
* @category constructors
|
|
4616
4757
|
* @since 3.10.0
|
|
4617
4758
|
*/
|
|
@@ -4630,6 +4771,7 @@ export function ArrayEnsure<S extends Constraint>(schema: S): ArrayEnsure<S> {
|
|
|
4630
4771
|
/**
|
|
4631
4772
|
* Type-level representation returned by {@link UniqueArray}.
|
|
4632
4773
|
*
|
|
4774
|
+
* @stability stable
|
|
4633
4775
|
* @category models
|
|
4634
4776
|
* @since 4.0.0
|
|
4635
4777
|
*/
|
|
@@ -4644,6 +4786,7 @@ export interface UniqueArray<S extends Constraint> extends $Array<S> {
|
|
|
4644
4786
|
* The equivalence used to determine uniqueness is the one provided by
|
|
4645
4787
|
* `Schema.toEquivalence(item)`.
|
|
4646
4788
|
*
|
|
4789
|
+
* @stability stable
|
|
4647
4790
|
* @category constructors
|
|
4648
4791
|
* @since 4.0.0
|
|
4649
4792
|
*/
|
|
@@ -4653,6 +4796,7 @@ export function UniqueArray<S extends Constraint>(item: S): UniqueArray<S> {
|
|
|
4653
4796
|
/**
|
|
4654
4797
|
* Type-level representation returned by {@link mutable}.
|
|
4655
4798
|
*
|
|
4799
|
+
* @stability stable
|
|
4656
4800
|
* @category transforming
|
|
4657
4801
|
* @since 3.10.0
|
|
4658
4802
|
*/
|
|
@@ -4710,6 +4854,7 @@ interface mutableLambda extends Lambda {
|
|
|
4710
4854
|
* value // => [1, 2, 3]
|
|
4711
4855
|
* ```
|
|
4712
4856
|
*
|
|
4857
|
+
* @stability stable
|
|
4713
4858
|
* @category transforming
|
|
4714
4859
|
* @since 3.10.0
|
|
4715
4860
|
*/
|
|
@@ -4719,6 +4864,7 @@ export const mutable: mutableLambda = Struct_.lambda<mutableLambda>((schema) =>
|
|
|
4719
4864
|
/**
|
|
4720
4865
|
* Type-level representation returned by {@link Union}.
|
|
4721
4866
|
*
|
|
4867
|
+
* @stability stable
|
|
4722
4868
|
* @category models
|
|
4723
4869
|
* @since 3.10.0
|
|
4724
4870
|
*/
|
|
@@ -4802,6 +4948,7 @@ function makeUnion<Members extends ReadonlyArray<Constraint>>(
|
|
|
4802
4948
|
* Schema.decodeUnknownSync(schema)(42) // => 42
|
|
4803
4949
|
* ```
|
|
4804
4950
|
*
|
|
4951
|
+
* @stability stable
|
|
4805
4952
|
* @category constructors
|
|
4806
4953
|
* @since 3.10.0
|
|
4807
4954
|
*/
|
|
@@ -4814,6 +4961,7 @@ export function Union<const Members extends ReadonlyArray<Constraint>>(
|
|
|
4814
4961
|
/**
|
|
4815
4962
|
* Type-level representation returned by {@link Literals}.
|
|
4816
4963
|
*
|
|
4964
|
+
* @stability stable
|
|
4817
4965
|
* @category models
|
|
4818
4966
|
* @since 4.0.0
|
|
4819
4967
|
*/
|
|
@@ -4846,6 +4994,7 @@ export interface Literals<L extends ReadonlyArray<SchemaAST.LiteralValue>>
|
|
|
4846
4994
|
* ```
|
|
4847
4995
|
*
|
|
4848
4996
|
* @see {@link Literal} for a schema that represents a single literal.
|
|
4997
|
+
* @stability stable
|
|
4849
4998
|
* @category constructors
|
|
4850
4999
|
* @since 4.0.0
|
|
4851
5000
|
*/
|
|
@@ -4873,6 +5022,7 @@ export function Literals<const L extends ReadonlyArray<SchemaAST.LiteralValue>>(
|
|
|
4873
5022
|
/**
|
|
4874
5023
|
* Type-level representation returned by {@link NullOr}.
|
|
4875
5024
|
*
|
|
5025
|
+
* @stability stable
|
|
4876
5026
|
* @category models
|
|
4877
5027
|
* @since 3.10.0
|
|
4878
5028
|
*/
|
|
@@ -4886,6 +5036,7 @@ interface NullOrLambda extends Lambda {
|
|
|
4886
5036
|
/**
|
|
4887
5037
|
* Creates a union schema of `S | null`.
|
|
4888
5038
|
*
|
|
5039
|
+
* @stability stable
|
|
4889
5040
|
* @category constructors
|
|
4890
5041
|
* @since 3.10.0
|
|
4891
5042
|
*/
|
|
@@ -4893,6 +5044,7 @@ export const NullOr: NullOrLambda = Struct_.lambda<NullOrLambda>((self) => Union
|
|
|
4893
5044
|
/**
|
|
4894
5045
|
* Type-level representation returned by {@link UndefinedOr}.
|
|
4895
5046
|
*
|
|
5047
|
+
* @stability stable
|
|
4896
5048
|
* @category models
|
|
4897
5049
|
* @since 3.10.0
|
|
4898
5050
|
*/
|
|
@@ -4906,6 +5058,7 @@ interface UndefinedOrLambda extends Lambda {
|
|
|
4906
5058
|
/**
|
|
4907
5059
|
* Creates a union schema of `S | undefined`.
|
|
4908
5060
|
*
|
|
5061
|
+
* @stability stable
|
|
4909
5062
|
* @category constructors
|
|
4910
5063
|
* @since 3.10.0
|
|
4911
5064
|
*/
|
|
@@ -4913,6 +5066,7 @@ export const UndefinedOr: UndefinedOrLambda = Struct_.lambda<UndefinedOrLambda>(
|
|
|
4913
5066
|
/**
|
|
4914
5067
|
* Type-level representation returned by {@link NullishOr}.
|
|
4915
5068
|
*
|
|
5069
|
+
* @stability stable
|
|
4916
5070
|
* @category models
|
|
4917
5071
|
* @since 3.10.0
|
|
4918
5072
|
*/
|
|
@@ -4926,6 +5080,7 @@ interface NullishOrLambda extends Lambda {
|
|
|
4926
5080
|
/**
|
|
4927
5081
|
* Creates a union schema of `S | null | undefined`.
|
|
4928
5082
|
*
|
|
5083
|
+
* @stability stable
|
|
4929
5084
|
* @category constructors
|
|
4930
5085
|
* @since 3.10.0
|
|
4931
5086
|
*/
|
|
@@ -4933,6 +5088,7 @@ export const NullishOr: NullishOrLambda = Struct_.lambda<NullishOrLambda>((self)
|
|
|
4933
5088
|
/**
|
|
4934
5089
|
* Type-level representation returned by {@link suspend}.
|
|
4935
5090
|
*
|
|
5091
|
+
* @stability stable
|
|
4936
5092
|
* @category models
|
|
4937
5093
|
* @since 3.10.0
|
|
4938
5094
|
*/
|
|
@@ -4978,6 +5134,7 @@ export interface suspend<S extends Constraint> extends
|
|
|
4978
5134
|
* Schema.decodeSync(Tree)({ value: 1, children: [] }) // => { value: 1, children: [] }
|
|
4979
5135
|
* ```
|
|
4980
5136
|
*
|
|
5137
|
+
* @stability stable
|
|
4981
5138
|
* @category constructors
|
|
4982
5139
|
* @since 3.10.0
|
|
4983
5140
|
*/
|
|
@@ -5000,6 +5157,7 @@ export function suspend<S extends Constraint>(f: () => S): suspend<S> {
|
|
|
5000
5157
|
* Schema.is(AgeSchema)(121) // => false
|
|
5001
5158
|
* ```
|
|
5002
5159
|
*
|
|
5160
|
+
* @stability stable
|
|
5003
5161
|
* @category filtering
|
|
5004
5162
|
* @since 4.0.0
|
|
5005
5163
|
*/
|
|
@@ -5011,6 +5169,7 @@ export function check<S extends Top>(
|
|
|
5011
5169
|
/**
|
|
5012
5170
|
* Type-level representation returned by {@link refine}.
|
|
5013
5171
|
*
|
|
5172
|
+
* @stability stable
|
|
5014
5173
|
* @category filtering
|
|
5015
5174
|
* @since 3.10.0
|
|
5016
5175
|
*/
|
|
@@ -5047,6 +5206,7 @@ export interface refine<T extends S["Type"], S extends Constraint> extends
|
|
|
5047
5206
|
* names type-level failures before the refinement runs; it does not name the
|
|
5048
5207
|
* failed refinement itself.
|
|
5049
5208
|
*
|
|
5209
|
+
* @stability stable
|
|
5050
5210
|
* @category filtering
|
|
5051
5211
|
* @since 3.10.0
|
|
5052
5212
|
*/
|
|
@@ -5066,6 +5226,7 @@ type FromBrandKeys<A extends Brand.Brand<any>> = A extends unknown ? Brand.Brand
|
|
|
5066
5226
|
/**
|
|
5067
5227
|
* Type-level representation returned by {@link brand}.
|
|
5068
5228
|
*
|
|
5229
|
+
* @stability stable
|
|
5069
5230
|
* @category branding
|
|
5070
5231
|
* @since 3.10.0
|
|
5071
5232
|
*/
|
|
@@ -5112,6 +5273,7 @@ export interface brand<S extends Constraint, B extends string> extends
|
|
|
5112
5273
|
*
|
|
5113
5274
|
* @see {@link fromBrand} for applying a Brand constructor's checks along with its branded type
|
|
5114
5275
|
*
|
|
5276
|
+
* @stability stable
|
|
5115
5277
|
* @category branding
|
|
5116
5278
|
* @since 3.10.0
|
|
5117
5279
|
*/
|
|
@@ -5135,6 +5297,7 @@ export function brand<B extends string>(identifier: B & EnsureSingleBrandKey<B>)
|
|
|
5135
5297
|
*
|
|
5136
5298
|
* @see {@link brand} for adding a brand without constructor checks
|
|
5137
5299
|
*
|
|
5300
|
+
* @stability stable
|
|
5138
5301
|
* @category branding
|
|
5139
5302
|
* @since 3.10.0
|
|
5140
5303
|
*/
|
|
@@ -5152,6 +5315,7 @@ export function fromBrand<A extends Brand.Brand<any>>(
|
|
|
5152
5315
|
/**
|
|
5153
5316
|
* Type-level representation returned by {@link middlewareDecoding}.
|
|
5154
5317
|
*
|
|
5318
|
+
* @stability stable
|
|
5155
5319
|
* @category decoding
|
|
5156
5320
|
* @since 4.0.0
|
|
5157
5321
|
*/
|
|
@@ -5201,6 +5365,7 @@ export interface middlewareDecoding<S extends Constraint, RD> extends
|
|
|
5201
5365
|
* ```
|
|
5202
5366
|
*
|
|
5203
5367
|
* @see {@link catchDecoding} for a simpler error-recovery variant
|
|
5368
|
+
* @stability stable
|
|
5204
5369
|
* @category decoding
|
|
5205
5370
|
* @since 4.0.0
|
|
5206
5371
|
*/
|
|
@@ -5219,6 +5384,7 @@ export function middlewareDecoding<S extends Constraint, RD>(
|
|
|
5219
5384
|
/**
|
|
5220
5385
|
* Type-level representation returned by {@link middlewareEncoding}.
|
|
5221
5386
|
*
|
|
5387
|
+
* @stability stable
|
|
5222
5388
|
* @category encoding
|
|
5223
5389
|
* @since 4.0.0
|
|
5224
5390
|
*/
|
|
@@ -5268,6 +5434,7 @@ export interface middlewareEncoding<S extends Constraint, RE> extends
|
|
|
5268
5434
|
* ```
|
|
5269
5435
|
*
|
|
5270
5436
|
* @see {@link catchEncoding} for a simpler error-recovery variant
|
|
5437
|
+
* @stability stable
|
|
5271
5438
|
* @category encoding
|
|
5272
5439
|
* @since 4.0.0
|
|
5273
5440
|
*/
|
|
@@ -5303,6 +5470,7 @@ export function middlewareEncoding<S extends Constraint, RE>(
|
|
|
5303
5470
|
* ```
|
|
5304
5471
|
*
|
|
5305
5472
|
* @see {@link catchDecodingWithContext} to add service requirements to the handler
|
|
5473
|
+
* @stability stable
|
|
5306
5474
|
* @category error handling
|
|
5307
5475
|
* @since 4.0.0
|
|
5308
5476
|
*/
|
|
@@ -5328,6 +5496,7 @@ export function catchDecoding<S extends Constraint>(
|
|
|
5328
5496
|
* @see {@link catchDecoding} for recovery handlers that do not require services
|
|
5329
5497
|
* @see {@link middlewareDecoding} for intercepting or replacing the full decoding pipeline
|
|
5330
5498
|
*
|
|
5499
|
+
* @stability stable
|
|
5331
5500
|
* @category error handling
|
|
5332
5501
|
* @since 4.0.0
|
|
5333
5502
|
*/
|
|
@@ -5346,6 +5515,7 @@ export function catchDecodingWithContext<S extends Constraint, R = never>(
|
|
|
5346
5515
|
* succeeds with a fallback value or re-fails with a (possibly different) issue.
|
|
5347
5516
|
*
|
|
5348
5517
|
* @see {@link catchEncodingWithContext} to add service requirements to the handler
|
|
5518
|
+
* @stability stable
|
|
5349
5519
|
* @category error handling
|
|
5350
5520
|
* @since 4.0.0
|
|
5351
5521
|
*/
|
|
@@ -5371,6 +5541,7 @@ export function catchEncoding<S extends Constraint>(
|
|
|
5371
5541
|
* @see {@link catchEncoding} for recovery handlers that do not require services
|
|
5372
5542
|
* @see {@link middlewareEncoding} for intercepting or replacing the full encoding pipeline
|
|
5373
5543
|
*
|
|
5544
|
+
* @stability stable
|
|
5374
5545
|
* @category error handling
|
|
5375
5546
|
* @since 4.0.0
|
|
5376
5547
|
*/
|
|
@@ -5383,6 +5554,7 @@ export function catchEncodingWithContext<S extends Constraint, R = never>(
|
|
|
5383
5554
|
/**
|
|
5384
5555
|
* Type-level representation returned by {@link decodeTo}.
|
|
5385
5556
|
*
|
|
5557
|
+
* @stability stable
|
|
5386
5558
|
* @category transforming
|
|
5387
5559
|
* @since 4.0.0
|
|
5388
5560
|
*/
|
|
@@ -5411,6 +5583,7 @@ export interface decodeTo<To extends Constraint, From extends Constraint, RD = n
|
|
|
5411
5583
|
/**
|
|
5412
5584
|
* Type-level representation returned by {@link decodeTo} without a custom transformation.
|
|
5413
5585
|
*
|
|
5586
|
+
* @stability stable
|
|
5414
5587
|
* @category transforming
|
|
5415
5588
|
* @since 3.10.0
|
|
5416
5589
|
*/
|
|
@@ -5459,6 +5632,7 @@ export interface compose<To extends Constraint, From extends Constraint> extends
|
|
|
5459
5632
|
* Schema.decodeUnknownSync(NumberFromString)("123") // => 123
|
|
5460
5633
|
* ```
|
|
5461
5634
|
*
|
|
5635
|
+
* @stability stable
|
|
5462
5636
|
* @category transforming
|
|
5463
5637
|
* @since 4.0.0
|
|
5464
5638
|
*/
|
|
@@ -5562,6 +5736,7 @@ export const BooleanLiterals = Literals([...TrueLiterals.literals, ...FalseLiter
|
|
|
5562
5736
|
* Schema.decodeUnknownSync(Trimmed)(" hello ") // => "hello"
|
|
5563
5737
|
* ```
|
|
5564
5738
|
*
|
|
5739
|
+
* @stability stable
|
|
5565
5740
|
* @category transforming
|
|
5566
5741
|
* @since 4.0.0
|
|
5567
5742
|
*/
|
|
@@ -5600,6 +5775,7 @@ export function decode<S extends Constraint, RD = never, RE = never>(transformat
|
|
|
5600
5775
|
* Schema.decodeSync(NumberFromString)("42") // => 42
|
|
5601
5776
|
* ```
|
|
5602
5777
|
*
|
|
5778
|
+
* @stability stable
|
|
5603
5779
|
* @category transforming
|
|
5604
5780
|
* @since 4.0.0
|
|
5605
5781
|
*/
|
|
@@ -5649,6 +5825,7 @@ export function encodeTo<To extends Constraint, From extends Constraint, RD = ne
|
|
|
5649
5825
|
* Schema.encodeSync(UpperFromLower)("hello") // => "HELLO"
|
|
5650
5826
|
* ```
|
|
5651
5827
|
*
|
|
5828
|
+
* @stability stable
|
|
5652
5829
|
* @category transforming
|
|
5653
5830
|
* @since 4.0.0
|
|
5654
5831
|
*/
|
|
@@ -5667,6 +5844,7 @@ export function encode<S extends Constraint, RD = never, RE = never>(transformat
|
|
|
5667
5844
|
*
|
|
5668
5845
|
* Only schemas that satisfy this constraint can be passed to {@link withConstructorDefault}.
|
|
5669
5846
|
*
|
|
5847
|
+
* @stability stable
|
|
5670
5848
|
* @category models
|
|
5671
5849
|
* @since 4.0.0
|
|
5672
5850
|
*/
|
|
@@ -5676,6 +5854,7 @@ export interface WithoutConstructorDefault {
|
|
|
5676
5854
|
/**
|
|
5677
5855
|
* Type-level representation returned by {@link withConstructorDefault}.
|
|
5678
5856
|
*
|
|
5857
|
+
* @stability stable
|
|
5679
5858
|
* @category constructors
|
|
5680
5859
|
* @since 3.10.0
|
|
5681
5860
|
*/
|
|
@@ -5723,6 +5902,7 @@ export interface withConstructorDefault<S extends Constraint & WithoutConstructo
|
|
|
5723
5902
|
* MySchema.make({}).name // => "anonymous"
|
|
5724
5903
|
* ```
|
|
5725
5904
|
*
|
|
5905
|
+
* @stability stable
|
|
5726
5906
|
* @category constructors
|
|
5727
5907
|
* @since 3.10.0
|
|
5728
5908
|
*/
|
|
@@ -5737,6 +5917,7 @@ export function withConstructorDefault<S extends Constraint & WithoutConstructor
|
|
|
5737
5917
|
/**
|
|
5738
5918
|
* Type-level representation returned by {@link withDecodingDefaultKey}.
|
|
5739
5919
|
*
|
|
5920
|
+
* @stability stable
|
|
5740
5921
|
* @category decoding
|
|
5741
5922
|
* @since 4.0.0
|
|
5742
5923
|
*/
|
|
@@ -5754,6 +5935,7 @@ export interface withDecodingDefaultKey<S extends Constraint, R = never>
|
|
|
5754
5935
|
* - `"passthrough"` (default): pass the value through during encoding
|
|
5755
5936
|
* - `"omit"`: omit the key from the encoded output
|
|
5756
5937
|
*
|
|
5938
|
+
* @stability stable
|
|
5757
5939
|
* @category options
|
|
5758
5940
|
* @since 4.0.0
|
|
5759
5941
|
*/
|
|
@@ -5796,6 +5978,7 @@ function toIssueEffect<A, R>(
|
|
|
5796
5978
|
*
|
|
5797
5979
|
* @see {@link withDecodingDefault} for the value-level variant (key absent **or** `undefined`)
|
|
5798
5980
|
* @see {@link withDecodingDefaultTypeKey} for the variant where the default is a `Type` value
|
|
5981
|
+
* @stability stable
|
|
5799
5982
|
* @category decoding
|
|
5800
5983
|
* @since 4.0.0
|
|
5801
5984
|
*/
|
|
@@ -5814,6 +5997,7 @@ export function withDecodingDefaultKey<S extends Constraint, R = never>(
|
|
|
5814
5997
|
/**
|
|
5815
5998
|
* Type-level representation returned by {@link withDecodingDefaultTypeKey}.
|
|
5816
5999
|
*
|
|
6000
|
+
* @stability stable
|
|
5817
6001
|
* @category decoding
|
|
5818
6002
|
* @since 4.0.0
|
|
5819
6003
|
*/
|
|
@@ -5841,6 +6025,7 @@ export interface withDecodingDefaultTypeKey<S extends Constraint, R = never>
|
|
|
5841
6025
|
*
|
|
5842
6026
|
* @see {@link withDecodingDefaultKey} for the variant where the default is an `Encoded` value
|
|
5843
6027
|
* @see {@link withDecodingDefaultType} for the value-level variant
|
|
6028
|
+
* @stability stable
|
|
5844
6029
|
* @category decoding
|
|
5845
6030
|
* @since 4.0.0
|
|
5846
6031
|
*/
|
|
@@ -5858,6 +6043,7 @@ export function withDecodingDefaultTypeKey<S extends Constraint, R = never>(
|
|
|
5858
6043
|
/**
|
|
5859
6044
|
* Type-level representation returned by {@link withDecodingDefault}.
|
|
5860
6045
|
*
|
|
6046
|
+
* @stability stable
|
|
5861
6047
|
* @category decoding
|
|
5862
6048
|
* @since 3.10.0
|
|
5863
6049
|
*/
|
|
@@ -5899,6 +6085,7 @@ export interface withDecodingDefault<S extends Constraint, R = never> extends de
|
|
|
5899
6085
|
*
|
|
5900
6086
|
* @see {@link withDecodingDefaultKey} for the key-level variant (key absent only, not `undefined`)
|
|
5901
6087
|
* @see {@link withDecodingDefaultType} for the variant where the default is a `Type` value
|
|
6088
|
+
* @stability stable
|
|
5902
6089
|
* @category decoding
|
|
5903
6090
|
* @since 3.10.0
|
|
5904
6091
|
*/
|
|
@@ -5917,6 +6104,7 @@ export function withDecodingDefault<S extends Constraint, R = never>(
|
|
|
5917
6104
|
/**
|
|
5918
6105
|
* Type-level representation returned by {@link withDecodingDefaultType}.
|
|
5919
6106
|
*
|
|
6107
|
+
* @stability stable
|
|
5920
6108
|
* @category decoding
|
|
5921
6109
|
* @since 4.0.0
|
|
5922
6110
|
*/
|
|
@@ -5949,6 +6137,7 @@ export interface withDecodingDefaultType<S extends Constraint, R = never>
|
|
|
5949
6137
|
*
|
|
5950
6138
|
* @see {@link withDecodingDefault} for the variant where the default is an `Encoded` value
|
|
5951
6139
|
* @see {@link withDecodingDefaultTypeKey} for the key-level variant
|
|
6140
|
+
* @stability stable
|
|
5952
6141
|
* @category decoding
|
|
5953
6142
|
* @since 4.0.0
|
|
5954
6143
|
*/
|
|
@@ -5966,6 +6155,7 @@ export function withDecodingDefaultType<S extends Constraint, R = never>(
|
|
|
5966
6155
|
/**
|
|
5967
6156
|
* Type-level representation returned by {@link tag}.
|
|
5968
6157
|
*
|
|
6158
|
+
* @stability stable
|
|
5969
6159
|
* @category constructors
|
|
5970
6160
|
* @since 3.10.0
|
|
5971
6161
|
*/
|
|
@@ -5989,6 +6179,7 @@ export interface tag<Tag extends SchemaAST.LiteralValue> extends withConstructor
|
|
|
5989
6179
|
*
|
|
5990
6180
|
* @see {@link tagDefaultOmit} to also omit the tag during encoding
|
|
5991
6181
|
* @see {@link TaggedStruct} for a shorthand that adds `_tag` automatically
|
|
6182
|
+
* @stability stable
|
|
5992
6183
|
* @category constructors
|
|
5993
6184
|
* @since 3.10.0
|
|
5994
6185
|
*/
|
|
@@ -6023,6 +6214,7 @@ export function tag<Tag extends SchemaAST.LiteralValue>(literal: Tag): tag<Tag>
|
|
|
6023
6214
|
* ```
|
|
6024
6215
|
*
|
|
6025
6216
|
* @see {@link tag} for the variant that keeps the tag during encoding
|
|
6217
|
+
* @stability stable
|
|
6026
6218
|
* @category constructors
|
|
6027
6219
|
* @since 4.0.0
|
|
6028
6220
|
*/
|
|
@@ -6032,6 +6224,7 @@ export function tagDefaultOmit<Tag extends SchemaAST.LiteralValue>(literal: Tag)
|
|
|
6032
6224
|
/**
|
|
6033
6225
|
* Type-level representation returned by {@link TaggedStruct}.
|
|
6034
6226
|
*
|
|
6227
|
+
* @stability stable
|
|
6035
6228
|
* @category models
|
|
6036
6229
|
* @since 3.10.0
|
|
6037
6230
|
*/
|
|
@@ -6082,6 +6275,7 @@ export type TaggedStruct<Tag extends SchemaAST.LiteralValue, Fields extends Stru
|
|
|
6082
6275
|
* tagged.fields._tag.schema.literal // => "A"
|
|
6083
6276
|
* ```
|
|
6084
6277
|
*
|
|
6278
|
+
* @stability stable
|
|
6085
6279
|
* @category constructors
|
|
6086
6280
|
* @since 3.10.0
|
|
6087
6281
|
*/
|
|
@@ -6111,6 +6305,10 @@ type TaggedUnionUtils<
|
|
|
6111
6305
|
Members
|
|
6112
6306
|
>
|
|
6113
6307
|
> = {
|
|
6308
|
+
/**
|
|
6309
|
+
* Property key used to discriminate union members.
|
|
6310
|
+
*/
|
|
6311
|
+
readonly tag: Tag
|
|
6114
6312
|
/**
|
|
6115
6313
|
* Discriminant values in flattened member order.
|
|
6116
6314
|
*/
|
|
@@ -6164,6 +6362,7 @@ type TaggedUnionUtils<
|
|
|
6164
6362
|
/**
|
|
6165
6363
|
* Type-level representation returned by {@link toTaggedUnion}.
|
|
6166
6364
|
*
|
|
6365
|
+
* @stability stable
|
|
6167
6366
|
* @category combinators
|
|
6168
6367
|
* @since 4.0.0
|
|
6169
6368
|
*/
|
|
@@ -6198,6 +6397,7 @@ export type toTaggedUnion<
|
|
|
6198
6397
|
* ```
|
|
6199
6398
|
*
|
|
6200
6399
|
* @see {@link TaggedUnion} for a shorthand that builds the union from scratch
|
|
6400
|
+
* @stability stable
|
|
6201
6401
|
* @category combinators
|
|
6202
6402
|
* @since 4.0.0
|
|
6203
6403
|
*/
|
|
@@ -6213,7 +6413,7 @@ export function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag) {
|
|
|
6213
6413
|
|
|
6214
6414
|
walk(self)
|
|
6215
6415
|
|
|
6216
|
-
return Object.assign(self, { cases, discriminants, isAnyOf, guards, match, matchOrElse }) as any
|
|
6416
|
+
return Object.assign(self, { tag, cases, discriminants, isAnyOf, guards, match, matchOrElse }) as any
|
|
6217
6417
|
|
|
6218
6418
|
function walk(schema: Constraint) {
|
|
6219
6419
|
const ast = schema.ast
|
|
@@ -6282,6 +6482,7 @@ export function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag) {
|
|
|
6282
6482
|
/**
|
|
6283
6483
|
* Type-level representation returned by {@link TaggedUnion}.
|
|
6284
6484
|
*
|
|
6485
|
+
* @stability stable
|
|
6285
6486
|
* @category models
|
|
6286
6487
|
* @since 4.0.0
|
|
6287
6488
|
*/
|
|
@@ -6298,6 +6499,7 @@ export interface TaggedUnion<Cases extends Record<string, Constraint>> extends
|
|
|
6298
6499
|
readonly "~type.make.in": { [K in keyof Cases]: Cases[K]["~type.make"] }[keyof Cases]
|
|
6299
6500
|
readonly "~type.make": { [K in keyof Cases]: Cases[K]["~type.make"] }[keyof Cases]
|
|
6300
6501
|
readonly "Iso": { [K in keyof Cases]: Cases[K]["Type"] }[keyof Cases]
|
|
6502
|
+
readonly tag: "_tag"
|
|
6301
6503
|
readonly cases: Cases
|
|
6302
6504
|
readonly isAnyOf: <const Keys>(
|
|
6303
6505
|
keys: ReadonlyArray<Keys>
|
|
@@ -6327,7 +6529,7 @@ export interface TaggedUnion<Cases extends Record<string, Constraint>> extends
|
|
|
6327
6529
|
/**
|
|
6328
6530
|
* Builds a discriminated union from a record of field sets, one per variant.
|
|
6329
6531
|
* Each key becomes the `_tag` literal and the value is passed to {@link TaggedStruct}.
|
|
6330
|
-
* The result includes `cases`, `guards`, `isAnyOf`, `match`, and `matchOrElse` utilities.
|
|
6532
|
+
* The result includes `tag`, `cases`, `guards`, `isAnyOf`, `match`, and `matchOrElse` utilities.
|
|
6331
6533
|
*
|
|
6332
6534
|
* **Example** (Pattern matching a discriminated union)
|
|
6333
6535
|
*
|
|
@@ -6348,6 +6550,7 @@ export interface TaggedUnion<Cases extends Record<string, Constraint>> extends
|
|
|
6348
6550
|
* ```
|
|
6349
6551
|
*
|
|
6350
6552
|
* @see {@link toTaggedUnion} to augment an existing union instead
|
|
6553
|
+
* @stability stable
|
|
6351
6554
|
* @category constructors
|
|
6352
6555
|
* @since 4.0.0
|
|
6353
6556
|
*/
|
|
@@ -6362,12 +6565,13 @@ export function TaggedUnion<const CasesByTag extends Record<string, Struct.Field
|
|
|
6362
6565
|
members.push(member)
|
|
6363
6566
|
}
|
|
6364
6567
|
const union = Union(members)
|
|
6365
|
-
const { guards, isAnyOf, match, matchOrElse } = toTaggedUnion("_tag")(union)
|
|
6366
|
-
return make(union.ast, { cases, isAnyOf, guards, match, matchOrElse })
|
|
6568
|
+
const { tag, guards, isAnyOf, match, matchOrElse } = toTaggedUnion("_tag")(union)
|
|
6569
|
+
return make(union.ast, { tag, cases, isAnyOf, guards, match, matchOrElse })
|
|
6367
6570
|
}
|
|
6368
6571
|
/**
|
|
6369
6572
|
* Type-level representation returned by {@link Opaque}.
|
|
6370
6573
|
*
|
|
6574
|
+
* @stability stable
|
|
6371
6575
|
* @category models
|
|
6372
6576
|
* @since 4.0.0
|
|
6373
6577
|
*/
|
|
@@ -6413,6 +6617,7 @@ export interface Opaque<Self, S extends Top, Brand> extends
|
|
|
6413
6617
|
* person.name // => "Alice"
|
|
6414
6618
|
* ```
|
|
6415
6619
|
*
|
|
6620
|
+
* @stability stable
|
|
6416
6621
|
* @category constructors
|
|
6417
6622
|
* @since 4.0.0
|
|
6418
6623
|
*/
|
|
@@ -6424,6 +6629,7 @@ export function Opaque<Self, Brand = {}>() {
|
|
|
6424
6629
|
/**
|
|
6425
6630
|
* Type-level representation returned by {@link instanceOf}.
|
|
6426
6631
|
*
|
|
6632
|
+
* @stability stable
|
|
6427
6633
|
* @category models
|
|
6428
6634
|
* @since 3.10.0
|
|
6429
6635
|
*/
|
|
@@ -6445,6 +6651,7 @@ export interface instanceOf<T, Iso = T> extends declare<T, Iso> {
|
|
|
6445
6651
|
* decoded.toISOString() // => "2024-01-01T00:00:00.000Z"
|
|
6446
6652
|
* ```
|
|
6447
6653
|
*
|
|
6654
|
+
* @stability stable
|
|
6448
6655
|
* @category constructors
|
|
6449
6656
|
* @since 3.10.0
|
|
6450
6657
|
*/
|
|
@@ -6458,6 +6665,7 @@ export function instanceOf<C extends abstract new(...args: any) => any, Iso = In
|
|
|
6458
6665
|
* Constructs an `SchemaAST.Link` that describes how a value of type `T` encodes to and decodes from a `To` schema.
|
|
6459
6666
|
* Used when building low-level AST transformations that bridge two schema types.
|
|
6460
6667
|
*
|
|
6668
|
+
* @stability stable
|
|
6461
6669
|
* @category transforming
|
|
6462
6670
|
* @since 4.0.0
|
|
6463
6671
|
*/
|
|
@@ -6527,6 +6735,7 @@ export function link<T>() {
|
|
|
6527
6735
|
* }
|
|
6528
6736
|
* ```
|
|
6529
6737
|
*
|
|
6738
|
+
* @stability stable
|
|
6530
6739
|
* @category constructors
|
|
6531
6740
|
* @since 4.0.0
|
|
6532
6741
|
*/
|
|
@@ -6551,6 +6760,7 @@ export const makeFilter: <T>(
|
|
|
6551
6760
|
* `reportInput`) or a full {@link SchemaIssue.Issue} (returned unchanged);
|
|
6552
6761
|
* the result is wrapped in an {@link SchemaIssue.Pointer} at the given `path`.
|
|
6553
6762
|
*
|
|
6763
|
+
* @stability stable
|
|
6554
6764
|
* @category models
|
|
6555
6765
|
* @since 3.10.0
|
|
6556
6766
|
*/
|
|
@@ -6578,6 +6788,7 @@ export type FilterIssue = string | SchemaIssue.Issue | {
|
|
|
6578
6788
|
* to returning that element directly; otherwise the entries are grouped
|
|
6579
6789
|
* into an {@link SchemaIssue.Composite}.
|
|
6580
6790
|
*
|
|
6791
|
+
* @stability stable
|
|
6581
6792
|
* @category models
|
|
6582
6793
|
* @since 3.10.0
|
|
6583
6794
|
*/
|
|
@@ -6586,6 +6797,7 @@ export type FilterOutput = undefined | boolean | FilterIssue | ReadonlyArray<Fil
|
|
|
6586
6797
|
* Groups multiple checks into a single {@link SchemaAST.FilterGroup}, applying
|
|
6587
6798
|
* optional shared annotations to the group as a whole.
|
|
6588
6799
|
*
|
|
6800
|
+
* @stability stable
|
|
6589
6801
|
* @category constructors
|
|
6590
6802
|
* @since 4.0.0
|
|
6591
6803
|
*/
|
|
@@ -6612,6 +6824,7 @@ const TRIMMED_PATTERN = "^\\S[\\s\\S]*\\S$|^\\S$|^$"
|
|
|
6612
6824
|
* During arbitrary generation, this applies a `patterns`
|
|
6613
6825
|
* constraint to ensure generated strings match the trimmed pattern.
|
|
6614
6826
|
*
|
|
6827
|
+
* @stability stable
|
|
6615
6828
|
* @category validation
|
|
6616
6829
|
* @since 4.0.0
|
|
6617
6830
|
*/
|
|
@@ -6650,6 +6863,7 @@ export function isTrimmed(annotations?: Annotations.Filter) {
|
|
|
6650
6863
|
* During arbitrary generation, this applies a `patterns`
|
|
6651
6864
|
* constraint to ensure generated strings match the specified RegExp pattern.
|
|
6652
6865
|
*
|
|
6866
|
+
* @stability stable
|
|
6653
6867
|
* @category validation
|
|
6654
6868
|
* @since 4.0.0
|
|
6655
6869
|
*/
|
|
@@ -6684,6 +6898,7 @@ export function isPattern(
|
|
|
6684
6898
|
* During arbitrary generation, this applies a `patterns`
|
|
6685
6899
|
* constraint to ensure generated strings match the number string pattern.
|
|
6686
6900
|
*
|
|
6901
|
+
* @stability stable
|
|
6687
6902
|
* @category validation
|
|
6688
6903
|
* @since 4.0.0
|
|
6689
6904
|
*/
|
|
@@ -6707,6 +6922,7 @@ export function isStringFinite(annotations?: Annotations.Filter): SchemaAST.Filt
|
|
|
6707
6922
|
* This check corresponds to a `pattern` constraint with the same signed
|
|
6708
6923
|
* base-10 integer pattern.
|
|
6709
6924
|
*
|
|
6925
|
+
* @stability stable
|
|
6710
6926
|
* @category validation
|
|
6711
6927
|
* @since 4.0.0
|
|
6712
6928
|
*/
|
|
@@ -6725,6 +6941,7 @@ export function isStringBigInt(annotations?: Annotations.Filter): SchemaAST.Filt
|
|
|
6725
6941
|
* The check uses the pattern `^Symbol\((.*)\)$`. It is not a general test for
|
|
6726
6942
|
* whether a string can be passed to JavaScript's `Symbol()` function.
|
|
6727
6943
|
*
|
|
6944
|
+
* @stability stable
|
|
6728
6945
|
* @category validation
|
|
6729
6946
|
* @since 4.0.0
|
|
6730
6947
|
*/
|
|
@@ -6770,6 +6987,7 @@ const getUUIDRegExp = (version?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8): globalThis.RegE
|
|
|
6770
6987
|
* constraint to ensure generated strings match the UUID pattern.
|
|
6771
6988
|
*
|
|
6772
6989
|
* @see {@link isGUID} for shape-only GUID validation.
|
|
6990
|
+
* @stability stable
|
|
6773
6991
|
* @category validation
|
|
6774
6992
|
* @since 4.0.0
|
|
6775
6993
|
*/
|
|
@@ -6812,6 +7030,7 @@ const GUID_REGEXP = /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{
|
|
|
6812
7030
|
* constraint to ensure generated strings match the GUID pattern.
|
|
6813
7031
|
*
|
|
6814
7032
|
* @see {@link isUUID} for strict UUID validation.
|
|
7033
|
+
* @stability stable
|
|
6815
7034
|
* @category validation
|
|
6816
7035
|
* @since 4.0.0
|
|
6817
7036
|
*/
|
|
@@ -6846,6 +7065,7 @@ export function isGUID(annotations?: Annotations.Filter) {
|
|
|
6846
7065
|
* During arbitrary generation, this applies a `patterns`
|
|
6847
7066
|
* constraint to ensure generated strings match the ULID pattern.
|
|
6848
7067
|
*
|
|
7068
|
+
* @stability stable
|
|
6849
7069
|
* @category validation
|
|
6850
7070
|
* @since 4.0.0
|
|
6851
7071
|
*/
|
|
@@ -6879,6 +7099,7 @@ export function isULID(annotations?: Annotations.Filter) {
|
|
|
6879
7099
|
* During arbitrary generation, this applies a `patterns`
|
|
6880
7100
|
* constraint to ensure generated strings match the Base64 pattern.
|
|
6881
7101
|
*
|
|
7102
|
+
* @stability stable
|
|
6882
7103
|
* @category validation
|
|
6883
7104
|
* @since 4.0.0
|
|
6884
7105
|
*/
|
|
@@ -6914,6 +7135,7 @@ export function isBase64(annotations?: Annotations.Filter) {
|
|
|
6914
7135
|
* During arbitrary generation, this applies a `patterns`
|
|
6915
7136
|
* constraint to ensure generated strings match the Base64URL pattern.
|
|
6916
7137
|
*
|
|
7138
|
+
* @stability stable
|
|
6917
7139
|
* @category validation
|
|
6918
7140
|
* @since 4.0.0
|
|
6919
7141
|
*/
|
|
@@ -6953,6 +7175,7 @@ function literalToJsonSchema(
|
|
|
6953
7175
|
* metadata. If the prefix ends with a high surrogate, the JSON Schema pattern
|
|
6954
7176
|
* omits that code unit so Unicode matching cannot reject a valid string.
|
|
6955
7177
|
*
|
|
7178
|
+
* @stability stable
|
|
6956
7179
|
* @category validation
|
|
6957
7180
|
* @since 4.0.0
|
|
6958
7181
|
*/
|
|
@@ -6986,6 +7209,7 @@ export function isStartingWith(startsWith: string, annotations?: Annotations.Fil
|
|
|
6986
7209
|
* metadata. If the suffix begins with a low surrogate, the JSON Schema pattern
|
|
6987
7210
|
* omits that code unit so Unicode matching cannot reject a valid string.
|
|
6988
7211
|
*
|
|
7212
|
+
* @stability stable
|
|
6989
7213
|
* @category validation
|
|
6990
7214
|
* @since 4.0.0
|
|
6991
7215
|
*/
|
|
@@ -7020,6 +7244,7 @@ export function isEndingWith(endsWith: string, annotations?: Annotations.Filter)
|
|
|
7020
7244
|
* omitted from the JSON Schema pattern so Unicode matching cannot reject a
|
|
7021
7245
|
* valid string.
|
|
7022
7246
|
*
|
|
7247
|
+
* @stability stable
|
|
7023
7248
|
* @category validation
|
|
7024
7249
|
* @since 4.0.0
|
|
7025
7250
|
*/
|
|
@@ -7055,6 +7280,7 @@ const UPPERCASED_PATTERN = "^[^a-z]*$"
|
|
|
7055
7280
|
* such as digits, punctuation, and whitespace. It rejects strings that would
|
|
7056
7281
|
* change when uppercased.
|
|
7057
7282
|
*
|
|
7283
|
+
* @stability stable
|
|
7058
7284
|
* @category validation
|
|
7059
7285
|
* @since 4.0.0
|
|
7060
7286
|
*/
|
|
@@ -7088,6 +7314,7 @@ const LOWERCASED_PATTERN = "^[^A-Z]*$"
|
|
|
7088
7314
|
* such as digits, punctuation, and whitespace. It rejects strings that would
|
|
7089
7315
|
* change when lowercased.
|
|
7090
7316
|
*
|
|
7317
|
+
* @stability stable
|
|
7091
7318
|
* @category validation
|
|
7092
7319
|
* @since 4.0.0
|
|
7093
7320
|
*/
|
|
@@ -7121,6 +7348,7 @@ const CAPITALIZED_PATTERN = "^(?:[^a-z][\\s\\S]*)?$"
|
|
|
7121
7348
|
* Empty strings pass. Strings whose first character has no lowercase form, such
|
|
7122
7349
|
* as a digit, punctuation mark, or whitespace, also pass.
|
|
7123
7350
|
*
|
|
7351
|
+
* @stability stable
|
|
7124
7352
|
* @category validation
|
|
7125
7353
|
* @since 4.0.0
|
|
7126
7354
|
*/
|
|
@@ -7154,6 +7382,7 @@ const UNCAPITALIZED_PATTERN = "^(?:[^A-Z][\\s\\S]*)?$"
|
|
|
7154
7382
|
* Empty strings pass. Strings whose first character has no uppercase form, such
|
|
7155
7383
|
* as a digit, punctuation mark, or whitespace, also pass.
|
|
7156
7384
|
*
|
|
7385
|
+
* @stability stable
|
|
7157
7386
|
* @category validation
|
|
7158
7387
|
* @since 4.0.0
|
|
7159
7388
|
*/
|
|
@@ -7179,6 +7408,7 @@ export function isUncapitalized(annotations?: Annotations.Filter) {
|
|
|
7179
7408
|
/**
|
|
7180
7409
|
* Type-level representation of {@link Finite}.
|
|
7181
7410
|
*
|
|
7411
|
+
* @stability stable
|
|
7182
7412
|
* @category models
|
|
7183
7413
|
* @since 3.10.0
|
|
7184
7414
|
*/
|
|
@@ -7188,6 +7418,7 @@ export interface Finite extends Number {
|
|
|
7188
7418
|
/**
|
|
7189
7419
|
* Schema for finite numbers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
7190
7420
|
*
|
|
7421
|
+
* @stability stable
|
|
7191
7422
|
* @category schemas
|
|
7192
7423
|
* @since 3.10.0
|
|
7193
7424
|
*/
|
|
@@ -7206,6 +7437,7 @@ export const Finite: Finite = make(SchemaAST.finite)
|
|
|
7206
7437
|
*
|
|
7207
7438
|
* During arbitrary generation, this applies a finite-number constraint.
|
|
7208
7439
|
*
|
|
7440
|
+
* @stability stable
|
|
7209
7441
|
* @category validation
|
|
7210
7442
|
* @since 4.0.0
|
|
7211
7443
|
*/
|
|
@@ -7214,6 +7446,7 @@ export const isFinite: (annotations?: Annotations.Filter) => SchemaAST.Filter<nu
|
|
|
7214
7446
|
* Creates a greater-than (`>`) check for any ordered type from an
|
|
7215
7447
|
* `Order.Order` instance.
|
|
7216
7448
|
*
|
|
7449
|
+
* @stability stable
|
|
7217
7450
|
* @category validation
|
|
7218
7451
|
* @since 4.0.0
|
|
7219
7452
|
*/
|
|
@@ -7244,6 +7477,7 @@ export function makeIsGreaterThan<T>(options: {
|
|
|
7244
7477
|
* Creates a greater-than-or-equal-to (`>=`) check for any ordered type from an
|
|
7245
7478
|
* `Order.Order` instance.
|
|
7246
7479
|
*
|
|
7480
|
+
* @stability stable
|
|
7247
7481
|
* @category validation
|
|
7248
7482
|
* @since 4.0.0
|
|
7249
7483
|
*/
|
|
@@ -7273,6 +7507,7 @@ export function makeIsGreaterThanOrEqualTo<T>(options: {
|
|
|
7273
7507
|
* Creates a less-than (`<`) check for any ordered type from an `Order.Order`
|
|
7274
7508
|
* instance.
|
|
7275
7509
|
*
|
|
7510
|
+
* @stability stable
|
|
7276
7511
|
* @category validation
|
|
7277
7512
|
* @since 4.0.0
|
|
7278
7513
|
*/
|
|
@@ -7303,6 +7538,7 @@ export function makeIsLessThan<T>(options: {
|
|
|
7303
7538
|
* Creates a less-than-or-equal-to (`<=`) check for any ordered type from an
|
|
7304
7539
|
* `Order.Order` instance.
|
|
7305
7540
|
*
|
|
7541
|
+
* @stability stable
|
|
7306
7542
|
* @category validation
|
|
7307
7543
|
* @since 4.0.0
|
|
7308
7544
|
*/
|
|
@@ -7332,6 +7568,7 @@ export function makeIsLessThanOrEqualTo<T>(options: {
|
|
|
7332
7568
|
* Creates an inclusive or exclusive range check for any ordered type from an
|
|
7333
7569
|
* `Order.Order` instance.
|
|
7334
7570
|
*
|
|
7571
|
+
* @stability stable
|
|
7335
7572
|
* @category validation
|
|
7336
7573
|
* @since 4.0.0
|
|
7337
7574
|
*/
|
|
@@ -7383,6 +7620,7 @@ export function makeIsBetween<T>(deriveOptions: {
|
|
|
7383
7620
|
* Creates a divisibility check for any numeric type from a remainder function
|
|
7384
7621
|
* and a zero value.
|
|
7385
7622
|
*
|
|
7623
|
+
* @stability stable
|
|
7386
7624
|
* @category validation
|
|
7387
7625
|
* @since 4.0.0
|
|
7388
7626
|
*/
|
|
@@ -7426,6 +7664,7 @@ function encodeNumberPayload(number: number): number {
|
|
|
7426
7664
|
* `exclusiveMinimum` constraint to ensure generated numbers are greater than
|
|
7427
7665
|
* the specified value.
|
|
7428
7666
|
*
|
|
7667
|
+
* @stability stable
|
|
7429
7668
|
* @category validation
|
|
7430
7669
|
* @since 4.0.0
|
|
7431
7670
|
*/
|
|
@@ -7456,6 +7695,7 @@ export const isGreaterThan: (exclusiveMinimum: number, annotations?: Annotations
|
|
|
7456
7695
|
* During arbitrary generation, this applies a `minimum` constraint
|
|
7457
7696
|
* to ensure generated numbers are greater than or equal to the specified value.
|
|
7458
7697
|
*
|
|
7698
|
+
* @stability stable
|
|
7459
7699
|
* @category validation
|
|
7460
7700
|
* @since 4.0.0
|
|
7461
7701
|
*/
|
|
@@ -7486,6 +7726,7 @@ export const isGreaterThanOrEqualTo: (minimum: number, annotations?: Annotations
|
|
|
7486
7726
|
* `exclusiveMaximum` constraint to ensure generated numbers are less than the
|
|
7487
7727
|
* specified value.
|
|
7488
7728
|
*
|
|
7729
|
+
* @stability stable
|
|
7489
7730
|
* @category validation
|
|
7490
7731
|
* @since 4.0.0
|
|
7491
7732
|
*/
|
|
@@ -7516,6 +7757,7 @@ export const isLessThan: (exclusiveMaximum: number, annotations?: Annotations.Fi
|
|
|
7516
7757
|
* During arbitrary generation, this applies a `maximum` constraint
|
|
7517
7758
|
* to ensure generated numbers are less than or equal to the specified value.
|
|
7518
7759
|
*
|
|
7760
|
+
* @stability stable
|
|
7519
7761
|
* @category validation
|
|
7520
7762
|
* @since 4.0.0
|
|
7521
7763
|
*/
|
|
@@ -7549,6 +7791,7 @@ export const isLessThanOrEqualTo: (maximum: number, annotations?: Annotations.Fi
|
|
|
7549
7791
|
* `exclusiveMaximum` flags to ensure generated numbers fall within the
|
|
7550
7792
|
* specified range.
|
|
7551
7793
|
*
|
|
7794
|
+
* @stability stable
|
|
7552
7795
|
* @category validation
|
|
7553
7796
|
* @since 4.0.0
|
|
7554
7797
|
*/
|
|
@@ -7600,6 +7843,7 @@ export const isBetween: (options: {
|
|
|
7600
7843
|
*
|
|
7601
7844
|
* Throws a `RangeError` when `divisor` is zero or is not finite.
|
|
7602
7845
|
*
|
|
7846
|
+
* @stability stable
|
|
7603
7847
|
* @category validation
|
|
7604
7848
|
* @since 4.0.0
|
|
7605
7849
|
*/
|
|
@@ -7639,6 +7883,7 @@ export function isMultipleOf(
|
|
|
7639
7883
|
*
|
|
7640
7884
|
* During arbitrary generation, this applies an integer constraint.
|
|
7641
7885
|
*
|
|
7886
|
+
* @stability stable
|
|
7642
7887
|
* @category validation
|
|
7643
7888
|
* @since 4.0.0
|
|
7644
7889
|
*/
|
|
@@ -7663,6 +7908,7 @@ export function isInt(annotations?: Annotations.Filter) {
|
|
|
7663
7908
|
/**
|
|
7664
7909
|
* Type-level representation of {@link Int}.
|
|
7665
7910
|
*
|
|
7911
|
+
* @stability stable
|
|
7666
7912
|
* @category models
|
|
7667
7913
|
* @since 3.10.0
|
|
7668
7914
|
*/
|
|
@@ -7672,6 +7918,7 @@ export interface Int extends Number {
|
|
|
7672
7918
|
/**
|
|
7673
7919
|
* Schema for integers, rejecting `NaN`, `Infinity`, and `-Infinity`.
|
|
7674
7920
|
*
|
|
7921
|
+
* @stability stable
|
|
7675
7922
|
* @category schemas
|
|
7676
7923
|
* @since 3.10.0
|
|
7677
7924
|
*/
|
|
@@ -7679,6 +7926,7 @@ export const Int: Int = Number.check(isInt())
|
|
|
7679
7926
|
/**
|
|
7680
7927
|
* Type-level representation of {@link Natural}.
|
|
7681
7928
|
*
|
|
7929
|
+
* @stability stable
|
|
7682
7930
|
* @category models
|
|
7683
7931
|
* @since 4.0.0
|
|
7684
7932
|
*/
|
|
@@ -7694,6 +7942,7 @@ export interface Natural extends Int {
|
|
|
7694
7942
|
*
|
|
7695
7943
|
* @see {@link Int} for safe integers that may be negative
|
|
7696
7944
|
*
|
|
7945
|
+
* @stability stable
|
|
7697
7946
|
* @category schemas
|
|
7698
7947
|
* @since 4.0.0
|
|
7699
7948
|
*/
|
|
@@ -7714,6 +7963,7 @@ export const Natural: Natural = Int.check(isGreaterThanOrEqualTo(0))
|
|
|
7714
7963
|
* During arbitrary generation, this applies integer and range
|
|
7715
7964
|
* constraints to ensure generated numbers are 32-bit signed integers.
|
|
7716
7965
|
*
|
|
7966
|
+
* @stability stable
|
|
7717
7967
|
* @category validation
|
|
7718
7968
|
* @since 4.0.0
|
|
7719
7969
|
*/
|
|
@@ -7745,6 +7995,7 @@ export function isInt32(annotations?: Annotations.Filter) {
|
|
|
7745
7995
|
* During arbitrary generation, this applies integer and range
|
|
7746
7996
|
* constraints to ensure generated numbers are 32-bit unsigned integers.
|
|
7747
7997
|
*
|
|
7998
|
+
* @stability stable
|
|
7748
7999
|
* @category validation
|
|
7749
8000
|
* @since 4.0.0
|
|
7750
8001
|
*/
|
|
@@ -7780,6 +8031,7 @@ function formatDateRuntime(date: globalThis.Date): string {
|
|
|
7780
8031
|
*
|
|
7781
8032
|
* During arbitrary generation, this applies an exclusive lower bound.
|
|
7782
8033
|
*
|
|
8034
|
+
* @stability stable
|
|
7783
8035
|
* @category validation
|
|
7784
8036
|
* @since 4.0.0
|
|
7785
8037
|
*/
|
|
@@ -7815,6 +8067,7 @@ export const isGreaterThanDate: (
|
|
|
7815
8067
|
*
|
|
7816
8068
|
* During arbitrary generation, this applies an inclusive lower bound.
|
|
7817
8069
|
*
|
|
8070
|
+
* @stability stable
|
|
7818
8071
|
* @category validation
|
|
7819
8072
|
* @since 4.0.0
|
|
7820
8073
|
*/
|
|
@@ -7844,6 +8097,7 @@ export const isGreaterThanOrEqualToDate: (
|
|
|
7844
8097
|
*
|
|
7845
8098
|
* During arbitrary generation, this applies an exclusive upper bound.
|
|
7846
8099
|
*
|
|
8100
|
+
* @stability stable
|
|
7847
8101
|
* @category validation
|
|
7848
8102
|
* @since 4.0.0
|
|
7849
8103
|
*/
|
|
@@ -7879,6 +8133,7 @@ export const isLessThanDate: (
|
|
|
7879
8133
|
*
|
|
7880
8134
|
* During arbitrary generation, this applies an inclusive upper bound.
|
|
7881
8135
|
*
|
|
8136
|
+
* @stability stable
|
|
7882
8137
|
* @category validation
|
|
7883
8138
|
* @since 4.0.0
|
|
7884
8139
|
*/
|
|
@@ -7914,6 +8169,7 @@ export const isLessThanOrEqualToDate: (
|
|
|
7914
8169
|
*
|
|
7915
8170
|
* During arbitrary generation, this applies the specified lower and upper bounds.
|
|
7916
8171
|
*
|
|
8172
|
+
* @stability stable
|
|
7917
8173
|
* @category validation
|
|
7918
8174
|
* @since 4.0.0
|
|
7919
8175
|
*/
|
|
@@ -7956,6 +8212,7 @@ export const isBetweenDate: (options: {
|
|
|
7956
8212
|
*
|
|
7957
8213
|
* During arbitrary generation, this applies an exclusive lower bound.
|
|
7958
8214
|
*
|
|
8215
|
+
* @stability stable
|
|
7959
8216
|
* @category validation
|
|
7960
8217
|
* @since 4.0.0
|
|
7961
8218
|
*/
|
|
@@ -7986,6 +8243,7 @@ export const isGreaterThanBigInt: (
|
|
|
7986
8243
|
*
|
|
7987
8244
|
* During arbitrary generation, this applies an inclusive lower bound.
|
|
7988
8245
|
*
|
|
8246
|
+
* @stability stable
|
|
7989
8247
|
* @category validation
|
|
7990
8248
|
* @since 4.0.0
|
|
7991
8249
|
*/
|
|
@@ -8015,6 +8273,7 @@ export const isGreaterThanOrEqualToBigInt: (
|
|
|
8015
8273
|
*
|
|
8016
8274
|
* During arbitrary generation, this applies an exclusive upper bound.
|
|
8017
8275
|
*
|
|
8276
|
+
* @stability stable
|
|
8018
8277
|
* @category validation
|
|
8019
8278
|
* @since 4.0.0
|
|
8020
8279
|
*/
|
|
@@ -8045,6 +8304,7 @@ export const isLessThanBigInt: (
|
|
|
8045
8304
|
*
|
|
8046
8305
|
* During arbitrary generation, this applies an inclusive upper bound.
|
|
8047
8306
|
*
|
|
8307
|
+
* @stability stable
|
|
8048
8308
|
* @category validation
|
|
8049
8309
|
* @since 4.0.0
|
|
8050
8310
|
*/
|
|
@@ -8075,6 +8335,7 @@ export const isLessThanOrEqualToBigInt: (
|
|
|
8075
8335
|
*
|
|
8076
8336
|
* During arbitrary generation, this applies the specified lower and upper bounds.
|
|
8077
8337
|
*
|
|
8338
|
+
* @stability stable
|
|
8078
8339
|
* @category validation
|
|
8079
8340
|
* @since 4.0.0
|
|
8080
8341
|
*/
|
|
@@ -8140,6 +8401,7 @@ export const isBetweenBigInt: (options: {
|
|
|
8140
8401
|
* Schema.is(NonEmptyArraySchema)([1]) // => true
|
|
8141
8402
|
* ```
|
|
8142
8403
|
*
|
|
8404
|
+
* @stability stable
|
|
8143
8405
|
* @category validation
|
|
8144
8406
|
* @since 4.0.0
|
|
8145
8407
|
*/
|
|
@@ -8192,6 +8454,7 @@ function makeIsMinLength(minLength: number, minCodePoints: number, annotations?:
|
|
|
8192
8454
|
* During arbitrary generation, this applies a `minLength: 1`
|
|
8193
8455
|
* constraint to ensure generated strings or arrays are non-empty.
|
|
8194
8456
|
*
|
|
8457
|
+
* @stability stable
|
|
8195
8458
|
* @category validation
|
|
8196
8459
|
* @since 4.0.0
|
|
8197
8460
|
*/
|
|
@@ -8217,6 +8480,7 @@ export function isNonEmpty(annotations?: Annotations.Filter) {
|
|
|
8217
8480
|
* constraint to ensure generated strings or arrays have at most the required
|
|
8218
8481
|
* length.
|
|
8219
8482
|
*
|
|
8483
|
+
* @stability stable
|
|
8220
8484
|
* @category validation
|
|
8221
8485
|
* @since 4.0.0
|
|
8222
8486
|
*/
|
|
@@ -8267,6 +8531,7 @@ export function isMaxLength(maxLength: number, annotations?: Annotations.Filter)
|
|
|
8267
8531
|
* `maxLength` constraints to ensure generated strings or arrays have a length
|
|
8268
8532
|
* within the specified range.
|
|
8269
8533
|
*
|
|
8534
|
+
* @stability stable
|
|
8270
8535
|
* @category validation
|
|
8271
8536
|
* @since 4.0.0
|
|
8272
8537
|
*/
|
|
@@ -8327,6 +8592,7 @@ export function isBetweenLength(minimum: number, maximum: number, annotations?:
|
|
|
8327
8592
|
* @see {@link isMinLength} for counting UTF-16 code units
|
|
8328
8593
|
* @see {@link isMaxCodePoints}
|
|
8329
8594
|
* @see {@link isBetweenCodePoints}
|
|
8595
|
+
* @stability stable
|
|
8330
8596
|
* @category validation
|
|
8331
8597
|
* @since 4.0.0
|
|
8332
8598
|
*/
|
|
@@ -8365,6 +8631,7 @@ export function isMinCodePoints(minCodePoints: number, annotations?: Annotations
|
|
|
8365
8631
|
* @see {@link isMaxLength} for counting UTF-16 code units
|
|
8366
8632
|
* @see {@link isMinCodePoints}
|
|
8367
8633
|
* @see {@link isBetweenCodePoints}
|
|
8634
|
+
* @stability stable
|
|
8368
8635
|
* @category validation
|
|
8369
8636
|
* @since 4.0.0
|
|
8370
8637
|
*/
|
|
@@ -8403,6 +8670,7 @@ export function isMaxCodePoints(maxCodePoints: number, annotations?: Annotations
|
|
|
8403
8670
|
* @see {@link isBetweenLength} for counting UTF-16 code units
|
|
8404
8671
|
* @see {@link isMinCodePoints}
|
|
8405
8672
|
* @see {@link isMaxCodePoints}
|
|
8673
|
+
* @stability stable
|
|
8406
8674
|
* @category validation
|
|
8407
8675
|
* @since 4.0.0
|
|
8408
8676
|
*/
|
|
@@ -8463,6 +8731,7 @@ function normalizeCardinality(value: number): number {
|
|
|
8463
8731
|
*
|
|
8464
8732
|
* During arbitrary generation, this applies a node-local `minSize` constraint.
|
|
8465
8733
|
*
|
|
8734
|
+
* @stability stable
|
|
8466
8735
|
* @category validation
|
|
8467
8736
|
* @since 4.0.0
|
|
8468
8737
|
*/
|
|
@@ -8503,6 +8772,7 @@ export function isMinSize(minSize: number, annotations?: Annotations.Filter) {
|
|
|
8503
8772
|
*
|
|
8504
8773
|
* During arbitrary generation, this applies a node-local `maxSize` constraint.
|
|
8505
8774
|
*
|
|
8775
|
+
* @stability stable
|
|
8506
8776
|
* @category validation
|
|
8507
8777
|
* @since 4.0.0
|
|
8508
8778
|
*/
|
|
@@ -8543,6 +8813,7 @@ export function isMaxSize(maxSize: number, annotations?: Annotations.Filter) {
|
|
|
8543
8813
|
*
|
|
8544
8814
|
* During arbitrary generation, this applies node-local `minSize` and `maxSize` constraints.
|
|
8545
8815
|
*
|
|
8816
|
+
* @stability stable
|
|
8546
8817
|
* @category validation
|
|
8547
8818
|
* @since 4.0.0
|
|
8548
8819
|
*/
|
|
@@ -8591,6 +8862,7 @@ export function isBetweenSize(minimum: number, maximum: number, annotations?: An
|
|
|
8591
8862
|
*
|
|
8592
8863
|
* During arbitrary generation, this applies a node-local `minProperties` constraint.
|
|
8593
8864
|
*
|
|
8865
|
+
* @stability stable
|
|
8594
8866
|
* @category validation
|
|
8595
8867
|
* @since 4.0.0
|
|
8596
8868
|
*/
|
|
@@ -8633,6 +8905,7 @@ export function isMinProperties(minProperties: number, annotations?: Annotations
|
|
|
8633
8905
|
*
|
|
8634
8906
|
* During arbitrary generation, this applies a node-local `maxProperties` constraint.
|
|
8635
8907
|
*
|
|
8908
|
+
* @stability stable
|
|
8636
8909
|
* @category validation
|
|
8637
8910
|
* @since 4.0.0
|
|
8638
8911
|
*/
|
|
@@ -8675,6 +8948,7 @@ export function isMaxProperties(maxProperties: number, annotations?: Annotations
|
|
|
8675
8948
|
*
|
|
8676
8949
|
* During arbitrary generation, this applies node-local `minProperties` and `maxProperties` constraints.
|
|
8677
8950
|
*
|
|
8951
|
+
* @stability stable
|
|
8678
8952
|
* @category validation
|
|
8679
8953
|
* @since 4.0.0
|
|
8680
8954
|
*/
|
|
@@ -8721,6 +8995,7 @@ export function isBetweenProperties(minimum: number, maximum: number, annotation
|
|
|
8721
8995
|
* names in the original input. Property transformations and excess-property
|
|
8722
8996
|
* handling can therefore produce different results.
|
|
8723
8997
|
*
|
|
8998
|
+
* @stability stable
|
|
8724
8999
|
* @category validation
|
|
8725
9000
|
* @since 4.0.0
|
|
8726
9001
|
*/
|
|
@@ -8770,6 +9045,7 @@ export function isPropertyNames(keySchema: Constraint, annotations?: Annotations
|
|
|
8770
9045
|
* During arbitrary generation, this applies a node-local identity selector
|
|
8771
9046
|
* for constructive uniqueness using Effect equality.
|
|
8772
9047
|
*
|
|
9048
|
+
* @stability stable
|
|
8773
9049
|
* @category validation
|
|
8774
9050
|
* @since 4.0.0
|
|
8775
9051
|
*/
|
|
@@ -8803,6 +9079,7 @@ export function isUnique<T>(annotations?: Annotations.Filter) {
|
|
|
8803
9079
|
* JSON Schema has no equivalent constraint, so this check is omitted from generated documents.
|
|
8804
9080
|
*
|
|
8805
9081
|
* @see {@link isUnique} for validating uniqueness of complete array elements
|
|
9082
|
+
* @stability stable
|
|
8806
9083
|
* @category validation
|
|
8807
9084
|
* @since 4.0.0
|
|
8808
9085
|
*/
|
|
@@ -8826,6 +9103,7 @@ export function isUniqueKey<Key, Value>(annotations?: Annotations.Filter) {
|
|
|
8826
9103
|
/**
|
|
8827
9104
|
* Type-level representation of {@link NonEmptyString}.
|
|
8828
9105
|
*
|
|
9106
|
+
* @stability stable
|
|
8829
9107
|
* @category models
|
|
8830
9108
|
* @since 3.10.0
|
|
8831
9109
|
*/
|
|
@@ -8836,6 +9114,7 @@ export interface NonEmptyString extends String {
|
|
|
8836
9114
|
* Schema for non-empty strings. Validates that a string has at least one
|
|
8837
9115
|
* character.
|
|
8838
9116
|
*
|
|
9117
|
+
* @stability stable
|
|
8839
9118
|
* @category schemas
|
|
8840
9119
|
* @since 3.10.0
|
|
8841
9120
|
*/
|
|
@@ -8843,6 +9122,7 @@ export const NonEmptyString: NonEmptyString = String.check(isNonEmpty())
|
|
|
8843
9122
|
/**
|
|
8844
9123
|
* Type-level representation of {@link Char}.
|
|
8845
9124
|
*
|
|
9125
|
+
* @stability stable
|
|
8846
9126
|
* @category models
|
|
8847
9127
|
* @since 3.10.0
|
|
8848
9128
|
*/
|
|
@@ -8865,6 +9145,7 @@ export interface Char extends String {
|
|
|
8865
9145
|
* @see {@link NonEmptyString} for strings with length greater than zero
|
|
8866
9146
|
* @see {@link isBetweenLength} for the underlying length check
|
|
8867
9147
|
*
|
|
9148
|
+
* @stability stable
|
|
8868
9149
|
* @category schemas
|
|
8869
9150
|
* @since 3.10.0
|
|
8870
9151
|
*/
|
|
@@ -8872,6 +9153,7 @@ export const Char: Char = String.check(isBetweenLength(1, 1))
|
|
|
8872
9153
|
/**
|
|
8873
9154
|
* Type-level representation of {@link ErrorInstance}.
|
|
8874
9155
|
*
|
|
9156
|
+
* @stability stable
|
|
8875
9157
|
* @category models
|
|
8876
9158
|
* @since 4.0.0
|
|
8877
9159
|
*/
|
|
@@ -8881,6 +9163,7 @@ export interface ErrorInstance extends instanceOf<globalThis.Error> {
|
|
|
8881
9163
|
/**
|
|
8882
9164
|
* Options for {@link ErrorInstance} and {@link Defect}.
|
|
8883
9165
|
*
|
|
9166
|
+
* @stability stable
|
|
8884
9167
|
* @category options
|
|
8885
9168
|
* @since 4.0.0
|
|
8886
9169
|
*/
|
|
@@ -8937,6 +9220,7 @@ const errorSchemaCache: Array<ErrorInstance | undefined> = []
|
|
|
8937
9220
|
* traces are omitted by default for security. Pass `{ includeStack: true }` to
|
|
8938
9221
|
* include stack traces, or `{ excludeCause: true }` to omit causes.
|
|
8939
9222
|
*
|
|
9223
|
+
* @stability stable
|
|
8940
9224
|
* @category schemas
|
|
8941
9225
|
* @since 4.0.0
|
|
8942
9226
|
*/
|
|
@@ -8967,6 +9251,7 @@ export function ErrorInstance(options?: ErrorOptions): ErrorInstance {
|
|
|
8967
9251
|
/**
|
|
8968
9252
|
* Type-level representation of {@link Defect}.
|
|
8969
9253
|
*
|
|
9254
|
+
* @stability stable
|
|
8970
9255
|
* @category models
|
|
8971
9256
|
* @since 3.10.0
|
|
8972
9257
|
*/
|
|
@@ -9013,6 +9298,7 @@ const defectSchemaCache: Array<Defect | undefined> = []
|
|
|
9013
9298
|
* string representation.
|
|
9014
9299
|
*
|
|
9015
9300
|
* @see {@link ErrorInstance} for a schema that only accepts JavaScript `Error` values.
|
|
9301
|
+
* @stability stable
|
|
9016
9302
|
* @category schemas
|
|
9017
9303
|
* @since 4.0.0
|
|
9018
9304
|
*/
|
|
@@ -9029,6 +9315,7 @@ export function Defect(options?: ErrorOptions): Defect {
|
|
|
9029
9315
|
/**
|
|
9030
9316
|
* Type-level representation returned by {@link ReadonlyMap}.
|
|
9031
9317
|
*
|
|
9318
|
+
* @stability stable
|
|
9032
9319
|
* @category models
|
|
9033
9320
|
* @since 4.0.0
|
|
9034
9321
|
*/
|
|
@@ -9048,6 +9335,7 @@ export interface $ReadonlyMap<Key extends Constraint, Value extends Constraint>
|
|
|
9048
9335
|
* Iso representation used for `ReadonlyMap` schemas: an array of readonly
|
|
9049
9336
|
* `[key, value]` tuples using each entry schema's `Iso` type.
|
|
9050
9337
|
*
|
|
9338
|
+
* @stability stable
|
|
9051
9339
|
* @category utility types
|
|
9052
9340
|
* @since 4.0.0
|
|
9053
9341
|
*/
|
|
@@ -9058,6 +9346,7 @@ export type ReadonlyMapIso<Key extends Constraint, Value extends Constraint> = R
|
|
|
9058
9346
|
* Schema for readonly maps whose keys and values conform to the provided
|
|
9059
9347
|
* schemas.
|
|
9060
9348
|
*
|
|
9349
|
+
* @stability stable
|
|
9061
9350
|
* @category schemas
|
|
9062
9351
|
* @since 3.10.0
|
|
9063
9352
|
*/
|
|
@@ -9111,6 +9400,7 @@ export function ReadonlyMap<Key extends Constraint, Value extends Constraint>(
|
|
|
9111
9400
|
/**
|
|
9112
9401
|
* Type-level representation returned by {@link ReadonlySet}.
|
|
9113
9402
|
*
|
|
9403
|
+
* @stability stable
|
|
9114
9404
|
* @category models
|
|
9115
9405
|
* @since 4.0.0
|
|
9116
9406
|
*/
|
|
@@ -9129,6 +9419,7 @@ export interface $ReadonlySet<Value extends Constraint> extends
|
|
|
9129
9419
|
* Iso representation used for `ReadonlySet` schemas: an array of element values
|
|
9130
9420
|
* using the element schema's `Iso` type.
|
|
9131
9421
|
*
|
|
9422
|
+
* @stability stable
|
|
9132
9423
|
* @category utility types
|
|
9133
9424
|
* @since 4.0.0
|
|
9134
9425
|
*/
|
|
@@ -9136,6 +9427,7 @@ export type ReadonlySetIso<Value extends Constraint> = ReadonlyArray<Value["Iso"
|
|
|
9136
9427
|
/**
|
|
9137
9428
|
* Schema for readonly sets whose values conform to the provided element schema.
|
|
9138
9429
|
*
|
|
9430
|
+
* @stability stable
|
|
9139
9431
|
* @category schemas
|
|
9140
9432
|
* @since 3.10.0
|
|
9141
9433
|
*/
|
|
@@ -9186,6 +9478,7 @@ export function ReadonlySet<Value extends Constraint>(value: Value): $ReadonlySe
|
|
|
9186
9478
|
/**
|
|
9187
9479
|
* Type-level representation of {@link RegExp}.
|
|
9188
9480
|
*
|
|
9481
|
+
* @stability stable
|
|
9189
9482
|
* @category models
|
|
9190
9483
|
* @since 4.0.0
|
|
9191
9484
|
*/
|
|
@@ -9199,6 +9492,7 @@ export interface RegExp extends instanceOf<globalThis.RegExp> {
|
|
|
9199
9492
|
*
|
|
9200
9493
|
* The default JSON serializer encodes a `RegExp` as `{ source, flags }`.
|
|
9201
9494
|
*
|
|
9495
|
+
* @stability stable
|
|
9202
9496
|
* @category schemas
|
|
9203
9497
|
* @since 4.0.0
|
|
9204
9498
|
*/
|
|
@@ -9243,6 +9537,7 @@ export const RegExp: RegExp = instanceOf(
|
|
|
9243
9537
|
/**
|
|
9244
9538
|
* Type-level representation of {@link URL}.
|
|
9245
9539
|
*
|
|
9540
|
+
* @stability stable
|
|
9246
9541
|
* @category models
|
|
9247
9542
|
* @since 4.0.0
|
|
9248
9543
|
*/
|
|
@@ -9260,6 +9555,7 @@ const URLString = String.annotate({ expected: "a string that will be decoded as
|
|
|
9260
9555
|
*
|
|
9261
9556
|
* - encodes `URL` as a `string`
|
|
9262
9557
|
*
|
|
9558
|
+
* @stability stable
|
|
9263
9559
|
* @category schemas
|
|
9264
9560
|
* @since 4.0.0
|
|
9265
9561
|
*/
|
|
@@ -9285,6 +9581,7 @@ export const URL: URL = instanceOf(
|
|
|
9285
9581
|
/**
|
|
9286
9582
|
* Type-level representation of {@link URLFromString}.
|
|
9287
9583
|
*
|
|
9584
|
+
* @stability stable
|
|
9288
9585
|
* @category models
|
|
9289
9586
|
* @since 4.0.0
|
|
9290
9587
|
*/
|
|
@@ -9302,6 +9599,7 @@ export interface URLFromString extends decodeTo<URL, String> {
|
|
|
9302
9599
|
* Encoding:
|
|
9303
9600
|
* - A `URL` is encoded as a `string`
|
|
9304
9601
|
*
|
|
9602
|
+
* @stability stable
|
|
9305
9603
|
* @category schemas
|
|
9306
9604
|
* @since 4.0.0
|
|
9307
9605
|
*/
|
|
@@ -9309,6 +9607,7 @@ export const URLFromString: URLFromString = URLString.pipe(decodeTo(URL, SchemaT
|
|
|
9309
9607
|
/**
|
|
9310
9608
|
* Type-level representation of {@link Date}.
|
|
9311
9609
|
*
|
|
9610
|
+
* @stability stable
|
|
9312
9611
|
* @category models
|
|
9313
9612
|
* @since 4.0.0
|
|
9314
9613
|
*/
|
|
@@ -9342,6 +9641,7 @@ const DateString = String.annotate({ expected: "a string that will be decoded as
|
|
|
9342
9641
|
* @see {@link DateFromString} for decoding strings into Date instances
|
|
9343
9642
|
* @see {@link DateFromMillis} for decoding epoch milliseconds into Date instances
|
|
9344
9643
|
*
|
|
9644
|
+
* @stability stable
|
|
9345
9645
|
* @category schemas
|
|
9346
9646
|
* @since 4.0.0
|
|
9347
9647
|
*/
|
|
@@ -9367,6 +9667,7 @@ export const Date: Date = declare(
|
|
|
9367
9667
|
/**
|
|
9368
9668
|
* Type-level representation of {@link DateFromString}.
|
|
9369
9669
|
*
|
|
9670
|
+
* @stability stable
|
|
9370
9671
|
* @category models
|
|
9371
9672
|
* @since 3.10.0
|
|
9372
9673
|
*/
|
|
@@ -9395,6 +9696,7 @@ export interface DateFromString extends decodeTo<Date, String> {
|
|
|
9395
9696
|
* @see {@link DateTimeUtcFromString} for decoding date-time strings into UTC values
|
|
9396
9697
|
* @see {@link Date} for accepting Date instances directly
|
|
9397
9698
|
*
|
|
9699
|
+
* @stability stable
|
|
9398
9700
|
* @category schemas
|
|
9399
9701
|
* @since 3.10.0
|
|
9400
9702
|
*/
|
|
@@ -9402,6 +9704,7 @@ export const DateFromString: DateFromString = DateString.pipe(decodeTo(Date, Sch
|
|
|
9402
9704
|
/**
|
|
9403
9705
|
* Type-level representation of {@link DateFromMillis}.
|
|
9404
9706
|
*
|
|
9707
|
+
* @stability stable
|
|
9405
9708
|
* @category models
|
|
9406
9709
|
* @since 4.0.0
|
|
9407
9710
|
*/
|
|
@@ -9433,6 +9736,7 @@ export interface DateFromMillis extends decodeTo<Date, Int> {
|
|
|
9433
9736
|
* @see {@link DateFromString} for decoding string-encoded dates
|
|
9434
9737
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
9435
9738
|
*
|
|
9739
|
+
* @stability stable
|
|
9436
9740
|
* @category schemas
|
|
9437
9741
|
* @since 4.0.0
|
|
9438
9742
|
*/
|
|
@@ -9442,6 +9746,7 @@ export const DateFromMillis: DateFromMillis = Int.pipe(
|
|
|
9442
9746
|
/**
|
|
9443
9747
|
* Type-level representation returned by {@link fromJsonString}.
|
|
9444
9748
|
*
|
|
9749
|
+
* @stability stable
|
|
9445
9750
|
* @category models
|
|
9446
9751
|
* @since 4.0.0
|
|
9447
9752
|
*/
|
|
@@ -9479,6 +9784,7 @@ const JsonString = String.annotate({
|
|
|
9479
9784
|
* Schema.encodeSync(schemaFromJsonString)({ a: 1 }) // => "{\n \"a\": 1\n}"
|
|
9480
9785
|
* ```
|
|
9481
9786
|
*
|
|
9787
|
+
* @stability stable
|
|
9482
9788
|
* @category schemas
|
|
9483
9789
|
* @since 4.0.0
|
|
9484
9790
|
*/
|
|
@@ -9497,6 +9803,7 @@ export const UnknownFromJsonString: fromJsonString<Unknown> = fromJsonString(Unk
|
|
|
9497
9803
|
/**
|
|
9498
9804
|
* Type-level representation of {@link File}.
|
|
9499
9805
|
*
|
|
9806
|
+
* @stability stable
|
|
9500
9807
|
* @category models
|
|
9501
9808
|
* @since 4.0.0
|
|
9502
9809
|
*/
|
|
@@ -9511,6 +9818,7 @@ export interface File extends instanceOf<globalThis.File> {
|
|
|
9511
9818
|
* The default JSON serializer encodes a `File` as `{ data, type, name, lastModified }`
|
|
9512
9819
|
* where `data` is base64-encoded.
|
|
9513
9820
|
*
|
|
9821
|
+
* @stability stable
|
|
9514
9822
|
* @category schemas
|
|
9515
9823
|
* @since 4.0.0
|
|
9516
9824
|
*/
|
|
@@ -9574,6 +9882,7 @@ export const File: File = instanceOf(globalThis.File, {
|
|
|
9574
9882
|
/**
|
|
9575
9883
|
* Type-level representation of {@link FormData}.
|
|
9576
9884
|
*
|
|
9885
|
+
* @stability stable
|
|
9577
9886
|
* @category models
|
|
9578
9887
|
* @since 4.0.0
|
|
9579
9888
|
*/
|
|
@@ -9588,6 +9897,7 @@ export interface FormData extends instanceOf<globalThis.FormData> {
|
|
|
9588
9897
|
* The default JSON serializer encodes a `FormData` as an array of `[key, entry]`
|
|
9589
9898
|
* pairs where each entry is tagged as `"String"` or `"File"`.
|
|
9590
9899
|
*
|
|
9900
|
+
* @stability stable
|
|
9591
9901
|
* @category schemas
|
|
9592
9902
|
* @since 4.0.0
|
|
9593
9903
|
*/
|
|
@@ -9637,6 +9947,7 @@ export const FormData: FormData = instanceOf(globalThis.FormData, {
|
|
|
9637
9947
|
/**
|
|
9638
9948
|
* Type-level representation returned by {@link fromFormData}.
|
|
9639
9949
|
*
|
|
9950
|
+
* @stability stable
|
|
9640
9951
|
* @category models
|
|
9641
9952
|
* @since 4.0.0
|
|
9642
9953
|
*/
|
|
@@ -9722,6 +10033,7 @@ export interface fromFormData<S extends Constraint> extends decodeTo<S, FormData
|
|
|
9722
10033
|
* Schema.decodeUnknownSync(schema)(formData) // => { a: 1 }
|
|
9723
10034
|
* ```
|
|
9724
10035
|
*
|
|
10036
|
+
* @stability stable
|
|
9725
10037
|
* @category decoding
|
|
9726
10038
|
* @since 4.0.0
|
|
9727
10039
|
*/
|
|
@@ -9731,6 +10043,7 @@ export function fromFormData<S extends Constraint>(schema: S): fromFormData<S> {
|
|
|
9731
10043
|
/**
|
|
9732
10044
|
* Type-level representation of {@link URLSearchParams}.
|
|
9733
10045
|
*
|
|
10046
|
+
* @stability stable
|
|
9734
10047
|
* @category models
|
|
9735
10048
|
* @since 4.0.0
|
|
9736
10049
|
*/
|
|
@@ -9744,6 +10057,7 @@ export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams>
|
|
|
9744
10057
|
*
|
|
9745
10058
|
* The default JSON serializer encodes a `URLSearchParams` as a query string.
|
|
9746
10059
|
*
|
|
10060
|
+
* @stability stable
|
|
9747
10061
|
* @category schemas
|
|
9748
10062
|
* @since 4.0.0
|
|
9749
10063
|
*/
|
|
@@ -9769,6 +10083,7 @@ export const URLSearchParams: URLSearchParams = instanceOf(globalThis.URLSearchP
|
|
|
9769
10083
|
/**
|
|
9770
10084
|
* Type-level representation returned by {@link fromURLSearchParams}.
|
|
9771
10085
|
*
|
|
10086
|
+
* @stability stable
|
|
9772
10087
|
* @category models
|
|
9773
10088
|
* @since 4.0.0
|
|
9774
10089
|
*/
|
|
@@ -9849,6 +10164,7 @@ export interface fromURLSearchParams<S extends Constraint> extends decodeTo<S, U
|
|
|
9849
10164
|
* Schema.decodeUnknownSync(schema)(urlSearchParams) // => { a: 1 }
|
|
9850
10165
|
* ```
|
|
9851
10166
|
*
|
|
10167
|
+
* @stability stable
|
|
9852
10168
|
* @category decoding
|
|
9853
10169
|
* @since 4.0.0
|
|
9854
10170
|
*/
|
|
@@ -9858,6 +10174,7 @@ export function fromURLSearchParams<S extends Constraint>(schema: S): fromURLSea
|
|
|
9858
10174
|
/**
|
|
9859
10175
|
* Type-level representation of {@link NumberFromString}.
|
|
9860
10176
|
*
|
|
10177
|
+
* @stability stable
|
|
9861
10178
|
* @category models
|
|
9862
10179
|
* @since 3.10.0
|
|
9863
10180
|
*/
|
|
@@ -9878,6 +10195,7 @@ export interface NumberFromString extends decodeTo<Number, String> {
|
|
|
9878
10195
|
* Encoding:
|
|
9879
10196
|
* A number is encoded as a `string`.
|
|
9880
10197
|
*
|
|
10198
|
+
* @stability stable
|
|
9881
10199
|
* @category schemas
|
|
9882
10200
|
* @since 3.10.0
|
|
9883
10201
|
*/
|
|
@@ -9887,6 +10205,7 @@ export const NumberFromString: NumberFromString = String.annotate({
|
|
|
9887
10205
|
/**
|
|
9888
10206
|
* Type-level representation of {@link FiniteFromString}.
|
|
9889
10207
|
*
|
|
10208
|
+
* @stability stable
|
|
9890
10209
|
* @category models
|
|
9891
10210
|
* @since 4.0.0
|
|
9892
10211
|
*/
|
|
@@ -9905,6 +10224,7 @@ export interface FiniteFromString extends decodeTo<Finite, String> {
|
|
|
9905
10224
|
* Encoding:
|
|
9906
10225
|
* - A finite number is encoded as a `string`.
|
|
9907
10226
|
*
|
|
10227
|
+
* @stability stable
|
|
9908
10228
|
* @category schemas
|
|
9909
10229
|
* @since 4.0.0
|
|
9910
10230
|
*/
|
|
@@ -9914,6 +10234,7 @@ export const FiniteFromString: FiniteFromString = String.annotate({
|
|
|
9914
10234
|
/**
|
|
9915
10235
|
* Type-level representation of {@link BigIntFromString}.
|
|
9916
10236
|
*
|
|
10237
|
+
* @stability stable
|
|
9917
10238
|
* @category models
|
|
9918
10239
|
* @since 4.0.0
|
|
9919
10240
|
*/
|
|
@@ -9945,6 +10266,7 @@ export interface BigIntFromString extends decodeTo<BigInt, String> {
|
|
|
9945
10266
|
* @see {@link NumberFromString} for parsing JavaScript number strings, including non-finite values
|
|
9946
10267
|
* @see {@link BigDecimalFromString} for parsing decimal number strings
|
|
9947
10268
|
*
|
|
10269
|
+
* @stability stable
|
|
9948
10270
|
* @category schemas
|
|
9949
10271
|
* @since 4.0.0
|
|
9950
10272
|
*/
|
|
@@ -9954,6 +10276,7 @@ export const BigIntFromString: BigIntFromString = make<String>(SchemaAST.bigIntS
|
|
|
9954
10276
|
/**
|
|
9955
10277
|
* Type-level representation of {@link Trimmed}.
|
|
9956
10278
|
*
|
|
10279
|
+
* @stability stable
|
|
9957
10280
|
* @category models
|
|
9958
10281
|
* @since 3.10.0
|
|
9959
10282
|
*/
|
|
@@ -9963,6 +10286,7 @@ export interface Trimmed extends String {
|
|
|
9963
10286
|
/**
|
|
9964
10287
|
* Schema for strings that contains no leading or trailing whitespaces.
|
|
9965
10288
|
*
|
|
10289
|
+
* @stability stable
|
|
9966
10290
|
* @category schemas
|
|
9967
10291
|
* @since 3.10.0
|
|
9968
10292
|
*/
|
|
@@ -9970,6 +10294,7 @@ export const Trimmed: Trimmed = String.check(isTrimmed())
|
|
|
9970
10294
|
/**
|
|
9971
10295
|
* Type-level representation of {@link Trim}.
|
|
9972
10296
|
*
|
|
10297
|
+
* @stability stable
|
|
9973
10298
|
* @category models
|
|
9974
10299
|
* @since 3.10.0
|
|
9975
10300
|
*/
|
|
@@ -9987,6 +10312,7 @@ export interface Trim extends decodeTo<Trimmed, String> {
|
|
|
9987
10312
|
* Encoding:
|
|
9988
10313
|
* - The trimmed string is encoded as is.
|
|
9989
10314
|
*
|
|
10315
|
+
* @stability stable
|
|
9990
10316
|
* @category schemas
|
|
9991
10317
|
* @since 3.10.0
|
|
9992
10318
|
*/
|
|
@@ -9996,6 +10322,7 @@ export const Trim: Trim = String.annotate({
|
|
|
9996
10322
|
/**
|
|
9997
10323
|
* Type-level representation of {@link StringFromBase64}.
|
|
9998
10324
|
*
|
|
10325
|
+
* @stability stable
|
|
9999
10326
|
* @category models
|
|
10000
10327
|
* @since 3.10.0
|
|
10001
10328
|
*/
|
|
@@ -10013,6 +10340,7 @@ export interface StringFromBase64 extends decodeTo<String, String> {
|
|
|
10013
10340
|
* Encoding:
|
|
10014
10341
|
* - A `string` is encoded as a base64-encoded string.
|
|
10015
10342
|
*
|
|
10343
|
+
* @stability stable
|
|
10016
10344
|
* @category schemas
|
|
10017
10345
|
* @since 3.10.0
|
|
10018
10346
|
*/
|
|
@@ -10024,6 +10352,7 @@ export const StringFromBase64: StringFromBase64 = String.annotate({
|
|
|
10024
10352
|
/**
|
|
10025
10353
|
* Type-level representation of {@link StringFromBase64Url}.
|
|
10026
10354
|
*
|
|
10355
|
+
* @stability stable
|
|
10027
10356
|
* @category models
|
|
10028
10357
|
* @since 3.10.0
|
|
10029
10358
|
*/
|
|
@@ -10041,6 +10370,7 @@ export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
|
10041
10370
|
* Encoding:
|
|
10042
10371
|
* - A `string` is encoded as a base64 (URL) encoded string.
|
|
10043
10372
|
*
|
|
10373
|
+
* @stability stable
|
|
10044
10374
|
* @category schemas
|
|
10045
10375
|
* @since 3.10.0
|
|
10046
10376
|
*/
|
|
@@ -10052,6 +10382,7 @@ export const StringFromBase64Url: StringFromBase64Url = String.annotate({
|
|
|
10052
10382
|
/**
|
|
10053
10383
|
* Type-level representation of {@link StringFromHex}.
|
|
10054
10384
|
*
|
|
10385
|
+
* @stability stable
|
|
10055
10386
|
* @category models
|
|
10056
10387
|
* @since 3.10.0
|
|
10057
10388
|
*/
|
|
@@ -10069,6 +10400,7 @@ export interface StringFromHex extends decodeTo<String, String> {
|
|
|
10069
10400
|
* Encoding:
|
|
10070
10401
|
* - A `string` is encoded as a hex string.
|
|
10071
10402
|
*
|
|
10403
|
+
* @stability stable
|
|
10072
10404
|
* @category schemas
|
|
10073
10405
|
* @since 3.10.0
|
|
10074
10406
|
*/
|
|
@@ -10080,6 +10412,7 @@ export const StringFromHex: StringFromHex = String.annotate({
|
|
|
10080
10412
|
/**
|
|
10081
10413
|
* Type-level representation of {@link StringFromUriComponent}.
|
|
10082
10414
|
*
|
|
10415
|
+
* @stability stable
|
|
10083
10416
|
* @category models
|
|
10084
10417
|
* @since 3.12.0
|
|
10085
10418
|
*/
|
|
@@ -10115,6 +10448,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
10115
10448
|
* Schema.encodeSync(UrlSchema)({ maxItemPerPage: 10, page: 1 }) // => "%7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D"
|
|
10116
10449
|
* ```
|
|
10117
10450
|
*
|
|
10451
|
+
* @stability stable
|
|
10118
10452
|
* @category schemas
|
|
10119
10453
|
* @since 3.12.0
|
|
10120
10454
|
*/
|
|
@@ -10127,6 +10461,7 @@ export const StringFromUriComponent: StringFromUriComponent = String.annotate({
|
|
|
10127
10461
|
* Schema for property keys accepted by Effect schemas: finite `number`,
|
|
10128
10462
|
* `symbol`, or `string`.
|
|
10129
10463
|
*
|
|
10464
|
+
* @stability stable
|
|
10130
10465
|
* @category schemas
|
|
10131
10466
|
* @since 4.0.0
|
|
10132
10467
|
*/
|
|
@@ -10139,6 +10474,7 @@ export const PropertyKey: Union<readonly [Finite, Symbol, String]> = Union([Fini
|
|
|
10139
10474
|
* The result contains an `issues` array where each issue has a message and an
|
|
10140
10475
|
* optional path made of property keys or keyed path segments.
|
|
10141
10476
|
*
|
|
10477
|
+
* @stability stable
|
|
10142
10478
|
* @category schemas
|
|
10143
10479
|
* @since 4.0.0
|
|
10144
10480
|
*/
|
|
@@ -10169,6 +10505,7 @@ export const StandardSchemaV1FailureResult: Struct<{
|
|
|
10169
10505
|
/**
|
|
10170
10506
|
* Type-level representation of {@link BooleanFromBit}.
|
|
10171
10507
|
*
|
|
10508
|
+
* @stability stable
|
|
10172
10509
|
* @category models
|
|
10173
10510
|
* @since 4.0.0
|
|
10174
10511
|
*/
|
|
@@ -10191,6 +10528,7 @@ export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0,
|
|
|
10191
10528
|
* @see {@link Boolean} for validating values that are already booleans
|
|
10192
10529
|
* @see {@link Literals} for keeping bit literals instead of decoding them
|
|
10193
10530
|
*
|
|
10531
|
+
* @stability stable
|
|
10194
10532
|
* @category schemas
|
|
10195
10533
|
* @since 4.0.0
|
|
10196
10534
|
*/
|
|
@@ -10206,6 +10544,7 @@ export const BooleanFromBit: BooleanFromBit = Literals([0, 1]).pipe(
|
|
|
10206
10544
|
/**
|
|
10207
10545
|
* Type-level representation of {@link Uint8Array}.
|
|
10208
10546
|
*
|
|
10547
|
+
* @stability stable
|
|
10209
10548
|
* @category models
|
|
10210
10549
|
* @since 4.0.0
|
|
10211
10550
|
*/
|
|
@@ -10227,6 +10566,7 @@ const Base64String = String.annotate({
|
|
|
10227
10566
|
*
|
|
10228
10567
|
* The default JSON serializer encodes Uint8Array as a Base64 encoded string.
|
|
10229
10568
|
*
|
|
10569
|
+
* @stability stable
|
|
10230
10570
|
* @category schemas
|
|
10231
10571
|
* @since 4.0.0
|
|
10232
10572
|
*/
|
|
@@ -10249,6 +10589,7 @@ export const Uint8Array: Uint8Array = instanceOf(globalThis.Uint8Array<ArrayBuff
|
|
|
10249
10589
|
/**
|
|
10250
10590
|
* Type-level representation of {@link Uint8ArrayFromBase64}.
|
|
10251
10591
|
*
|
|
10592
|
+
* @stability stable
|
|
10252
10593
|
* @category models
|
|
10253
10594
|
* @since 3.10.0
|
|
10254
10595
|
*/
|
|
@@ -10267,6 +10608,7 @@ export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
|
10267
10608
|
* Encoding:
|
|
10268
10609
|
* - A `Uint8Array` is encoded as a base64-encoded string.
|
|
10269
10610
|
*
|
|
10611
|
+
* @stability stable
|
|
10270
10612
|
* @category schemas
|
|
10271
10613
|
* @since 3.10.0
|
|
10272
10614
|
*/
|
|
@@ -10276,6 +10618,7 @@ export const Uint8ArrayFromBase64: Uint8ArrayFromBase64 = Base64String.pipe(
|
|
|
10276
10618
|
/**
|
|
10277
10619
|
* Type-level representation of {@link Uint8ArrayFromBase64Url}.
|
|
10278
10620
|
*
|
|
10621
|
+
* @stability stable
|
|
10279
10622
|
* @category models
|
|
10280
10623
|
* @since 3.10.0
|
|
10281
10624
|
*/
|
|
@@ -10294,6 +10637,7 @@ export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
|
10294
10637
|
* Encoding:
|
|
10295
10638
|
* - A `Uint8Array` is encoded as a base64 (URL) encoded string.
|
|
10296
10639
|
*
|
|
10640
|
+
* @stability stable
|
|
10297
10641
|
* @category schemas
|
|
10298
10642
|
* @since 3.10.0
|
|
10299
10643
|
*/
|
|
@@ -10308,6 +10652,7 @@ export const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url = String.annotate(
|
|
|
10308
10652
|
/**
|
|
10309
10653
|
* Type-level representation of {@link Uint8ArrayFromHex}.
|
|
10310
10654
|
*
|
|
10655
|
+
* @stability stable
|
|
10311
10656
|
* @category models
|
|
10312
10657
|
* @since 3.10.0
|
|
10313
10658
|
*/
|
|
@@ -10326,6 +10671,7 @@ export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
|
10326
10671
|
* Encoding:
|
|
10327
10672
|
* - A `Uint8Array` is encoded as a hex encoded string.
|
|
10328
10673
|
*
|
|
10674
|
+
* @stability stable
|
|
10329
10675
|
* @category schemas
|
|
10330
10676
|
* @since 3.10.0
|
|
10331
10677
|
*/
|
|
@@ -10361,6 +10707,7 @@ const bigDecimalFromString: SchemaTransformation.Transformation<BigDecimal_.BigD
|
|
|
10361
10707
|
/**
|
|
10362
10708
|
* Validates that a BigDecimal is greater than the specified value (exclusive).
|
|
10363
10709
|
*
|
|
10710
|
+
* @stability stable
|
|
10364
10711
|
* @category validation
|
|
10365
10712
|
* @since 4.0.0
|
|
10366
10713
|
*/
|
|
@@ -10375,6 +10722,7 @@ export const isGreaterThanBigDecimal: (
|
|
|
10375
10722
|
* Validates that a BigDecimal is greater than or equal to the specified value
|
|
10376
10723
|
* (inclusive).
|
|
10377
10724
|
*
|
|
10725
|
+
* @stability stable
|
|
10378
10726
|
* @category validation
|
|
10379
10727
|
* @since 4.0.0
|
|
10380
10728
|
*/
|
|
@@ -10388,6 +10736,7 @@ export const isGreaterThanOrEqualToBigDecimal: (
|
|
|
10388
10736
|
/**
|
|
10389
10737
|
* Validates that a BigDecimal is less than the specified value (exclusive).
|
|
10390
10738
|
*
|
|
10739
|
+
* @stability stable
|
|
10391
10740
|
* @category validation
|
|
10392
10741
|
* @since 4.0.0
|
|
10393
10742
|
*/
|
|
@@ -10402,6 +10751,7 @@ export const isLessThanBigDecimal: (
|
|
|
10402
10751
|
* Validates that a BigDecimal is less than or equal to the specified value
|
|
10403
10752
|
* (inclusive).
|
|
10404
10753
|
*
|
|
10754
|
+
* @stability stable
|
|
10405
10755
|
* @category validation
|
|
10406
10756
|
* @since 4.0.0
|
|
10407
10757
|
*/
|
|
@@ -10420,6 +10770,7 @@ export const isLessThanOrEqualToBigDecimal: (
|
|
|
10420
10770
|
* The minimum and maximum boundaries are inclusive by default. Pass
|
|
10421
10771
|
* `exclusiveMinimum` or `exclusiveMaximum` to exclude either boundary.
|
|
10422
10772
|
*
|
|
10773
|
+
* @stability stable
|
|
10423
10774
|
* @category validation
|
|
10424
10775
|
* @since 4.0.0
|
|
10425
10776
|
*/
|
|
@@ -10435,6 +10786,7 @@ export const isBetweenBigDecimal: (options: {
|
|
|
10435
10786
|
/**
|
|
10436
10787
|
* Type-level representation of {@link BigDecimal}.
|
|
10437
10788
|
*
|
|
10789
|
+
* @stability stable
|
|
10438
10790
|
* @category models
|
|
10439
10791
|
* @since 3.10.0
|
|
10440
10792
|
*/
|
|
@@ -10458,6 +10810,7 @@ const BigDecimalString = String.annotate({ expected: "a string that will be deco
|
|
|
10458
10810
|
*
|
|
10459
10811
|
* @see {@link BigDecimalFromString} for parsing string input into a BigDecimal
|
|
10460
10812
|
*
|
|
10813
|
+
* @stability stable
|
|
10461
10814
|
* @category schemas
|
|
10462
10815
|
* @since 3.10.0
|
|
10463
10816
|
*/
|
|
@@ -10485,6 +10838,7 @@ export const BigDecimal: BigDecimal = declare(
|
|
|
10485
10838
|
/**
|
|
10486
10839
|
* Type-level representation of {@link BigDecimalFromString}.
|
|
10487
10840
|
*
|
|
10841
|
+
* @stability stable
|
|
10488
10842
|
* @category models
|
|
10489
10843
|
* @since 4.0.0
|
|
10490
10844
|
*/
|
|
@@ -10515,6 +10869,7 @@ export interface BigDecimalFromString extends decodeTo<BigDecimal, String> {
|
|
|
10515
10869
|
* @see {@link BigIntFromString} for parsing base-10 integer strings into bigint values
|
|
10516
10870
|
* @see {@link NumberFromString} for parsing JavaScript number strings
|
|
10517
10871
|
*
|
|
10872
|
+
* @stability stable
|
|
10518
10873
|
* @category schemas
|
|
10519
10874
|
* @since 4.0.0
|
|
10520
10875
|
*/
|
|
@@ -10529,6 +10884,7 @@ export const BigDecimalFromString: BigDecimalFromString = BigDecimalString.pipe(
|
|
|
10529
10884
|
/**
|
|
10530
10885
|
* Type-level representation of {@link ByteSize}.
|
|
10531
10886
|
*
|
|
10887
|
+
* @stability unstable
|
|
10532
10888
|
* @category models
|
|
10533
10889
|
* @since 4.0.0
|
|
10534
10890
|
*/
|
|
@@ -10544,6 +10900,7 @@ export interface ByteSize extends declare<ByteSize_.ByteSize> {
|
|
|
10544
10900
|
* beyond JavaScript's safe-integer range. The StringTree codec uses the
|
|
10545
10901
|
* human-readable byte-size syntax exposed by {@link ByteSizeFromString}.
|
|
10546
10902
|
*
|
|
10903
|
+
* @stability unstable
|
|
10547
10904
|
* @category schemas
|
|
10548
10905
|
* @since 4.0.0
|
|
10549
10906
|
*/
|
|
@@ -10579,6 +10936,7 @@ const ByteSizeString = String.annotate({ expected: "a string that will be decode
|
|
|
10579
10936
|
/**
|
|
10580
10937
|
* Type-level representation of {@link ByteSizeFromString}.
|
|
10581
10938
|
*
|
|
10939
|
+
* @stability unstable
|
|
10582
10940
|
* @category models
|
|
10583
10941
|
* @since 4.0.0
|
|
10584
10942
|
*/
|
|
@@ -10611,6 +10969,7 @@ export interface ByteSizeFromString extends decodeTo<ByteSize, String> {
|
|
|
10611
10969
|
* A unit is required. Signs, exponent notation, digit separators, and ambiguous
|
|
10612
10970
|
* unit spellings such as `KB`, `mb`, `Mb`, or `b` are rejected.
|
|
10613
10971
|
*
|
|
10972
|
+
* @stability unstable
|
|
10614
10973
|
* @category schemas
|
|
10615
10974
|
* @since 4.0.0
|
|
10616
10975
|
*/
|
|
@@ -10620,6 +10979,7 @@ export const ByteSizeFromString: ByteSizeFromString = ByteSizeString.pipe(
|
|
|
10620
10979
|
/**
|
|
10621
10980
|
* Type-level representation of {@link ByteSizeFromBigInt}.
|
|
10622
10981
|
*
|
|
10982
|
+
* @stability unstable
|
|
10623
10983
|
* @category models
|
|
10624
10984
|
* @since 4.0.0
|
|
10625
10985
|
*/
|
|
@@ -10629,6 +10989,7 @@ export interface ByteSizeFromBigInt extends decodeTo<ByteSize, BigInt> {
|
|
|
10629
10989
|
/**
|
|
10630
10990
|
* Schema that decodes non-negative bigint byte counts.
|
|
10631
10991
|
*
|
|
10992
|
+
* @stability unstable
|
|
10632
10993
|
* @category schemas
|
|
10633
10994
|
* @since 4.0.0
|
|
10634
10995
|
*/
|
|
@@ -10638,6 +10999,7 @@ export const ByteSizeFromBigInt: ByteSizeFromBigInt = BigInt.pipe(
|
|
|
10638
10999
|
/**
|
|
10639
11000
|
* Type-level representation of {@link ByteSizeFromNumber}.
|
|
10640
11001
|
*
|
|
11002
|
+
* @stability unstable
|
|
10641
11003
|
* @category models
|
|
10642
11004
|
* @since 4.0.0
|
|
10643
11005
|
*/
|
|
@@ -10651,6 +11013,7 @@ export interface ByteSizeFromNumber extends decodeTo<ByteSize, Number> {
|
|
|
10651
11013
|
*
|
|
10652
11014
|
* Encoding fails when the byte count exceeds `Number.MAX_SAFE_INTEGER`.
|
|
10653
11015
|
*
|
|
11016
|
+
* @stability unstable
|
|
10654
11017
|
* @category schemas
|
|
10655
11018
|
* @since 4.0.0
|
|
10656
11019
|
*/
|
|
@@ -10665,6 +11028,7 @@ export const ByteSizeFromNumber: ByteSizeFromNumber = Number.pipe(
|
|
|
10665
11028
|
/**
|
|
10666
11029
|
* Type-level representation returned by {@link CauseReason}.
|
|
10667
11030
|
*
|
|
11031
|
+
* @stability stable
|
|
10668
11032
|
* @category models
|
|
10669
11033
|
* @since 4.0.0
|
|
10670
11034
|
*/
|
|
@@ -10688,6 +11052,7 @@ export interface CauseReason<E extends Constraint, D extends Constraint> extends
|
|
|
10688
11052
|
* Failures are represented with a `Fail` tag and encoded error, defects with a
|
|
10689
11053
|
* `Die` tag and encoded defect, and interrupts with an optional `fiberId`.
|
|
10690
11054
|
*
|
|
11055
|
+
* @stability stable
|
|
10691
11056
|
* @category utility types
|
|
10692
11057
|
* @since 4.0.0
|
|
10693
11058
|
*/
|
|
@@ -10718,6 +11083,7 @@ export type CauseReasonIso<E extends Constraint, D extends Constraint> = {
|
|
|
10718
11083
|
* @see {@link Cause} for constructing schemas for full Cause values
|
|
10719
11084
|
* @see {@link CauseReasonIso} for the ISO shape of each cause reason
|
|
10720
11085
|
*
|
|
11086
|
+
* @stability stable
|
|
10721
11087
|
* @category schemas
|
|
10722
11088
|
* @since 4.0.0
|
|
10723
11089
|
*/
|
|
@@ -10807,6 +11173,7 @@ export function CauseReason<E extends Constraint, D extends Constraint>(
|
|
|
10807
11173
|
/**
|
|
10808
11174
|
* Type-level representation returned by {@link Cause}.
|
|
10809
11175
|
*
|
|
11176
|
+
* @stability stable
|
|
10810
11177
|
* @category models
|
|
10811
11178
|
* @since 3.10.0
|
|
10812
11179
|
*/
|
|
@@ -10834,6 +11201,7 @@ export interface Cause<E extends Constraint, D extends Constraint> extends
|
|
|
10834
11201
|
* @see {@link Cause} for constructing schemas for full Cause values
|
|
10835
11202
|
* @see {@link CauseReasonIso} for the ISO shape of each array element
|
|
10836
11203
|
*
|
|
11204
|
+
* @stability stable
|
|
10837
11205
|
* @category utility types
|
|
10838
11206
|
* @since 4.0.0
|
|
10839
11207
|
*/
|
|
@@ -10856,6 +11224,7 @@ export type CauseIso<E extends Constraint, D extends Constraint> = ReadonlyArray
|
|
|
10856
11224
|
* @see {@link CauseReason} for the schema used by each individual cause reason
|
|
10857
11225
|
* @see {@link CauseIso} for the ordered array representation used by the schema ISO
|
|
10858
11226
|
*
|
|
11227
|
+
* @stability stable
|
|
10859
11228
|
* @category schemas
|
|
10860
11229
|
* @since 3.10.0
|
|
10861
11230
|
*/
|
|
@@ -10914,6 +11283,7 @@ function chunkLink<Value>(values: Schema<ReadonlyArray<Value>>) {
|
|
|
10914
11283
|
/**
|
|
10915
11284
|
* Type-level representation returned by {@link Chunk}.
|
|
10916
11285
|
*
|
|
11286
|
+
* @stability stable
|
|
10917
11287
|
* @category models
|
|
10918
11288
|
* @since 3.10.0
|
|
10919
11289
|
*/
|
|
@@ -10939,6 +11309,7 @@ export interface Chunk<Value extends Constraint> extends
|
|
|
10939
11309
|
*
|
|
10940
11310
|
* @see {@link Chunk} for the schema interface and constructor that use this ISO representation
|
|
10941
11311
|
*
|
|
11312
|
+
* @stability stable
|
|
10942
11313
|
* @category utility types
|
|
10943
11314
|
* @since 4.0.0
|
|
10944
11315
|
*/
|
|
@@ -10946,6 +11317,7 @@ export type ChunkIso<Value extends Constraint> = ReadonlyArray<Value["Iso"]>
|
|
|
10946
11317
|
/**
|
|
10947
11318
|
* Schema for chunks whose values conform to the provided element schema.
|
|
10948
11319
|
*
|
|
11320
|
+
* @stability stable
|
|
10949
11321
|
* @category schemas
|
|
10950
11322
|
* @since 3.10.0
|
|
10951
11323
|
*/
|
|
@@ -11128,6 +11500,7 @@ function timeZoneArbitrarySchema(): Codec<number | string> {
|
|
|
11128
11500
|
/**
|
|
11129
11501
|
* Type-level representation of {@link DateTimeUtc}.
|
|
11130
11502
|
*
|
|
11503
|
+
* @stability stable
|
|
11131
11504
|
* @category models
|
|
11132
11505
|
* @since 3.10.0
|
|
11133
11506
|
*/
|
|
@@ -11152,6 +11525,7 @@ export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
|
11152
11525
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
11153
11526
|
* @see {@link DateTimeZoned} for preserving zoned DateTime values
|
|
11154
11527
|
*
|
|
11528
|
+
* @stability stable
|
|
11155
11529
|
* @category schemas
|
|
11156
11530
|
* @since 3.10.0
|
|
11157
11531
|
*/
|
|
@@ -11190,6 +11564,7 @@ export const DateTimeUtc: DateTimeUtc = declare(
|
|
|
11190
11564
|
/**
|
|
11191
11565
|
* Type-level representation of {@link DateTimeUtcFromDate}.
|
|
11192
11566
|
*
|
|
11567
|
+
* @stability stable
|
|
11193
11568
|
* @category models
|
|
11194
11569
|
* @since 3.12.0
|
|
11195
11570
|
*/
|
|
@@ -11217,6 +11592,7 @@ export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
|
11217
11592
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
11218
11593
|
* @see {@link Date} for validating Date instances without converting them
|
|
11219
11594
|
*
|
|
11595
|
+
* @stability stable
|
|
11220
11596
|
* @category schemas
|
|
11221
11597
|
* @since 3.12.0
|
|
11222
11598
|
*/
|
|
@@ -11229,6 +11605,7 @@ export const DateTimeUtcFromDate: DateTimeUtcFromDate = Date.pipe(
|
|
|
11229
11605
|
/**
|
|
11230
11606
|
* Type-level representation of {@link DateTimeUtcFromString}.
|
|
11231
11607
|
*
|
|
11608
|
+
* @stability stable
|
|
11232
11609
|
* @category models
|
|
11233
11610
|
* @since 4.0.0
|
|
11234
11611
|
*/
|
|
@@ -11253,6 +11630,7 @@ export interface DateTimeUtcFromString extends decodeTo<DateTimeUtc, String> {
|
|
|
11253
11630
|
* @see {@link DateTimeUtcFromMillis} for decoding epoch milliseconds into UTC values
|
|
11254
11631
|
* @see {@link DateFromString} for decoding strings into JavaScript Date instances
|
|
11255
11632
|
*
|
|
11633
|
+
* @stability stable
|
|
11256
11634
|
* @category schemas
|
|
11257
11635
|
* @since 4.0.0
|
|
11258
11636
|
*/
|
|
@@ -11267,6 +11645,7 @@ export const DateTimeUtcFromString: DateTimeUtcFromString = String.annotate({
|
|
|
11267
11645
|
/**
|
|
11268
11646
|
* Type-level representation of {@link DateTimeUtcFromMillis}.
|
|
11269
11647
|
*
|
|
11648
|
+
* @stability stable
|
|
11270
11649
|
* @category models
|
|
11271
11650
|
* @since 4.0.0
|
|
11272
11651
|
*/
|
|
@@ -11288,6 +11667,7 @@ export interface DateTimeUtcFromMillis extends decodeTo<instanceOf<DateTime.Utc>
|
|
|
11288
11667
|
* @see {@link DateTimeUtcFromString} for decoding date-time strings into UTC values
|
|
11289
11668
|
* @see {@link DateFromMillis} for decoding epoch milliseconds into JavaScript Date instances
|
|
11290
11669
|
*
|
|
11670
|
+
* @stability stable
|
|
11291
11671
|
* @category schemas
|
|
11292
11672
|
* @since 4.0.0
|
|
11293
11673
|
*/
|
|
@@ -11300,6 +11680,7 @@ export const DateTimeUtcFromMillis: DateTimeUtcFromMillis = Int.pipe(
|
|
|
11300
11680
|
/**
|
|
11301
11681
|
* Type-level representation of {@link TimeZoneOffset}.
|
|
11302
11682
|
*
|
|
11683
|
+
* @stability stable
|
|
11303
11684
|
* @category models
|
|
11304
11685
|
* @since 3.10.0
|
|
11305
11686
|
*/
|
|
@@ -11315,6 +11696,7 @@ export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
|
11315
11696
|
*
|
|
11316
11697
|
* - encodes `DateTime.TimeZone.Offset` as a number (offset in milliseconds)
|
|
11317
11698
|
*
|
|
11699
|
+
* @stability stable
|
|
11318
11700
|
* @category schemas
|
|
11319
11701
|
* @since 3.10.0
|
|
11320
11702
|
*/
|
|
@@ -11342,6 +11724,7 @@ export const TimeZoneOffset: TimeZoneOffset = declare(
|
|
|
11342
11724
|
/**
|
|
11343
11725
|
* Type-level representation of {@link TimeZoneNamed}.
|
|
11344
11726
|
*
|
|
11727
|
+
* @stability stable
|
|
11345
11728
|
* @category models
|
|
11346
11729
|
* @since 3.10.0
|
|
11347
11730
|
*/
|
|
@@ -11358,6 +11741,7 @@ const TimeZoneNamedString = String.annotate({ expected: "an IANA time zone ident
|
|
|
11358
11741
|
*
|
|
11359
11742
|
* - encodes `DateTime.TimeZone.Named` as a string (IANA time zone identifier)
|
|
11360
11743
|
*
|
|
11744
|
+
* @stability stable
|
|
11361
11745
|
* @category schemas
|
|
11362
11746
|
* @since 3.10.0
|
|
11363
11747
|
*/
|
|
@@ -11390,6 +11774,7 @@ export const TimeZoneNamed: TimeZoneNamed = declare(
|
|
|
11390
11774
|
/**
|
|
11391
11775
|
* Type-level representation of {@link TimeZoneNamedFromString}.
|
|
11392
11776
|
*
|
|
11777
|
+
* @stability stable
|
|
11393
11778
|
* @category models
|
|
11394
11779
|
* @since 4.0.0
|
|
11395
11780
|
*/
|
|
@@ -11407,6 +11792,7 @@ export interface TimeZoneNamedFromString extends decodeTo<TimeZoneNamed, String>
|
|
|
11407
11792
|
* Encoding:
|
|
11408
11793
|
* - A `DateTime.TimeZone.Named` is encoded as a `string`.
|
|
11409
11794
|
*
|
|
11795
|
+
* @stability stable
|
|
11410
11796
|
* @category schemas
|
|
11411
11797
|
* @since 4.0.0
|
|
11412
11798
|
*/
|
|
@@ -11416,6 +11802,7 @@ export const TimeZoneNamedFromString: TimeZoneNamedFromString = TimeZoneNamedStr
|
|
|
11416
11802
|
/**
|
|
11417
11803
|
* Type-level representation of {@link TimeZone}.
|
|
11418
11804
|
*
|
|
11805
|
+
* @stability stable
|
|
11419
11806
|
* @category models
|
|
11420
11807
|
* @since 3.10.0
|
|
11421
11808
|
*/
|
|
@@ -11435,6 +11822,7 @@ const TimeZoneString = String.annotate({
|
|
|
11435
11822
|
* - encodes `DateTime.TimeZone` as a string (IANA identifier or offset like
|
|
11436
11823
|
* `+03:00`)
|
|
11437
11824
|
*
|
|
11825
|
+
* @stability stable
|
|
11438
11826
|
* @category schemas
|
|
11439
11827
|
* @since 3.10.0
|
|
11440
11828
|
*/
|
|
@@ -11469,6 +11857,7 @@ export const TimeZone: TimeZone = declare(
|
|
|
11469
11857
|
/**
|
|
11470
11858
|
* Type-level representation of {@link TimeZoneFromString}.
|
|
11471
11859
|
*
|
|
11860
|
+
* @stability stable
|
|
11472
11861
|
* @category models
|
|
11473
11862
|
* @since 4.0.0
|
|
11474
11863
|
*/
|
|
@@ -11486,6 +11875,7 @@ export interface TimeZoneFromString extends decodeTo<TimeZone, String> {
|
|
|
11486
11875
|
* Encoding:
|
|
11487
11876
|
* - A `DateTime.TimeZone` is encoded as a `string`.
|
|
11488
11877
|
*
|
|
11878
|
+
* @stability stable
|
|
11489
11879
|
* @category schemas
|
|
11490
11880
|
* @since 4.0.0
|
|
11491
11881
|
*/
|
|
@@ -11495,6 +11885,7 @@ export const TimeZoneFromString: TimeZoneFromString = TimeZoneString.pipe(
|
|
|
11495
11885
|
/**
|
|
11496
11886
|
* Type-level representation of {@link DateTimeZoned}.
|
|
11497
11887
|
*
|
|
11888
|
+
* @stability stable
|
|
11498
11889
|
* @category models
|
|
11499
11890
|
* @since 3.10.0
|
|
11500
11891
|
*/
|
|
@@ -11516,6 +11907,7 @@ const DateTimeZonedString = String.annotate({
|
|
|
11516
11907
|
* - encodes named zones by appending the IANA identifier in brackets, such as
|
|
11517
11908
|
* `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`
|
|
11518
11909
|
*
|
|
11910
|
+
* @stability stable
|
|
11519
11911
|
* @category schemas
|
|
11520
11912
|
* @since 3.10.0
|
|
11521
11913
|
*/
|
|
@@ -11560,6 +11952,7 @@ export const DateTimeZoned: DateTimeZoned = declare(
|
|
|
11560
11952
|
/**
|
|
11561
11953
|
* Type-level representation of {@link DateTimeZonedFromString}.
|
|
11562
11954
|
*
|
|
11955
|
+
* @stability stable
|
|
11563
11956
|
* @category models
|
|
11564
11957
|
* @since 4.0.0
|
|
11565
11958
|
*/
|
|
@@ -11577,6 +11970,7 @@ export interface DateTimeZonedFromString extends decodeTo<DateTimeZoned, String>
|
|
|
11577
11970
|
* Encoding:
|
|
11578
11971
|
* - A `DateTime.Zoned` is encoded as a `string`.
|
|
11579
11972
|
*
|
|
11973
|
+
* @stability stable
|
|
11580
11974
|
* @category schemas
|
|
11581
11975
|
* @since 4.0.0
|
|
11582
11976
|
*/
|
|
@@ -12982,6 +13376,7 @@ const durationFromMillis: SchemaTransformation.Transformation<Duration_.Duration
|
|
|
12982
13376
|
/**
|
|
12983
13377
|
* Type-level representation of {@link Duration}.
|
|
12984
13378
|
*
|
|
13379
|
+
* @stability stable
|
|
12985
13380
|
* @category models
|
|
12986
13381
|
* @since 3.10.0
|
|
12987
13382
|
*/
|
|
@@ -13004,6 +13399,7 @@ export interface Duration extends declare<Duration_.Duration> {
|
|
|
13004
13399
|
* Schema.decodeUnknownSync(Schema.Duration)(Duration.seconds(5)) // => Duration.seconds(5)
|
|
13005
13400
|
* ```
|
|
13006
13401
|
*
|
|
13402
|
+
* @stability stable
|
|
13007
13403
|
* @category schemas
|
|
13008
13404
|
*
|
|
13009
13405
|
* @since 3.10.0
|
|
@@ -13062,6 +13458,7 @@ const DurationString = String.annotate({ expected: "a string that will be decode
|
|
|
13062
13458
|
/**
|
|
13063
13459
|
* Type-level representation of {@link DurationFromString}.
|
|
13064
13460
|
*
|
|
13461
|
+
* @stability stable
|
|
13065
13462
|
* @category models
|
|
13066
13463
|
* @since 4.0.0
|
|
13067
13464
|
*/
|
|
@@ -13080,6 +13477,7 @@ export interface DurationFromString extends decodeTo<Duration, String> {
|
|
|
13080
13477
|
* Encoding:
|
|
13081
13478
|
* - A `Duration` is encoded as a parseable `string`.
|
|
13082
13479
|
*
|
|
13480
|
+
* @stability stable
|
|
13083
13481
|
* @category schemas
|
|
13084
13482
|
* @since 4.0.0
|
|
13085
13483
|
*/
|
|
@@ -13089,6 +13487,7 @@ export const DurationFromString: DurationFromString = DurationString.pipe(
|
|
|
13089
13487
|
/**
|
|
13090
13488
|
* Type-level representation of {@link DurationFromNanos}.
|
|
13091
13489
|
*
|
|
13490
|
+
* @stability stable
|
|
13092
13491
|
* @category models
|
|
13093
13492
|
* @since 3.10.0
|
|
13094
13493
|
*/
|
|
@@ -13109,6 +13508,7 @@ export interface DurationFromNanos extends decodeTo<Duration, BigInt> {
|
|
|
13109
13508
|
* fails when the duration cannot be represented as nanoseconds, such as
|
|
13110
13509
|
* `Duration.infinity` or `Duration.negativeInfinity`.
|
|
13111
13510
|
*
|
|
13511
|
+
* @stability stable
|
|
13112
13512
|
* @category schemas
|
|
13113
13513
|
* @since 3.10.0
|
|
13114
13514
|
*/
|
|
@@ -13118,6 +13518,7 @@ export const DurationFromNanos: DurationFromNanos = BigInt.pipe(
|
|
|
13118
13518
|
/**
|
|
13119
13519
|
* Type-level representation of {@link DurationFromMillis}.
|
|
13120
13520
|
*
|
|
13521
|
+
* @stability stable
|
|
13121
13522
|
* @category models
|
|
13122
13523
|
* @since 3.10.0
|
|
13123
13524
|
*/
|
|
@@ -13140,6 +13541,7 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
|
13140
13541
|
*
|
|
13141
13542
|
* `NaN` is decoded as `Duration.zero`, matching `Duration.millis`.
|
|
13142
13543
|
*
|
|
13544
|
+
* @stability stable
|
|
13143
13545
|
* @category schemas
|
|
13144
13546
|
* @since 3.10.0
|
|
13145
13547
|
*/
|
|
@@ -13154,6 +13556,7 @@ export const DurationFromMillis: DurationFromMillis = Number.pipe(
|
|
|
13154
13556
|
/**
|
|
13155
13557
|
* Type-level representation returned by {@link Exit}.
|
|
13156
13558
|
*
|
|
13559
|
+
* @stability stable
|
|
13157
13560
|
* @category models
|
|
13158
13561
|
* @since 3.10.0
|
|
13159
13562
|
*/
|
|
@@ -13178,6 +13581,7 @@ export interface Exit<A extends Constraint, E extends Constraint, D extends Cons
|
|
|
13178
13581
|
* Successful exits are represented as `{ _tag: "Success", value }`, while failed
|
|
13179
13582
|
* exits are represented as `{ _tag: "Failure", cause }`.
|
|
13180
13583
|
*
|
|
13584
|
+
* @stability stable
|
|
13181
13585
|
* @category utility types
|
|
13182
13586
|
* @since 4.0.0
|
|
13183
13587
|
*/
|
|
@@ -13197,6 +13601,7 @@ export type ExitIso<A extends Constraint, E extends Constraint, D extends Constr
|
|
|
13197
13601
|
* Use when serializing or validating an effect outcome where success, typed
|
|
13198
13602
|
* failure, and defects each need their own schema.
|
|
13199
13603
|
*
|
|
13604
|
+
* @stability stable
|
|
13200
13605
|
* @category schemas
|
|
13201
13606
|
* @since 3.10.0
|
|
13202
13607
|
*/
|
|
@@ -13284,6 +13689,7 @@ export function Exit<
|
|
|
13284
13689
|
/**
|
|
13285
13690
|
* Encoded representation of an immutable Effect graph.
|
|
13286
13691
|
*
|
|
13692
|
+
* @stability unstable
|
|
13287
13693
|
* @category models
|
|
13288
13694
|
* @since 4.0.0
|
|
13289
13695
|
*/
|
|
@@ -13291,6 +13697,7 @@ export type EncodedGraph<N, E, T extends Graph_.Kind> = Graph_.Snapshot<N, E, T>
|
|
|
13291
13697
|
/**
|
|
13292
13698
|
* Iso representation used for {@link Graph} schemas.
|
|
13293
13699
|
*
|
|
13700
|
+
* @stability unstable
|
|
13294
13701
|
* @category utility types
|
|
13295
13702
|
* @since 4.0.0
|
|
13296
13703
|
*/
|
|
@@ -13302,6 +13709,7 @@ export type GraphIso<T extends Graph_.Kind, Node extends Constraint, Edge extend
|
|
|
13302
13709
|
/**
|
|
13303
13710
|
* Type-level representation returned by {@link Graph}.
|
|
13304
13711
|
*
|
|
13712
|
+
* @stability unstable
|
|
13305
13713
|
* @category models
|
|
13306
13714
|
* @since 4.0.0
|
|
13307
13715
|
*/
|
|
@@ -13480,6 +13888,7 @@ function graphToArbitrary<N, E, T extends Graph_.Kind>(
|
|
|
13480
13888
|
* encoded.edges // => [{ index: 0, source: 0, target: 1, data: 1 }]
|
|
13481
13889
|
* ```
|
|
13482
13890
|
*
|
|
13891
|
+
* @stability unstable
|
|
13483
13892
|
* @category schemas
|
|
13484
13893
|
* @since 4.0.0
|
|
13485
13894
|
*/
|
|
@@ -13563,6 +13972,7 @@ function hashMapLink<Key, Value>(entries: Schema<ReadonlyArray<readonly [Key, Va
|
|
|
13563
13972
|
/**
|
|
13564
13973
|
* Type-level representation returned by {@link HashMap}.
|
|
13565
13974
|
*
|
|
13975
|
+
* @stability stable
|
|
13566
13976
|
* @category models
|
|
13567
13977
|
* @since 3.10.0
|
|
13568
13978
|
*/
|
|
@@ -13582,6 +13992,7 @@ export interface HashMap<Key extends Constraint, Value extends Constraint> exten
|
|
|
13582
13992
|
* Iso representation used for `HashMap` schemas: an array of readonly
|
|
13583
13993
|
* `[key, value]` tuples using each entry schema's `Iso` type.
|
|
13584
13994
|
*
|
|
13995
|
+
* @stability stable
|
|
13585
13996
|
* @category utility types
|
|
13586
13997
|
* @since 4.0.0
|
|
13587
13998
|
*/
|
|
@@ -13591,6 +14002,7 @@ export type HashMapIso<Key extends Constraint, Value extends Constraint> = Reado
|
|
|
13591
14002
|
/**
|
|
13592
14003
|
* Schema for hash maps whose keys and values conform to the provided schemas.
|
|
13593
14004
|
*
|
|
14005
|
+
* @stability stable
|
|
13594
14006
|
* @category schemas
|
|
13595
14007
|
* @since 3.10.0
|
|
13596
14008
|
*/
|
|
@@ -13658,6 +14070,7 @@ function hashSetLink<Value>(values: Schema<ReadonlyArray<Value>>) {
|
|
|
13658
14070
|
/**
|
|
13659
14071
|
* Type-level representation returned by {@link HashSet}.
|
|
13660
14072
|
*
|
|
14073
|
+
* @stability stable
|
|
13661
14074
|
* @category models
|
|
13662
14075
|
* @since 3.10.0
|
|
13663
14076
|
*/
|
|
@@ -13676,6 +14089,7 @@ export interface HashSet<Value extends Constraint> extends
|
|
|
13676
14089
|
* Iso representation used for `HashSet` schemas: an array of element values
|
|
13677
14090
|
* using the element schema's `Iso` type.
|
|
13678
14091
|
*
|
|
14092
|
+
* @stability stable
|
|
13679
14093
|
* @category utility types
|
|
13680
14094
|
* @since 4.0.0
|
|
13681
14095
|
*/
|
|
@@ -13683,6 +14097,7 @@ export type HashSetIso<Value extends Constraint> = ReadonlyArray<Value["Iso"]>
|
|
|
13683
14097
|
/**
|
|
13684
14098
|
* Schema for hash sets whose values conform to the provided element schema.
|
|
13685
14099
|
*
|
|
14100
|
+
* @stability stable
|
|
13686
14101
|
* @category schemas
|
|
13687
14102
|
* @since 3.10.0
|
|
13688
14103
|
*/
|
|
@@ -13740,6 +14155,7 @@ export function HashSet<Value extends Constraint>(value: Value): HashSet<Value>
|
|
|
13740
14155
|
/**
|
|
13741
14156
|
* Type-level representation returned by {@link Option}.
|
|
13742
14157
|
*
|
|
14158
|
+
* @stability stable
|
|
13743
14159
|
* @category models
|
|
13744
14160
|
* @since 3.10.0
|
|
13745
14161
|
*/
|
|
@@ -13762,6 +14178,7 @@ export interface Option<A extends Constraint> extends
|
|
|
13762
14178
|
* `None` is represented as `{ _tag: "None" }`, while `Some` is represented as
|
|
13763
14179
|
* `{ _tag: "Some", value }` using the wrapped schema's `Iso` type.
|
|
13764
14180
|
*
|
|
14181
|
+
* @stability stable
|
|
13765
14182
|
* @category utility types
|
|
13766
14183
|
* @since 4.0.0
|
|
13767
14184
|
*/
|
|
@@ -13774,6 +14191,7 @@ export type OptionIso<A extends Constraint> = {
|
|
|
13774
14191
|
/**
|
|
13775
14192
|
* Schema for `Option<A>` values.
|
|
13776
14193
|
*
|
|
14194
|
+
* @stability stable
|
|
13777
14195
|
* @category schemas
|
|
13778
14196
|
* @since 3.10.0
|
|
13779
14197
|
*/
|
|
@@ -13828,6 +14246,7 @@ export function Option<A extends Constraint>(value: A): Option<A> {
|
|
|
13828
14246
|
/**
|
|
13829
14247
|
* Type-level representation returned by {@link OptionFromNullOr}.
|
|
13830
14248
|
*
|
|
14249
|
+
* @stability stable
|
|
13831
14250
|
* @category models
|
|
13832
14251
|
* @since 3.10.0
|
|
13833
14252
|
*/
|
|
@@ -13842,6 +14261,7 @@ export interface OptionFromNullOr<S extends Constraint> extends decodeTo<Option<
|
|
|
13842
14261
|
* Decoding maps `null` to `None` and all other values to `Some`. Encoding maps
|
|
13843
14262
|
* `None` to `null` and maps `Some` to its value.
|
|
13844
14263
|
*
|
|
14264
|
+
* @stability stable
|
|
13845
14265
|
* @category schemas
|
|
13846
14266
|
* @since 3.10.0
|
|
13847
14267
|
*/
|
|
@@ -13854,6 +14274,7 @@ export function OptionFromNullOr<S extends Constraint>(schema: S): OptionFromNul
|
|
|
13854
14274
|
/**
|
|
13855
14275
|
* Type-level representation returned by {@link OptionFromUndefinedOr}.
|
|
13856
14276
|
*
|
|
14277
|
+
* @stability stable
|
|
13857
14278
|
* @category models
|
|
13858
14279
|
* @since 3.10.0
|
|
13859
14280
|
*/
|
|
@@ -13869,6 +14290,7 @@ export interface OptionFromUndefinedOr<S extends Constraint> extends decodeTo<Op
|
|
|
13869
14290
|
* Decoding maps `undefined` to `None` and all other values to `Some`. Encoding
|
|
13870
14291
|
* maps `None` to `undefined` and maps `Some` to its value.
|
|
13871
14292
|
*
|
|
14293
|
+
* @stability stable
|
|
13872
14294
|
* @category schemas
|
|
13873
14295
|
* @since 3.10.0
|
|
13874
14296
|
*/
|
|
@@ -13881,6 +14303,7 @@ export function OptionFromUndefinedOr<S extends Constraint>(schema: S): OptionFr
|
|
|
13881
14303
|
/**
|
|
13882
14304
|
* Type-level representation returned by {@link OptionFromNullishOr}.
|
|
13883
14305
|
*
|
|
14306
|
+
* @stability stable
|
|
13884
14307
|
* @category models
|
|
13885
14308
|
* @since 3.10.0
|
|
13886
14309
|
*/
|
|
@@ -13897,6 +14320,7 @@ export interface OptionFromNullishOr<S extends Constraint> extends decodeTo<Opti
|
|
|
13897
14320
|
* `options.onNoneEncoding`, which defaults to `undefined`, and maps `Some` to
|
|
13898
14321
|
* its value.
|
|
13899
14322
|
*
|
|
14323
|
+
* @stability stable
|
|
13900
14324
|
* @category schemas
|
|
13901
14325
|
* @since 3.10.0
|
|
13902
14326
|
*/
|
|
@@ -14260,6 +14684,7 @@ export const RecordFromUrlParams: RecordFromUrlParams = UrlParams.pipe(
|
|
|
14260
14684
|
/**
|
|
14261
14685
|
* Type-level representation returned by {@link OptionFromOptionalKey}.
|
|
14262
14686
|
*
|
|
14687
|
+
* @stability stable
|
|
14263
14688
|
* @category models
|
|
14264
14689
|
* @since 4.0.0
|
|
14265
14690
|
*/
|
|
@@ -14274,6 +14699,7 @@ export interface OptionFromOptionalKey<S extends Constraint> extends decodeTo<Op
|
|
|
14274
14699
|
* Decoding maps a missing key to `None` and a present value to `Some`.
|
|
14275
14700
|
* Encoding maps `None` to a missing key and maps `Some` to its value.
|
|
14276
14701
|
*
|
|
14702
|
+
* @stability stable
|
|
14277
14703
|
* @category schemas
|
|
14278
14704
|
* @since 4.0.0
|
|
14279
14705
|
*/
|
|
@@ -14286,6 +14712,7 @@ export function OptionFromOptionalKey<S extends Constraint>(schema: S): OptionFr
|
|
|
14286
14712
|
/**
|
|
14287
14713
|
* Type-level representation returned by {@link OptionFromOptional}.
|
|
14288
14714
|
*
|
|
14715
|
+
* @stability stable
|
|
14289
14716
|
* @category models
|
|
14290
14717
|
* @since 4.0.0
|
|
14291
14718
|
*/
|
|
@@ -14302,6 +14729,7 @@ export interface OptionFromOptional<S extends Constraint> extends decodeTo<Optio
|
|
|
14302
14729
|
* maps all other values to `Some`. Encoding maps `None` to a missing key and
|
|
14303
14730
|
* maps `Some` to its value.
|
|
14304
14731
|
*
|
|
14732
|
+
* @stability stable
|
|
14305
14733
|
* @category schemas
|
|
14306
14734
|
* @since 4.0.0
|
|
14307
14735
|
*/
|
|
@@ -14314,6 +14742,7 @@ export function OptionFromOptional<S extends Constraint>(schema: S): OptionFromO
|
|
|
14314
14742
|
/**
|
|
14315
14743
|
* Type-level representation returned by {@link OptionFromOptionalNullOr}.
|
|
14316
14744
|
*
|
|
14745
|
+
* @stability stable
|
|
14317
14746
|
* @category models
|
|
14318
14747
|
* @since 4.0.0
|
|
14319
14748
|
*/
|
|
@@ -14333,6 +14762,7 @@ export interface OptionFromOptionalNullOr<S extends Constraint>
|
|
|
14333
14762
|
* according to `options.onNoneEncoding`: `"omit"` encodes a missing key,
|
|
14334
14763
|
* `null` encodes `null`, and `undefined` encodes `undefined`.
|
|
14335
14764
|
*
|
|
14765
|
+
* @stability stable
|
|
14336
14766
|
* @category schemas
|
|
14337
14767
|
* @since 4.0.0
|
|
14338
14768
|
*/
|
|
@@ -14364,6 +14794,7 @@ export function OptionFromOptionalNullOr<S extends Constraint>(
|
|
|
14364
14794
|
/**
|
|
14365
14795
|
* Type-level representation returned by {@link Redacted}.
|
|
14366
14796
|
*
|
|
14797
|
+
* @stability stable
|
|
14367
14798
|
* @category models
|
|
14368
14799
|
* @since 3.10.0
|
|
14369
14800
|
*/
|
|
@@ -14398,6 +14829,7 @@ type NormalizedRedactedOptions =
|
|
|
14398
14829
|
* sensitive and should not be exposed in JSON.
|
|
14399
14830
|
*
|
|
14400
14831
|
* @see {@link RedactedFromValue} for decoding raw values and wrapping them in `Redacted`.
|
|
14832
|
+
* @stability stable
|
|
14401
14833
|
* @category schemas
|
|
14402
14834
|
* @since 3.10.0
|
|
14403
14835
|
*/
|
|
@@ -14485,6 +14917,7 @@ export function Redacted<S extends Constraint>(value: S, options?: {
|
|
|
14485
14917
|
/**
|
|
14486
14918
|
* Type-level representation returned by {@link RedactedFromValue}.
|
|
14487
14919
|
*
|
|
14920
|
+
* @stability stable
|
|
14488
14921
|
* @category models
|
|
14489
14922
|
* @since 4.0.0
|
|
14490
14923
|
*/
|
|
@@ -14497,6 +14930,7 @@ export interface RedactedFromValue<S extends Constraint> extends decodeTo<Redact
|
|
|
14497
14930
|
* the raw value and wraps it.
|
|
14498
14931
|
*
|
|
14499
14932
|
* @see {@link Redacted} for schemas whose input is already a `Redacted` value.
|
|
14933
|
+
* @stability stable
|
|
14500
14934
|
* @category schemas
|
|
14501
14935
|
* @since 4.0.0
|
|
14502
14936
|
*/
|
|
@@ -14528,6 +14962,7 @@ export function RedactedFromValue<S extends Constraint>(value: S, options?: {
|
|
|
14528
14962
|
/**
|
|
14529
14963
|
* Type-level representation returned by {@link Result}.
|
|
14530
14964
|
*
|
|
14965
|
+
* @stability stable
|
|
14531
14966
|
* @category models
|
|
14532
14967
|
* @since 4.0.0
|
|
14533
14968
|
*/
|
|
@@ -14551,6 +14986,7 @@ export interface Result<A extends Constraint, E extends Constraint> extends
|
|
|
14551
14986
|
* Successful results are represented as `{ _tag: "Success", success }`, while
|
|
14552
14987
|
* failed results are represented as `{ _tag: "Failure", failure }`.
|
|
14553
14988
|
*
|
|
14989
|
+
* @stability stable
|
|
14554
14990
|
* @category utility types
|
|
14555
14991
|
* @since 4.0.0
|
|
14556
14992
|
*/
|
|
@@ -14564,6 +15000,7 @@ export type ResultIso<A extends Constraint, E extends Constraint> = {
|
|
|
14564
15000
|
/**
|
|
14565
15001
|
* Schema for `Result<A, E>` values.
|
|
14566
15002
|
*
|
|
15003
|
+
* @stability stable
|
|
14567
15004
|
* @category schemas
|
|
14568
15005
|
* @since 4.0.0
|
|
14569
15006
|
*/
|
|
@@ -14628,6 +15065,7 @@ export function Result<A extends Constraint, E extends Constraint>(
|
|
|
14628
15065
|
/**
|
|
14629
15066
|
* Type-level representation returned by {@link Class}.
|
|
14630
15067
|
*
|
|
15068
|
+
* @stability stable
|
|
14631
15069
|
* @category models
|
|
14632
15070
|
* @since 3.10.0
|
|
14633
15071
|
*/
|
|
@@ -14967,6 +15405,7 @@ function isStruct(schema: Struct.Fields | Struct<Struct.Fields>): schema is Stru
|
|
|
14967
15405
|
* @see {@link Error} for defining schema-backed error classes
|
|
14968
15406
|
* @see {@link TaggedError} for defining tagged schema-backed error classes
|
|
14969
15407
|
*
|
|
15408
|
+
* @stability stable
|
|
14970
15409
|
* @category constructors
|
|
14971
15410
|
* @since 3.10.0
|
|
14972
15411
|
*/
|
|
@@ -15037,6 +15476,7 @@ export const Class: {
|
|
|
15037
15476
|
* @see {@link Error} for defining schema-backed error classes
|
|
15038
15477
|
* @see {@link TaggedError} for defining tagged schema-backed error classes
|
|
15039
15478
|
*
|
|
15479
|
+
* @stability stable
|
|
15040
15480
|
* @category constructors
|
|
15041
15481
|
* @since 3.10.0
|
|
15042
15482
|
*/
|
|
@@ -15107,6 +15547,7 @@ export const Class: {
|
|
|
15107
15547
|
* @see {@link Error} for defining schema-backed error classes
|
|
15108
15548
|
* @see {@link TaggedError} for defining tagged schema-backed error classes
|
|
15109
15549
|
*
|
|
15550
|
+
* @stability stable
|
|
15110
15551
|
* @category constructors
|
|
15111
15552
|
* @since 3.10.0
|
|
15112
15553
|
*/
|
|
@@ -15180,6 +15621,7 @@ export const Class: {
|
|
|
15180
15621
|
* @see {@link Error} for defining schema-backed error classes
|
|
15181
15622
|
* @see {@link TaggedError} for defining tagged schema-backed error classes
|
|
15182
15623
|
*
|
|
15624
|
+
* @stability stable
|
|
15183
15625
|
* @category constructors
|
|
15184
15626
|
* @since 3.10.0
|
|
15185
15627
|
*/
|
|
@@ -15230,6 +15672,7 @@ export const Class: {
|
|
|
15230
15672
|
* c.radius // => 5
|
|
15231
15673
|
* ```
|
|
15232
15674
|
*
|
|
15675
|
+
* @stability stable
|
|
15233
15676
|
* @category constructors
|
|
15234
15677
|
* @since 3.10.0
|
|
15235
15678
|
*/
|
|
@@ -15261,6 +15704,7 @@ export const TaggedClass: {
|
|
|
15261
15704
|
* c.radius // => 5
|
|
15262
15705
|
* ```
|
|
15263
15706
|
*
|
|
15707
|
+
* @stability stable
|
|
15264
15708
|
* @category constructors
|
|
15265
15709
|
* @since 3.10.0
|
|
15266
15710
|
*/
|
|
@@ -15292,6 +15736,7 @@ export const TaggedClass: {
|
|
|
15292
15736
|
* c.radius // => 5
|
|
15293
15737
|
* ```
|
|
15294
15738
|
*
|
|
15739
|
+
* @stability stable
|
|
15295
15740
|
* @category constructors
|
|
15296
15741
|
* @since 3.10.0
|
|
15297
15742
|
*/
|
|
@@ -15327,6 +15772,7 @@ export const TaggedClass: {
|
|
|
15327
15772
|
* c.radius // => 5
|
|
15328
15773
|
* ```
|
|
15329
15774
|
*
|
|
15775
|
+
* @stability stable
|
|
15330
15776
|
* @category constructors
|
|
15331
15777
|
* @since 3.10.0
|
|
15332
15778
|
*/
|
|
@@ -15379,6 +15825,7 @@ export const TaggedClass: {
|
|
|
15379
15825
|
* error.id // => 1
|
|
15380
15826
|
* ```
|
|
15381
15827
|
*
|
|
15828
|
+
* @stability stable
|
|
15382
15829
|
* @category constructors
|
|
15383
15830
|
* @since 4.0.0
|
|
15384
15831
|
*/
|
|
@@ -15405,6 +15852,7 @@ export const Error: {
|
|
|
15405
15852
|
* error.id // => 1
|
|
15406
15853
|
* ```
|
|
15407
15854
|
*
|
|
15855
|
+
* @stability stable
|
|
15408
15856
|
* @category constructors
|
|
15409
15857
|
* @since 4.0.0
|
|
15410
15858
|
*/
|
|
@@ -15431,6 +15879,7 @@ export const Error: {
|
|
|
15431
15879
|
* error.id // => 1
|
|
15432
15880
|
* ```
|
|
15433
15881
|
*
|
|
15882
|
+
* @stability stable
|
|
15434
15883
|
* @category constructors
|
|
15435
15884
|
* @since 4.0.0
|
|
15436
15885
|
*/
|
|
@@ -15461,6 +15910,7 @@ export const Error: {
|
|
|
15461
15910
|
* error.id // => 1
|
|
15462
15911
|
* ```
|
|
15463
15912
|
*
|
|
15913
|
+
* @stability stable
|
|
15464
15914
|
* @category constructors
|
|
15465
15915
|
* @since 4.0.0
|
|
15466
15916
|
*/
|
|
@@ -15511,6 +15961,7 @@ export const Error: {
|
|
|
15511
15961
|
* error.id // => 42
|
|
15512
15962
|
* ```
|
|
15513
15963
|
*
|
|
15964
|
+
* @stability stable
|
|
15514
15965
|
* @category constructors
|
|
15515
15966
|
* @since 3.10.0
|
|
15516
15967
|
*/
|
|
@@ -15541,6 +15992,7 @@ export const TaggedError: {
|
|
|
15541
15992
|
* error.id // => 42
|
|
15542
15993
|
* ```
|
|
15543
15994
|
*
|
|
15995
|
+
* @stability stable
|
|
15544
15996
|
* @category constructors
|
|
15545
15997
|
* @since 3.10.0
|
|
15546
15998
|
*/
|
|
@@ -15571,6 +16023,7 @@ export const TaggedError: {
|
|
|
15571
16023
|
* error.id // => 42
|
|
15572
16024
|
* ```
|
|
15573
16025
|
*
|
|
16026
|
+
* @stability stable
|
|
15574
16027
|
* @category constructors
|
|
15575
16028
|
* @since 3.10.0
|
|
15576
16029
|
*/
|
|
@@ -15606,6 +16059,7 @@ export const TaggedError: {
|
|
|
15606
16059
|
* error.id // => 42
|
|
15607
16060
|
* ```
|
|
15608
16061
|
*
|
|
16062
|
+
* @stability stable
|
|
15609
16063
|
* @category constructors
|
|
15610
16064
|
* @since 3.10.0
|
|
15611
16065
|
*/
|
|
@@ -15645,6 +16099,7 @@ export const TaggedError: {
|
|
|
15645
16099
|
* The annotation is applied through this helper because adding it directly to
|
|
15646
16100
|
* `Annotations.Bottom` would make schemas invariant.
|
|
15647
16101
|
*
|
|
16102
|
+
* @stability stable
|
|
15648
16103
|
* @category formatting
|
|
15649
16104
|
* @since 4.0.0
|
|
15650
16105
|
*/
|
|
@@ -15661,6 +16116,7 @@ export function overrideToFormatter<S extends Top>(toFormatter: () => Formatter<
|
|
|
15661
16116
|
* The optional `onBefore` hook lets you intercept specific AST nodes before
|
|
15662
16117
|
* the default formatting logic runs.
|
|
15663
16118
|
*
|
|
16119
|
+
* @stability stable
|
|
15664
16120
|
* @category formatting
|
|
15665
16121
|
* @since 4.0.0
|
|
15666
16122
|
*/
|
|
@@ -15680,6 +16136,7 @@ export function toFormatter<S extends Constraint>(schema: S, options?: {
|
|
|
15680
16136
|
* Use when you need a custom equivalence instead of the default structural
|
|
15681
16137
|
* equivalence derived by {@link toEquivalence}.
|
|
15682
16138
|
*
|
|
16139
|
+
* @stability stable
|
|
15683
16140
|
* @category instances
|
|
15684
16141
|
* @since 4.0.0
|
|
15685
16142
|
*/
|
|
@@ -15702,6 +16159,7 @@ export function overrideToEquivalence<S extends Top>(toEquivalence: () => Equiva
|
|
|
15702
16159
|
* eq({ id: 1, name: "Alice" }, { id: 2, name: "Alice" }) // => false
|
|
15703
16160
|
* ```
|
|
15704
16161
|
*
|
|
16162
|
+
* @stability stable
|
|
15705
16163
|
* @category instances
|
|
15706
16164
|
* @since 4.0.0
|
|
15707
16165
|
*/
|
|
@@ -15726,6 +16184,7 @@ export function toEquivalence<T>(schema: Schema<T>): Equivalence.Equivalence<T>
|
|
|
15726
16184
|
*
|
|
15727
16185
|
* @see {@link SchemaRepresentation.toRepresentation} for converting a `SchemaAST.AST` directly
|
|
15728
16186
|
*
|
|
16187
|
+
* @stability stable
|
|
15729
16188
|
* @category converting
|
|
15730
16189
|
* @since 4.0.0
|
|
15731
16190
|
*/
|
|
@@ -15749,6 +16208,7 @@ export function toRepresentation(
|
|
|
15749
16208
|
* `SchemaRepresentation.toJsonSchemaMultiDocument`, reference allocation has already happened and `referencePolicy`
|
|
15750
16209
|
* has no effect.
|
|
15751
16210
|
*
|
|
16211
|
+
* @stability stable
|
|
15752
16212
|
* @category options
|
|
15753
16213
|
* @since 4.0.0
|
|
15754
16214
|
*/
|
|
@@ -15888,6 +16348,7 @@ export interface ToJsonSchemaOptions extends SchemaRepresentation.ToRepresentati
|
|
|
15888
16348
|
* @see {@link toCodecJson} for decoding and encoding the canonical JSON representation
|
|
15889
16349
|
* @see {@link SchemaRepresentation.toJsonSchemaDocument} for compiling an existing live representation document
|
|
15890
16350
|
*
|
|
16351
|
+
* @stability stable
|
|
15891
16352
|
* @category converting
|
|
15892
16353
|
* @since 4.0.0
|
|
15893
16354
|
*/
|
|
@@ -15904,6 +16365,7 @@ export function toJsonSchemaDocument(
|
|
|
15904
16365
|
/**
|
|
15905
16366
|
* Type-level representation returned by {@link toCodecJson}.
|
|
15906
16367
|
*
|
|
16368
|
+
* @stability stable
|
|
15907
16369
|
* @category converting
|
|
15908
16370
|
* @since 4.0.0
|
|
15909
16371
|
*/
|
|
@@ -15949,6 +16411,7 @@ export interface toCodecJson<S extends Constraint> extends
|
|
|
15949
16411
|
* checks and annotations remain on its source node rather than being copied to
|
|
15950
16412
|
* the JSON target. Source checks still run after the transformation.
|
|
15951
16413
|
*
|
|
16414
|
+
* @stability stable
|
|
15952
16415
|
* @category converting
|
|
15953
16416
|
* @since 4.0.0
|
|
15954
16417
|
*/
|
|
@@ -15974,6 +16437,7 @@ export const toCodecJson: {
|
|
|
15974
16437
|
* checks and annotations remain on its source node rather than being copied to
|
|
15975
16438
|
* the JSON target. Source checks still run after the transformation.
|
|
15976
16439
|
*
|
|
16440
|
+
* @stability stable
|
|
15977
16441
|
* @category converting
|
|
15978
16442
|
* @since 4.0.0
|
|
15979
16443
|
*/
|
|
@@ -15993,6 +16457,7 @@ export const toCodecJson: {
|
|
|
15993
16457
|
* Links cannot require services because the returned `Codec` does not expose
|
|
15994
16458
|
* service requirements.
|
|
15995
16459
|
*
|
|
16460
|
+
* @stability stable
|
|
15996
16461
|
* @category converting
|
|
15997
16462
|
* @since 4.0.0
|
|
15998
16463
|
*/
|
|
@@ -16011,6 +16476,7 @@ export const toCodecIso: {
|
|
|
16011
16476
|
* Links cannot require services because the returned `Codec` does not expose
|
|
16012
16477
|
* service requirements.
|
|
16013
16478
|
*
|
|
16479
|
+
* @stability stable
|
|
16014
16480
|
* @category converting
|
|
16015
16481
|
* @since 4.0.0
|
|
16016
16482
|
*/
|
|
@@ -16020,6 +16486,7 @@ export const toCodecIso: {
|
|
|
16020
16486
|
* A {@link Tree} of `string | undefined` nodes. Leaf values are either a
|
|
16021
16487
|
* string representation or `undefined` for opaque/declaration types.
|
|
16022
16488
|
*
|
|
16489
|
+
* @stability stable
|
|
16023
16490
|
* @category models
|
|
16024
16491
|
* @since 4.0.0
|
|
16025
16492
|
*/
|
|
@@ -16027,6 +16494,7 @@ export type StringTree = Tree<string | undefined>
|
|
|
16027
16494
|
/**
|
|
16028
16495
|
* Type-level representation returned by {@link toCodecStringTree}.
|
|
16029
16496
|
*
|
|
16497
|
+
* @stability stable
|
|
16030
16498
|
* @category converting
|
|
16031
16499
|
* @since 4.0.0
|
|
16032
16500
|
*/
|
|
@@ -16068,6 +16536,7 @@ export interface toCodecStringTree<S extends Constraint> extends
|
|
|
16068
16536
|
* `toCodec` encoding. A callback can return `undefined` when the declaration is
|
|
16069
16537
|
* already in canonical StringTree form.
|
|
16070
16538
|
*
|
|
16539
|
+
* @stability stable
|
|
16071
16540
|
* @category converting
|
|
16072
16541
|
* @since 4.0.0
|
|
16073
16542
|
*/
|
|
@@ -16089,6 +16558,7 @@ export const toCodecStringTree: {
|
|
|
16089
16558
|
* `toCodec` encoding. A callback can return `undefined` when the declaration is
|
|
16090
16559
|
* already in canonical StringTree form.
|
|
16091
16560
|
*
|
|
16561
|
+
* @stability stable
|
|
16092
16562
|
* @category converting
|
|
16093
16563
|
* @since 4.0.0
|
|
16094
16564
|
*/
|
|
@@ -16097,6 +16567,7 @@ export const toCodecStringTree: {
|
|
|
16097
16567
|
/**
|
|
16098
16568
|
* Type-level representation returned by {@link toCodecArrayFromSingle}.
|
|
16099
16569
|
*
|
|
16570
|
+
* @stability stable
|
|
16100
16571
|
* @category converting
|
|
16101
16572
|
* @since 4.0.0
|
|
16102
16573
|
*/
|
|
@@ -16135,6 +16606,7 @@ export interface toCodecArrayFromSingle<S extends Constraint> extends
|
|
|
16135
16606
|
* decoding convenience rather than a canonical StringTree representation. It
|
|
16136
16607
|
* does not parse comma-separated strings.
|
|
16137
16608
|
*
|
|
16609
|
+
* @stability stable
|
|
16138
16610
|
* @category converting
|
|
16139
16611
|
* @since 4.0.0
|
|
16140
16612
|
*/
|
|
@@ -16154,6 +16626,7 @@ export const toCodecArrayFromSingle: {
|
|
|
16154
16626
|
* decoding convenience rather than a canonical StringTree representation. It
|
|
16155
16627
|
* does not parse comma-separated strings.
|
|
16156
16628
|
*
|
|
16629
|
+
* @stability stable
|
|
16157
16630
|
* @category converting
|
|
16158
16631
|
* @since 4.0.0
|
|
16159
16632
|
*/
|
|
@@ -16180,6 +16653,7 @@ type XmlEncoderOptions = {
|
|
|
16180
16653
|
* an `Effect` that succeeds with the XML string or fails with a
|
|
16181
16654
|
* {@link SchemaIssue.Issue} if codec encoding fails.
|
|
16182
16655
|
*
|
|
16656
|
+
* @stability stable
|
|
16183
16657
|
* @category encoding
|
|
16184
16658
|
* @since 4.0.0
|
|
16185
16659
|
*/
|
|
@@ -16206,6 +16680,7 @@ export function toEncoderXml<T, RE>(
|
|
|
16206
16680
|
* `SchemaIssue.makeFormatterDefault()`. Consume {@link toCodecIso} with an
|
|
16207
16681
|
* effectful parser for asynchronous execution or explicit failure handling.
|
|
16208
16682
|
*
|
|
16683
|
+
* @stability stable
|
|
16209
16684
|
* @category converting
|
|
16210
16685
|
* @since 4.0.0
|
|
16211
16686
|
*/
|
|
@@ -16215,6 +16690,7 @@ export function toIso<S extends Constraint>(schema: S): Optic_.Iso<S["Type"], S[
|
|
|
16215
16690
|
/**
|
|
16216
16691
|
* Returns an identity `Iso` over the schema's source (`Type`) side.
|
|
16217
16692
|
*
|
|
16693
|
+
* @stability stable
|
|
16218
16694
|
* @category constructors
|
|
16219
16695
|
* @since 4.0.0
|
|
16220
16696
|
*/
|
|
@@ -16224,6 +16700,7 @@ export function toIsoSource<S extends Constraint>(schema: S): Optic_.Iso<S["Type
|
|
|
16224
16700
|
/**
|
|
16225
16701
|
* Returns an identity `Iso` over the schema's focus (`Iso`) side.
|
|
16226
16702
|
*
|
|
16703
|
+
* @stability stable
|
|
16227
16704
|
* @category constructors
|
|
16228
16705
|
* @since 4.0.0
|
|
16229
16706
|
*/
|
|
@@ -16233,6 +16710,7 @@ export function toIsoFocus<S extends Constraint>(schema: S): Optic_.Iso<S["Iso"]
|
|
|
16233
16710
|
/**
|
|
16234
16711
|
* Type-level representation returned by {@link overrideToCodecIso}.
|
|
16235
16712
|
*
|
|
16713
|
+
* @stability stable
|
|
16236
16714
|
* @category transforming
|
|
16237
16715
|
* @since 4.0.0
|
|
16238
16716
|
*/
|
|
@@ -16271,6 +16749,7 @@ export interface overrideToCodecIso<S extends Constraint, Iso> extends
|
|
|
16271
16749
|
* provided `decode` and `encode` getters to transform between the schema type
|
|
16272
16750
|
* and the target codec.
|
|
16273
16751
|
*
|
|
16752
|
+
* @stability stable
|
|
16274
16753
|
* @category transforming
|
|
16275
16754
|
* @since 4.0.0
|
|
16276
16755
|
*/
|
|
@@ -16308,6 +16787,7 @@ export function overrideToCodecIso<S extends Constraint, Iso>(
|
|
|
16308
16787
|
* `SchemaIssue.makeFormatterDefault()`. Invalid patch operations instead produce
|
|
16309
16788
|
* {@link JsonPatch.apply} errors.
|
|
16310
16789
|
*
|
|
16790
|
+
* @stability stable
|
|
16311
16791
|
* @category converting
|
|
16312
16792
|
* @since 4.0.0
|
|
16313
16793
|
*/
|
|
@@ -16318,6 +16798,7 @@ export function toDifferJsonPatch<T>(schema: ConstraintCodec<T, unknown>): Diffe
|
|
|
16318
16798
|
* Recursive tree type whose leaves are `Node` values and whose branches are
|
|
16319
16799
|
* readonly arrays or string-keyed records of child trees.
|
|
16320
16800
|
*
|
|
16801
|
+
* @stability stable
|
|
16321
16802
|
* @category models
|
|
16322
16803
|
* @since 4.0.0
|
|
16323
16804
|
*/
|
|
@@ -16326,6 +16807,7 @@ export type Tree<Node> = Node | TreeRecord<Node> | ReadonlyArray<Tree<Node>>
|
|
|
16326
16807
|
* A record node in a {@link Tree}: an object mapping string keys to child
|
|
16327
16808
|
* `Tree` nodes.
|
|
16328
16809
|
*
|
|
16810
|
+
* @stability stable
|
|
16329
16811
|
* @category models
|
|
16330
16812
|
* @since 4.0.0
|
|
16331
16813
|
*/
|
|
@@ -16337,6 +16819,7 @@ export interface TreeRecord<A> {
|
|
|
16337
16819
|
* The resulting schema accepts a single node value, an array of trees, or an
|
|
16338
16820
|
* object whose values are trees.
|
|
16339
16821
|
*
|
|
16822
|
+
* @stability stable
|
|
16340
16823
|
* @category schemas
|
|
16341
16824
|
* @since 4.0.0
|
|
16342
16825
|
*/
|
|
@@ -16360,6 +16843,7 @@ export function Tree<S extends Constraint>(node: S) {
|
|
|
16360
16843
|
* readonly record of `string → Json`. For the corresponding schema, see the
|
|
16361
16844
|
* {@link Json} const.
|
|
16362
16845
|
*
|
|
16846
|
+
* @stability stable
|
|
16363
16847
|
* @category models
|
|
16364
16848
|
* @since 4.0.0
|
|
16365
16849
|
*/
|
|
@@ -16367,6 +16851,7 @@ export type Json = null | number | boolean | string | JsonArray | JsonObject
|
|
|
16367
16851
|
/**
|
|
16368
16852
|
* A readonly array of {@link Json} values.
|
|
16369
16853
|
*
|
|
16854
|
+
* @stability stable
|
|
16370
16855
|
* @category models
|
|
16371
16856
|
* @since 4.0.0
|
|
16372
16857
|
*/
|
|
@@ -16374,6 +16859,7 @@ export interface JsonArray extends ReadonlyArray<Json> {}
|
|
|
16374
16859
|
/**
|
|
16375
16860
|
* A readonly record whose values are {@link Json} values.
|
|
16376
16861
|
*
|
|
16862
|
+
* @stability stable
|
|
16377
16863
|
* @category models
|
|
16378
16864
|
* @since 4.0.0
|
|
16379
16865
|
*/
|
|
@@ -16391,6 +16877,7 @@ export interface JsonObject {
|
|
|
16391
16877
|
* Schema.decodeUnknownOption(Schema.Json)({ key: [1, true, null] }) // => Option.some({ key: [1, true, null] })
|
|
16392
16878
|
* ```
|
|
16393
16879
|
*
|
|
16880
|
+
* @stability stable
|
|
16394
16881
|
* @category schemas
|
|
16395
16882
|
* @since 4.0.0
|
|
16396
16883
|
*/
|
|
@@ -16417,6 +16904,7 @@ export const Json: Codec<Json> = make(SchemaAST.annotate(SchemaAST.Json, {
|
|
|
16417
16904
|
* ```
|
|
16418
16905
|
*
|
|
16419
16906
|
* @see {@link Json} for a schema that also accepts JSON arrays and primitive values
|
|
16907
|
+
* @stability stable
|
|
16420
16908
|
* @category schemas
|
|
16421
16909
|
* @since 4.0.0
|
|
16422
16910
|
*/
|
|
@@ -16425,6 +16913,7 @@ export const JsonObject: $Record<String, Codec<Json, Json, never, never>> = Reco
|
|
|
16425
16913
|
* Recursive TypeScript type for mutable JSON values: `null`, `number`,
|
|
16426
16914
|
* `boolean`, `string`, mutable arrays, or mutable string-keyed records.
|
|
16427
16915
|
*
|
|
16916
|
+
* @stability stable
|
|
16428
16917
|
* @category models
|
|
16429
16918
|
* @since 4.0.0
|
|
16430
16919
|
*/
|
|
@@ -16432,6 +16921,7 @@ export type MutableJson = null | number | boolean | string | MutableJsonArray |
|
|
|
16432
16921
|
/**
|
|
16433
16922
|
* A mutable array of {@link MutableJson} values.
|
|
16434
16923
|
*
|
|
16924
|
+
* @stability stable
|
|
16435
16925
|
* @category models
|
|
16436
16926
|
* @since 4.0.0
|
|
16437
16927
|
*/
|
|
@@ -16439,6 +16929,7 @@ export interface MutableJsonArray extends Array<MutableJson> {}
|
|
|
16439
16929
|
/**
|
|
16440
16930
|
* A mutable record whose values are {@link MutableJson} values.
|
|
16441
16931
|
*
|
|
16932
|
+
* @stability stable
|
|
16442
16933
|
* @category models
|
|
16443
16934
|
* @since 4.0.0
|
|
16444
16935
|
*/
|
|
@@ -16456,6 +16947,7 @@ const JsonError = Struct({
|
|
|
16456
16947
|
* Schema that accepts any mutable JSON-compatible value. See {@link Json} for
|
|
16457
16948
|
* the immutable variant.
|
|
16458
16949
|
*
|
|
16950
|
+
* @stability stable
|
|
16459
16951
|
* @category schemas
|
|
16460
16952
|
* @since 4.0.0
|
|
16461
16953
|
*/
|
|
@@ -16471,6 +16963,7 @@ export const MutableJson: Codec<MutableJson> = make(SchemaAST.annotate(SchemaAST
|
|
|
16471
16963
|
* annotations are taken from the last check; otherwise they are taken from
|
|
16472
16964
|
* the base schema instance.
|
|
16473
16965
|
*
|
|
16966
|
+
* @stability stable
|
|
16474
16967
|
* @category getters
|
|
16475
16968
|
* @since 4.0.0
|
|
16476
16969
|
*/
|
|
@@ -16484,6 +16977,7 @@ export function resolveAnnotations<S extends Constraint>(
|
|
|
16484
16977
|
* annotations are those attached via `annotateKey` and live on the AST's
|
|
16485
16978
|
* `context` rather than on the schema node itself.
|
|
16486
16979
|
*
|
|
16980
|
+
* @stability stable
|
|
16487
16981
|
* @category getters
|
|
16488
16982
|
* @since 4.0.0
|
|
16489
16983
|
*/
|
|
@@ -16500,6 +16994,7 @@ export function resolveAnnotationsKey<S extends Constraint>(schema: S): Annotati
|
|
|
16500
16994
|
* Use {@link resolveAnnotations} to read the annotations attached to a schema at
|
|
16501
16995
|
* runtime.
|
|
16502
16996
|
*
|
|
16997
|
+
* @stability stable
|
|
16503
16998
|
* @category models
|
|
16504
16999
|
* @since 4.0.0
|
|
16505
17000
|
*/
|