effect 4.0.0-beta.72 → 4.0.0-beta.74
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Array.d.ts +16 -16
- package/dist/Array.js +4 -4
- package/dist/Boolean.d.ts +2 -2
- package/dist/Boolean.js +2 -2
- package/dist/Channel.d.ts +63 -63
- package/dist/Channel.js +25 -25
- package/dist/Chunk.d.ts +17 -17
- package/dist/Chunk.js +5 -5
- package/dist/Context.d.ts +3 -3
- package/dist/Context.js +1 -1
- package/dist/Cron.d.ts +4 -4
- package/dist/Cron.js +4 -4
- package/dist/Deferred.d.ts +37 -37
- package/dist/Deferred.js +13 -13
- package/dist/Duration.d.ts +6 -6
- package/dist/Duration.js +2 -2
- package/dist/Effect.d.ts +58 -58
- package/dist/Effect.js +39 -39
- package/dist/Equal.d.ts +2 -2
- package/dist/Equal.js +2 -2
- package/dist/Equivalence.d.ts +1 -1
- package/dist/Equivalence.js +1 -1
- package/dist/ExecutionPlan.d.ts +2 -2
- package/dist/ExecutionPlan.js +1 -1
- package/dist/FileSystem.d.ts +6 -6
- package/dist/FileSystem.js +2 -2
- package/dist/Function.d.ts +5 -5
- package/dist/Function.js +5 -5
- package/dist/Graph.d.ts +11 -11
- package/dist/Graph.js +5 -5
- package/dist/HKT.d.ts +1 -1
- package/dist/HashMap.d.ts +3 -3
- package/dist/HashSet.d.ts +1 -1
- package/dist/Iterable.d.ts +15 -15
- package/dist/Iterable.js +5 -5
- package/dist/Layer.d.ts +16 -16
- package/dist/Layer.js +5 -5
- package/dist/Logger.d.ts +5 -5
- package/dist/Logger.js +4 -4
- package/dist/ManagedRuntime.d.ts +2 -2
- package/dist/Match.d.ts +20 -20
- package/dist/Match.js +16 -16
- package/dist/Metric.d.ts +16 -16
- package/dist/Metric.js +3 -3
- package/dist/Option.d.ts +36 -36
- package/dist/Option.js +17 -17
- package/dist/Order.d.ts +1 -1
- package/dist/Order.js +1 -1
- package/dist/Path.d.ts +1 -1
- package/dist/Path.js +1 -1
- package/dist/Pipeable.d.ts +1 -1
- package/dist/Pipeable.js +1 -1
- package/dist/Predicate.d.ts +5 -5
- package/dist/PubSub.d.ts +9 -9
- package/dist/PubSub.js +5 -5
- package/dist/Queue.d.ts +24 -24
- package/dist/Queue.js +20 -20
- package/dist/Record.d.ts +15 -15
- package/dist/Record.js +5 -5
- package/dist/Redacted.d.ts +2 -2
- package/dist/Redacted.js +1 -1
- package/dist/Ref.d.ts +6 -6
- package/dist/Ref.js +6 -6
- package/dist/RegExp.d.ts +1 -1
- package/dist/RegExp.js +1 -1
- package/dist/Request.d.ts +4 -4
- package/dist/RequestResolver.d.ts +6 -6
- package/dist/RequestResolver.js +2 -2
- package/dist/Resource.d.ts +1 -1
- package/dist/Resource.js +1 -1
- package/dist/Result.d.ts +18 -18
- package/dist/Result.js +11 -11
- package/dist/Schedule.d.ts +44 -44
- package/dist/Schedule.js +18 -18
- package/dist/Schema.d.ts +177 -459
- package/dist/Schema.d.ts.map +1 -1
- package/dist/Schema.js +25 -25
- package/dist/Schema.js.map +1 -1
- package/dist/SchemaAST.d.ts +1 -1
- package/dist/SchemaGetter.d.ts +13 -13
- package/dist/SchemaGetter.js +12 -12
- package/dist/SchemaParser.d.ts +3 -3
- package/dist/SchemaParser.js +3 -3
- package/dist/Scope.d.ts +1 -1
- package/dist/Scope.js +1 -1
- package/dist/Sink.d.ts +5 -5
- package/dist/Sink.js +3 -3
- package/dist/Stream.d.ts +55 -55
- package/dist/Stream.js +21 -21
- package/dist/String.d.ts +5 -5
- package/dist/String.js +3 -3
- package/dist/Struct.d.ts +8 -8
- package/dist/Struct.js +3 -3
- package/dist/SynchronizedRef.d.ts +57 -57
- package/dist/SynchronizedRef.js +19 -19
- package/dist/Terminal.d.ts +1 -1
- package/dist/Terminal.js +1 -1
- package/dist/Tracer.d.ts +5 -5
- package/dist/Tracer.js +2 -2
- package/dist/Tuple.d.ts +14 -14
- package/dist/Tuple.js +6 -6
- package/dist/TxHashMap.d.ts +3 -3
- package/dist/TxHashSet.d.ts +1 -1
- package/dist/Unify.d.ts +7 -7
- package/dist/Unify.js +1 -1
- package/dist/testing/TestClock.d.ts +5 -5
- package/dist/testing/TestClock.js +4 -4
- package/dist/testing/TestConsole.d.ts +3 -3
- package/dist/testing/TestConsole.js +3 -3
- package/dist/unstable/ai/Chat.d.ts +2 -2
- package/dist/unstable/ai/Chat.js +2 -2
- package/dist/unstable/ai/EmbeddingModel.d.ts +1 -1
- package/dist/unstable/ai/IdGenerator.d.ts +2 -2
- package/dist/unstable/ai/IdGenerator.js +1 -1
- package/dist/unstable/ai/LanguageModel.d.ts +4 -4
- package/dist/unstable/ai/LanguageModel.js +1 -1
- package/dist/unstable/ai/Prompt.d.ts +15 -15
- package/dist/unstable/ai/Prompt.js +1 -1
- package/dist/unstable/ai/Telemetry.d.ts +5 -5
- package/dist/unstable/ai/Telemetry.js +2 -2
- package/dist/unstable/ai/Tokenizer.d.ts +1 -1
- package/dist/unstable/ai/Tokenizer.js +1 -1
- package/dist/unstable/ai/Tool.d.ts +6 -6
- package/dist/unstable/ai/Tool.js +6 -6
- package/dist/unstable/cli/Command.d.ts.map +1 -1
- package/dist/unstable/cli/Command.js +1 -1
- package/dist/unstable/cli/Command.js.map +1 -1
- package/dist/unstable/cli/Param.d.ts +1 -1
- package/dist/unstable/cli/Primitive.d.ts +3 -3
- package/dist/unstable/cli/Primitive.js +1 -1
- package/dist/unstable/cli/Prompt.d.ts +11 -11
- package/dist/unstable/cli/internal/parser.js +145 -10
- package/dist/unstable/cli/internal/parser.js.map +1 -1
- package/dist/unstable/cluster/Entity.d.ts +1 -1
- package/dist/unstable/cluster/Entity.js +1 -1
- package/dist/unstable/cluster/EntityResource.d.ts +1 -0
- package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
- package/dist/unstable/cluster/EntityResource.js +5 -3
- package/dist/unstable/cluster/EntityResource.js.map +1 -1
- package/dist/unstable/cluster/HttpRunner.d.ts +2 -2
- package/dist/unstable/cluster/HttpRunner.js +2 -2
- package/dist/unstable/cluster/K8sHttpClient.d.ts +1 -1
- package/dist/unstable/cluster/K8sHttpClient.js +1 -1
- package/dist/unstable/cluster/Runners.d.ts +1 -1
- package/dist/unstable/cluster/Runners.js +1 -1
- package/dist/unstable/cluster/Sharding.d.ts +1 -1
- package/dist/unstable/cluster/Sharding.js +1 -1
- package/dist/unstable/cluster/SingletonAddress.d.ts +1 -1
- package/dist/unstable/cluster/SingletonAddress.js +1 -1
- package/dist/unstable/cluster/Snowflake.d.ts +5 -5
- package/dist/unstable/cluster/Snowflake.js +5 -5
- package/dist/unstable/devtools/DevToolsClient.d.ts +1 -1
- package/dist/unstable/devtools/DevToolsClient.js +1 -1
- package/dist/unstable/eventlog/EventLog.d.ts +1 -1
- package/dist/unstable/eventlog/EventLog.js +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogEncryption.js +1 -1
- package/dist/unstable/eventlog/EventLogRemote.d.ts +1 -1
- package/dist/unstable/eventlog/EventLogRemote.js +1 -1
- package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +3 -3
- package/dist/unstable/eventlog/EventLogServerUnencrypted.js +3 -3
- package/dist/unstable/http/Cookies.d.ts +1 -1
- package/dist/unstable/http/Etag.d.ts +1 -1
- package/dist/unstable/http/Etag.js +1 -1
- package/dist/unstable/http/FetchHttpClient.d.ts +2 -2
- package/dist/unstable/http/FetchHttpClient.js +2 -2
- package/dist/unstable/http/HttpClient.d.ts +1 -1
- package/dist/unstable/http/HttpClient.js +1 -1
- package/dist/unstable/http/HttpClientRequest.d.ts +2 -2
- package/dist/unstable/http/HttpMiddleware.d.ts +1 -1
- package/dist/unstable/http/HttpMiddleware.js +1 -1
- package/dist/unstable/http/HttpPlatform.d.ts +1 -1
- package/dist/unstable/http/HttpPlatform.js +1 -1
- package/dist/unstable/http/HttpRouter.d.ts +4 -4
- package/dist/unstable/http/HttpRouter.js +4 -4
- package/dist/unstable/http/HttpServerResponse.d.ts +3 -3
- package/dist/unstable/http/Url.d.ts +33 -33
- package/dist/unstable/http/Url.js +11 -11
- package/dist/unstable/httpapi/HttpApi.d.ts +1 -1
- package/dist/unstable/httpapi/HttpApi.js +1 -1
- package/dist/unstable/httpapi/HttpApiBuilder.js +2 -3
- package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
- package/dist/unstable/httpapi/HttpApiError.d.ts +13 -13
- package/dist/unstable/httpapi/HttpApiError.js +13 -13
- package/dist/unstable/httpapi/HttpApiSecurity.d.ts +27 -5
- package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
- package/dist/unstable/httpapi/HttpApiSecurity.js +26 -3
- package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
- package/dist/unstable/httpapi/OpenApi.js +2 -2
- package/dist/unstable/httpapi/OpenApi.js.map +1 -1
- package/dist/unstable/observability/PrometheusMetrics.d.ts +4 -4
- package/dist/unstable/observability/PrometheusMetrics.js +2 -2
- package/dist/unstable/persistence/KeyValueStore.d.ts +3 -3
- package/dist/unstable/persistence/KeyValueStore.js +1 -1
- package/dist/unstable/persistence/Persistable.d.ts +2 -2
- package/dist/unstable/persistence/Persistable.js +2 -2
- package/dist/unstable/persistence/PersistedQueue.d.ts +8 -8
- package/dist/unstable/persistence/PersistedQueue.js +8 -8
- package/dist/unstable/persistence/RateLimiter.d.ts +1 -1
- package/dist/unstable/persistence/RateLimiter.js +1 -1
- package/dist/unstable/process/ChildProcess.d.ts +5 -5
- package/dist/unstable/process/ChildProcess.js +2 -2
- package/dist/unstable/reactivity/AsyncResult.d.ts +4 -4
- package/dist/unstable/reactivity/AsyncResult.js +1 -1
- package/dist/unstable/reactivity/Atom.d.ts +1 -1
- package/dist/unstable/reactivity/Atom.js +1 -1
- package/dist/unstable/reactivity/AtomRegistry.d.ts +1 -1
- package/dist/unstable/reactivity/AtomRegistry.js +1 -1
- package/dist/unstable/reactivity/Reactivity.d.ts +1 -1
- package/dist/unstable/reactivity/Reactivity.js +1 -1
- package/dist/unstable/rpc/Rpc.d.ts +5 -5
- package/dist/unstable/rpc/Rpc.js +1 -1
- package/dist/unstable/rpc/RpcMiddleware.d.ts +1 -1
- package/dist/unstable/rpc/RpcMiddleware.js +1 -1
- package/dist/unstable/rpc/RpcSchema.d.ts +3 -3
- package/dist/unstable/rpc/RpcSchema.js +2 -2
- package/dist/unstable/schema/Model.d.ts +2 -2
- package/dist/unstable/schema/Model.js +1 -1
- package/dist/unstable/socket/Socket.d.ts +3 -3
- package/dist/unstable/socket/Socket.js +3 -3
- package/dist/unstable/socket/SocketServer.d.ts +1 -1
- package/dist/unstable/socket/SocketServer.js +1 -1
- package/dist/unstable/sql/Migrator.d.ts +1 -1
- package/dist/unstable/sql/SqlClient.d.ts +3 -3
- package/dist/unstable/sql/SqlClient.js +2 -2
- package/dist/unstable/sql/SqlConnection.d.ts +1 -1
- package/dist/unstable/sql/SqlConnection.js +1 -1
- package/dist/unstable/sql/Statement.d.ts +2 -2
- package/dist/unstable/sql/Statement.js +2 -2
- package/dist/unstable/workers/Transferable.d.ts +1 -1
- package/dist/unstable/workers/Transferable.js +1 -1
- package/dist/unstable/workers/Worker.d.ts +1 -1
- package/dist/unstable/workers/Worker.js +1 -1
- package/dist/unstable/workflow/Activity.d.ts +1 -1
- package/dist/unstable/workflow/Activity.js +1 -1
- package/dist/unstable/workflow/DurableDeferred.d.ts +1 -1
- package/dist/unstable/workflow/DurableDeferred.js +1 -1
- package/package.json +1 -1
- package/src/Array.ts +16 -16
- package/src/Boolean.ts +2 -2
- package/src/Channel.ts +67 -67
- package/src/Chunk.ts +18 -18
- package/src/Context.ts +4 -4
- package/src/Cron.ts +4 -4
- package/src/Deferred.ts +37 -37
- package/src/Duration.ts +6 -6
- package/src/Effect.ts +58 -58
- package/src/Equal.ts +2 -2
- package/src/Equivalence.ts +1 -1
- package/src/ExecutionPlan.ts +2 -2
- package/src/FileSystem.ts +6 -6
- package/src/Function.ts +5 -5
- package/src/Graph.ts +11 -11
- package/src/HKT.ts +1 -1
- package/src/HashMap.ts +3 -3
- package/src/HashSet.ts +1 -1
- package/src/Iterable.ts +15 -15
- package/src/Layer.ts +16 -16
- package/src/Logger.ts +7 -7
- package/src/ManagedRuntime.ts +2 -2
- package/src/Match.ts +20 -20
- package/src/Metric.ts +20 -20
- package/src/Option.ts +36 -36
- package/src/Order.ts +1 -1
- package/src/Path.ts +1 -1
- package/src/Pipeable.ts +1 -1
- package/src/Predicate.ts +5 -5
- package/src/PubSub.ts +9 -9
- package/src/Queue.ts +24 -24
- package/src/Record.ts +15 -15
- package/src/Redacted.ts +2 -2
- package/src/Ref.ts +18 -18
- package/src/RegExp.ts +1 -1
- package/src/Request.ts +4 -4
- package/src/RequestResolver.ts +8 -8
- package/src/Resource.ts +1 -1
- package/src/Result.ts +18 -18
- package/src/Schedule.ts +45 -45
- package/src/Schema.ts +177 -459
- package/src/SchemaAST.ts +1 -1
- package/src/SchemaGetter.ts +13 -13
- package/src/SchemaParser.ts +3 -3
- package/src/Scope.ts +1 -1
- package/src/Sink.ts +5 -5
- package/src/Stream.ts +57 -57
- package/src/String.ts +5 -5
- package/src/Struct.ts +8 -8
- package/src/SynchronizedRef.ts +57 -57
- package/src/Terminal.ts +1 -1
- package/src/Tracer.ts +5 -5
- package/src/Tuple.ts +14 -14
- package/src/TxHashMap.ts +3 -3
- package/src/TxHashSet.ts +1 -1
- package/src/Unify.ts +7 -7
- package/src/testing/TestClock.ts +5 -5
- package/src/testing/TestConsole.ts +3 -3
- package/src/unstable/ai/Chat.ts +2 -2
- package/src/unstable/ai/EmbeddingModel.ts +1 -1
- package/src/unstable/ai/IdGenerator.ts +2 -2
- package/src/unstable/ai/LanguageModel.ts +4 -4
- package/src/unstable/ai/Prompt.ts +15 -15
- package/src/unstable/ai/Telemetry.ts +5 -5
- package/src/unstable/ai/Tokenizer.ts +1 -1
- package/src/unstable/ai/Tool.ts +6 -6
- package/src/unstable/cli/Command.ts +5 -1
- package/src/unstable/cli/Param.ts +1 -1
- package/src/unstable/cli/Primitive.ts +3 -3
- package/src/unstable/cli/Prompt.ts +11 -11
- package/src/unstable/cli/internal/parser.ts +204 -10
- package/src/unstable/cluster/Entity.ts +1 -1
- package/src/unstable/cluster/EntityResource.ts +8 -4
- package/src/unstable/cluster/HttpRunner.ts +2 -2
- package/src/unstable/cluster/K8sHttpClient.ts +1 -1
- package/src/unstable/cluster/Runners.ts +1 -1
- package/src/unstable/cluster/Sharding.ts +1 -1
- package/src/unstable/cluster/SingletonAddress.ts +1 -1
- package/src/unstable/cluster/Snowflake.ts +5 -5
- package/src/unstable/devtools/DevToolsClient.ts +1 -1
- package/src/unstable/eventlog/EventLog.ts +1 -1
- package/src/unstable/eventlog/EventLogEncryption.ts +1 -1
- package/src/unstable/eventlog/EventLogRemote.ts +1 -1
- package/src/unstable/eventlog/EventLogServerUnencrypted.ts +3 -3
- package/src/unstable/http/Cookies.ts +1 -1
- package/src/unstable/http/Etag.ts +1 -1
- package/src/unstable/http/FetchHttpClient.ts +2 -2
- package/src/unstable/http/HttpClient.ts +1 -1
- package/src/unstable/http/HttpClientRequest.ts +2 -2
- package/src/unstable/http/HttpMiddleware.ts +1 -1
- package/src/unstable/http/HttpPlatform.ts +1 -1
- package/src/unstable/http/HttpRouter.ts +4 -4
- package/src/unstable/http/HttpServerResponse.ts +3 -3
- package/src/unstable/http/Url.ts +33 -33
- package/src/unstable/httpapi/HttpApi.ts +1 -1
- package/src/unstable/httpapi/HttpApiBuilder.ts +2 -3
- package/src/unstable/httpapi/HttpApiError.ts +13 -13
- package/src/unstable/httpapi/HttpApiSecurity.ts +36 -8
- package/src/unstable/httpapi/OpenApi.ts +2 -2
- package/src/unstable/observability/PrometheusMetrics.ts +4 -4
- package/src/unstable/persistence/KeyValueStore.ts +3 -3
- package/src/unstable/persistence/Persistable.ts +2 -2
- package/src/unstable/persistence/PersistedQueue.ts +8 -8
- package/src/unstable/persistence/RateLimiter.ts +1 -1
- package/src/unstable/process/ChildProcess.ts +5 -5
- package/src/unstable/reactivity/AsyncResult.ts +4 -4
- package/src/unstable/reactivity/Atom.ts +1 -1
- package/src/unstable/reactivity/AtomRegistry.ts +1 -1
- package/src/unstable/reactivity/Reactivity.ts +1 -1
- package/src/unstable/rpc/Rpc.ts +5 -5
- package/src/unstable/rpc/RpcMiddleware.ts +1 -1
- package/src/unstable/rpc/RpcSchema.ts +3 -3
- package/src/unstable/schema/Model.ts +2 -2
- package/src/unstable/socket/Socket.ts +3 -3
- package/src/unstable/socket/SocketServer.ts +1 -1
- package/src/unstable/sql/Migrator.ts +1 -1
- package/src/unstable/sql/SqlClient.ts +3 -3
- package/src/unstable/sql/SqlConnection.ts +1 -1
- package/src/unstable/sql/Statement.ts +2 -2
- package/src/unstable/workers/Transferable.ts +1 -1
- package/src/unstable/workers/Worker.ts +1 -1
- package/src/unstable/workflow/Activity.ts +1 -1
- package/src/unstable/workflow/DurableDeferred.ts +1 -1
package/dist/Schema.d.ts
CHANGED
|
@@ -159,7 +159,7 @@ export type ConstructorDefault = "no-default" | "with-default";
|
|
|
159
159
|
* @see {@link Bottom.makeEffect}
|
|
160
160
|
* @see {@link Bottom.make}
|
|
161
161
|
*
|
|
162
|
-
* @category
|
|
162
|
+
* @category options
|
|
163
163
|
* @since 3.13.4
|
|
164
164
|
*/
|
|
165
165
|
export interface MakeOptions {
|
|
@@ -267,9 +267,7 @@ export interface Bottom<out T, out E, out RD, out RE, out Ast extends AST.AST, o
|
|
|
267
267
|
makeEffect(input: this["~type.make.in"], options?: MakeOptions): Effect.Effect<this["Type"], SchemaError>;
|
|
268
268
|
}
|
|
269
269
|
/**
|
|
270
|
-
*
|
|
271
|
-
* type `T`, the encoded type `E`, and the list of type-parameter schemas
|
|
272
|
-
* `TypeParameters`.
|
|
270
|
+
* Type-level representation returned by {@link declareConstructor}.
|
|
273
271
|
*
|
|
274
272
|
* @category constructors
|
|
275
273
|
* @since 4.0.0
|
|
@@ -327,8 +325,7 @@ export interface declareConstructor<T, E, TypeParameters extends ReadonlyArray<T
|
|
|
327
325
|
*/
|
|
328
326
|
export declare function declareConstructor<T, E = T, Iso = T>(): <const TypeParameters extends ReadonlyArray<Top>>(typeParameters: TypeParameters, run: (typeParameters: { readonly [K in keyof TypeParameters]: Codec<TypeParameters[K]["Type"], TypeParameters[K]["Encoded"]>; }) => (u: unknown, self: AST.Declaration, options: AST.ParseOptions) => Effect.Effect<T, Issue.Issue>, annotations?: Annotations.Declaration<T, TypeParameters>) => declareConstructor<T, E, TypeParameters, Iso>;
|
|
329
327
|
/**
|
|
330
|
-
*
|
|
331
|
-
* opaque type `T` with no type parameters.
|
|
328
|
+
* Type-level representation returned by {@link declare}.
|
|
332
329
|
*
|
|
333
330
|
* @category constructors
|
|
334
331
|
* @since 3.13.3
|
|
@@ -394,7 +391,7 @@ export declare function declare<T, Iso = T>(is: (u: unknown) => u is T, annotati
|
|
|
394
391
|
* type E = typeof bottom["Encoded"] // string
|
|
395
392
|
* ```
|
|
396
393
|
*
|
|
397
|
-
* @category
|
|
394
|
+
* @category utility types
|
|
398
395
|
* @since 4.0.0
|
|
399
396
|
*/
|
|
400
397
|
export declare function revealBottom<S extends Top>(bottom: S): Bottom<S["Type"], S["Encoded"], S["DecodingServices"], S["EncodingServices"], S["ast"], S["Rebuild"], S["~type.make.in"], S["Iso"], S["~type.parameters"], S["~type.make"], S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]>;
|
|
@@ -763,7 +760,7 @@ export interface Encoder<out E, out RE = never> extends Codec<unknown, E, unknow
|
|
|
763
760
|
* type Enc = typeof codec["Encoded"] // string
|
|
764
761
|
* ```
|
|
765
762
|
*
|
|
766
|
-
* @category
|
|
763
|
+
* @category utility types
|
|
767
764
|
* @since 4.0.0
|
|
768
765
|
*/
|
|
769
766
|
export declare function revealCodec<T, E, RD, RE>(codec: Codec<T, E, RD, RE>): Codec<T, E, RD, RE>;
|
|
@@ -1520,9 +1517,7 @@ export declare function asClass<S extends Top>(schema: S): S & {
|
|
|
1520
1517
|
*/
|
|
1521
1518
|
export declare function isSchema(u: unknown): u is Top;
|
|
1522
1519
|
/**
|
|
1523
|
-
*
|
|
1524
|
-
* when present must match the wrapped schema (no implicit `undefined`).
|
|
1525
|
-
* Produced by {@link optionalKey}.
|
|
1520
|
+
* Type-level representation returned by {@link optionalKey}.
|
|
1526
1521
|
*
|
|
1527
1522
|
* @category models
|
|
1528
1523
|
* @since 4.0.0
|
|
@@ -1574,8 +1569,7 @@ interface requiredKeyLambda extends Lambda {
|
|
|
1574
1569
|
*/
|
|
1575
1570
|
export declare const requiredKey: requiredKeyLambda;
|
|
1576
1571
|
/**
|
|
1577
|
-
*
|
|
1578
|
-
* Equivalent to `optionalKey<UndefinedOr<S>>`. Produced by {@link optional}.
|
|
1572
|
+
* Type-level representation returned by {@link optional}.
|
|
1579
1573
|
*
|
|
1580
1574
|
* @category models
|
|
1581
1575
|
* @since 3.10.0
|
|
@@ -1638,8 +1632,7 @@ interface requiredLambda extends Lambda {
|
|
|
1638
1632
|
*/
|
|
1639
1633
|
export declare const required: requiredLambda;
|
|
1640
1634
|
/**
|
|
1641
|
-
*
|
|
1642
|
-
* Produced by {@link mutableKey}.
|
|
1635
|
+
* Type-level representation returned by {@link mutableKey}.
|
|
1643
1636
|
*
|
|
1644
1637
|
* @category models
|
|
1645
1638
|
* @since 4.0.0
|
|
@@ -1676,8 +1669,7 @@ interface readonlyKeyLambda extends Lambda {
|
|
|
1676
1669
|
*/
|
|
1677
1670
|
export declare const readonlyKey: readonlyKeyLambda;
|
|
1678
1671
|
/**
|
|
1679
|
-
*
|
|
1680
|
-
* both sides (Type = Encoded = S["Type"]). Produced by {@link toType}.
|
|
1672
|
+
* Type-level representation returned by {@link toType}.
|
|
1681
1673
|
*
|
|
1682
1674
|
* @category transforming
|
|
1683
1675
|
* @since 4.0.0
|
|
@@ -1697,8 +1689,7 @@ interface toTypeLambda extends Lambda {
|
|
|
1697
1689
|
*/
|
|
1698
1690
|
export declare const toType: toTypeLambda;
|
|
1699
1691
|
/**
|
|
1700
|
-
*
|
|
1701
|
-
* both sides (Type = Encoded = S["Encoded"]). Produced by {@link toEncoded}.
|
|
1692
|
+
* Type-level representation returned by {@link toEncoded}.
|
|
1702
1693
|
*
|
|
1703
1694
|
* @category transforming
|
|
1704
1695
|
* @since 4.0.0
|
|
@@ -1719,8 +1710,7 @@ interface toEncodedLambda extends Lambda {
|
|
|
1719
1710
|
export declare const toEncoded: toEncodedLambda;
|
|
1720
1711
|
declare const FlipTypeId = "~effect/Schema/flip";
|
|
1721
1712
|
/**
|
|
1722
|
-
*
|
|
1723
|
-
* swapped. Produced by {@link flip}.
|
|
1713
|
+
* Type-level representation returned by {@link flip}.
|
|
1724
1714
|
*
|
|
1725
1715
|
* @category transforming
|
|
1726
1716
|
* @since 4.0.0
|
|
@@ -1755,9 +1745,8 @@ export interface flip<S extends Top> extends Bottom<S["Encoded"], S["Type"], S["
|
|
|
1755
1745
|
*/
|
|
1756
1746
|
export declare function flip<S extends Top>(schema: S): S extends flip<infer F> ? F["Rebuild"] : flip<S>;
|
|
1757
1747
|
/**
|
|
1758
|
-
*
|
|
1748
|
+
* Type-level representation returned by {@link Literal}.
|
|
1759
1749
|
*
|
|
1760
|
-
* @see {@link Literal} for the constructor function.
|
|
1761
1750
|
* @category models
|
|
1762
1751
|
* @since 3.10.0
|
|
1763
1752
|
*/
|
|
@@ -1837,10 +1826,8 @@ export declare namespace TemplateLiteral {
|
|
|
1837
1826
|
type Encoded<Parts> = Parts extends readonly [...infer Init, infer Last] ? AppendType<Encoded<Init>, Last> : ``;
|
|
1838
1827
|
}
|
|
1839
1828
|
/**
|
|
1840
|
-
*
|
|
1841
|
-
* The encoded type is a string formed by concatenating the parts.
|
|
1829
|
+
* Type-level representation returned by {@link TemplateLiteral}.
|
|
1842
1830
|
*
|
|
1843
|
-
* @see {@link TemplateLiteral} for the constructor function.
|
|
1844
1831
|
* @category models
|
|
1845
1832
|
* @since 3.10.0
|
|
1846
1833
|
*/
|
|
@@ -1888,10 +1875,8 @@ export declare namespace TemplateLiteralParser {
|
|
|
1888
1875
|
] : [];
|
|
1889
1876
|
}
|
|
1890
1877
|
/**
|
|
1891
|
-
*
|
|
1892
|
-
* them into a tuple of typed values, one per schema part.
|
|
1878
|
+
* Type-level representation returned by {@link TemplateLiteralParser}.
|
|
1893
1879
|
*
|
|
1894
|
-
* @see {@link TemplateLiteralParser} for the constructor function.
|
|
1895
1880
|
* @category models
|
|
1896
1881
|
* @since 3.10.0
|
|
1897
1882
|
*/
|
|
@@ -1926,10 +1911,8 @@ export interface TemplateLiteralParser<Parts extends TemplateLiteral.Parts> exte
|
|
|
1926
1911
|
*/
|
|
1927
1912
|
export declare function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>(parts: Parts): TemplateLiteralParser<Parts>;
|
|
1928
1913
|
/**
|
|
1929
|
-
*
|
|
1930
|
-
* `as const` object, accepting any of its values.
|
|
1914
|
+
* Type-level representation returned by {@link Enum}.
|
|
1931
1915
|
*
|
|
1932
|
-
* @see {@link Enum} for the constructor function.
|
|
1933
1916
|
* @category models
|
|
1934
1917
|
* @since 4.0.0
|
|
1935
1918
|
*/
|
|
@@ -1962,9 +1945,8 @@ export declare function Enum<A extends {
|
|
|
1962
1945
|
[x: string]: string | number;
|
|
1963
1946
|
}>(enums: A): Enum<A>;
|
|
1964
1947
|
/**
|
|
1965
|
-
*
|
|
1948
|
+
* Type-level representation of {@link Never}.
|
|
1966
1949
|
*
|
|
1967
|
-
* @see {@link Never} for the schema value.
|
|
1968
1950
|
* @category models
|
|
1969
1951
|
* @since 3.10.0
|
|
1970
1952
|
*/
|
|
@@ -1978,9 +1960,8 @@ export interface Never extends Bottom<never, never, never, never, AST.Never, Nev
|
|
|
1978
1960
|
*/
|
|
1979
1961
|
export declare const Never: Never;
|
|
1980
1962
|
/**
|
|
1981
|
-
*
|
|
1963
|
+
* Type-level representation of {@link Any}.
|
|
1982
1964
|
*
|
|
1983
|
-
* @see {@link Any} for the schema value.
|
|
1984
1965
|
* @category models
|
|
1985
1966
|
* @since 3.10.0
|
|
1986
1967
|
*/
|
|
@@ -1995,9 +1976,8 @@ export interface Any extends Bottom<any, any, never, never, AST.Any, Any> {
|
|
|
1995
1976
|
*/
|
|
1996
1977
|
export declare const Any: Any;
|
|
1997
1978
|
/**
|
|
1998
|
-
*
|
|
1979
|
+
* Type-level representation of {@link Unknown}.
|
|
1999
1980
|
*
|
|
2000
|
-
* @see {@link Unknown} for the schema value.
|
|
2001
1981
|
* @category models
|
|
2002
1982
|
* @since 3.10.0
|
|
2003
1983
|
*/
|
|
@@ -2012,9 +1992,8 @@ export interface Unknown extends Bottom<unknown, unknown, never, never, AST.Unkn
|
|
|
2012
1992
|
*/
|
|
2013
1993
|
export declare const Unknown: Unknown;
|
|
2014
1994
|
/**
|
|
2015
|
-
*
|
|
1995
|
+
* Type-level representation of {@link Null}.
|
|
2016
1996
|
*
|
|
2017
|
-
* @see {@link Null} for the schema value.
|
|
2018
1997
|
* @category models
|
|
2019
1998
|
* @since 3.10.0
|
|
2020
1999
|
*/
|
|
@@ -2029,9 +2008,8 @@ export interface Null extends Bottom<null, null, never, never, AST.Null, Null> {
|
|
|
2029
2008
|
*/
|
|
2030
2009
|
export declare const Null: Null;
|
|
2031
2010
|
/**
|
|
2032
|
-
*
|
|
2011
|
+
* Type-level representation of {@link Undefined}.
|
|
2033
2012
|
*
|
|
2034
|
-
* @see {@link Undefined} for the schema value.
|
|
2035
2013
|
* @category models
|
|
2036
2014
|
* @since 3.10.0
|
|
2037
2015
|
*/
|
|
@@ -2046,9 +2024,8 @@ export interface Undefined extends Bottom<undefined, undefined, never, never, AS
|
|
|
2046
2024
|
*/
|
|
2047
2025
|
export declare const Undefined: Undefined;
|
|
2048
2026
|
/**
|
|
2049
|
-
*
|
|
2027
|
+
* Type-level representation of {@link String}.
|
|
2050
2028
|
*
|
|
2051
|
-
* @see {@link String} for the schema value.
|
|
2052
2029
|
* @category models
|
|
2053
2030
|
* @since 4.0.0
|
|
2054
2031
|
*/
|
|
@@ -2062,9 +2039,8 @@ export interface String extends Bottom<string, string, never, never, AST.String,
|
|
|
2062
2039
|
*/
|
|
2063
2040
|
export declare const String: String;
|
|
2064
2041
|
/**
|
|
2065
|
-
*
|
|
2042
|
+
* Type-level representation of {@link Number}.
|
|
2066
2043
|
*
|
|
2067
|
-
* @see {@link Number} for the schema value.
|
|
2068
2044
|
* @category models
|
|
2069
2045
|
* @since 4.0.0
|
|
2070
2046
|
*/
|
|
@@ -2086,9 +2062,8 @@ export interface Number extends Bottom<number, number, never, never, AST.Number,
|
|
|
2086
2062
|
*/
|
|
2087
2063
|
export declare const Number: Number;
|
|
2088
2064
|
/**
|
|
2089
|
-
*
|
|
2065
|
+
* Type-level representation of {@link Boolean}.
|
|
2090
2066
|
*
|
|
2091
|
-
* @see {@link Boolean} for the schema value.
|
|
2092
2067
|
* @category models
|
|
2093
2068
|
* @since 4.0.0
|
|
2094
2069
|
*/
|
|
@@ -2103,14 +2078,13 @@ export interface Boolean extends Bottom<boolean, boolean, never, never, AST.Bool
|
|
|
2103
2078
|
*
|
|
2104
2079
|
* @see {@link BooleanFromBit} for a schema that decodes bit literals `0` or `1` into a boolean
|
|
2105
2080
|
*
|
|
2106
|
-
* @category
|
|
2081
|
+
* @category boolean
|
|
2107
2082
|
* @since 4.0.0
|
|
2108
2083
|
*/
|
|
2109
2084
|
export declare const Boolean: Boolean;
|
|
2110
2085
|
/**
|
|
2111
|
-
*
|
|
2086
|
+
* Type-level representation of {@link Symbol}.
|
|
2112
2087
|
*
|
|
2113
|
-
* @see {@link Symbol} for the schema value.
|
|
2114
2088
|
* @category models
|
|
2115
2089
|
* @since 4.0.0
|
|
2116
2090
|
*/
|
|
@@ -2125,9 +2099,8 @@ export interface Symbol extends Bottom<symbol, symbol, never, never, AST.Symbol,
|
|
|
2125
2099
|
*/
|
|
2126
2100
|
export declare const Symbol: Symbol;
|
|
2127
2101
|
/**
|
|
2128
|
-
*
|
|
2102
|
+
* Type-level representation of {@link BigInt}.
|
|
2129
2103
|
*
|
|
2130
|
-
* @see {@link BigInt} for the schema value.
|
|
2131
2104
|
* @category models
|
|
2132
2105
|
* @since 4.0.0
|
|
2133
2106
|
*/
|
|
@@ -2148,9 +2121,8 @@ export interface BigInt extends Bottom<bigint, bigint, never, never, AST.BigInt,
|
|
|
2148
2121
|
*/
|
|
2149
2122
|
export declare const BigInt: BigInt;
|
|
2150
2123
|
/**
|
|
2151
|
-
*
|
|
2124
|
+
* Type-level representation of {@link Void}.
|
|
2152
2125
|
*
|
|
2153
|
-
* @see {@link Void} for the schema value.
|
|
2154
2126
|
* @category models
|
|
2155
2127
|
* @since 3.10.0
|
|
2156
2128
|
*/
|
|
@@ -2164,9 +2136,8 @@ export interface Void extends Bottom<void, void, never, never, AST.Void, Void> {
|
|
|
2164
2136
|
*/
|
|
2165
2137
|
export declare const Void: Void;
|
|
2166
2138
|
/**
|
|
2167
|
-
*
|
|
2139
|
+
* Type-level representation of {@link ObjectKeyword}.
|
|
2168
2140
|
*
|
|
2169
|
-
* @see {@link ObjectKeyword} for the schema value.
|
|
2170
2141
|
* @category models
|
|
2171
2142
|
* @since 4.0.0
|
|
2172
2143
|
*/
|
|
@@ -2181,9 +2152,8 @@ export interface ObjectKeyword extends Bottom<object, object, never, never, AST.
|
|
|
2181
2152
|
*/
|
|
2182
2153
|
export declare const ObjectKeyword: ObjectKeyword;
|
|
2183
2154
|
/**
|
|
2184
|
-
*
|
|
2155
|
+
* Type-level representation returned by {@link UniqueSymbol}.
|
|
2185
2156
|
*
|
|
2186
|
-
* @see {@link UniqueSymbol} for the constructor function.
|
|
2187
2157
|
* @category models
|
|
2188
2158
|
* @since 4.0.0
|
|
2189
2159
|
*/
|
|
@@ -2362,13 +2332,7 @@ export declare namespace Struct {
|
|
|
2362
2332
|
type MakeIn<F extends Fields> = Simplify<MakeIn_<F>>;
|
|
2363
2333
|
}
|
|
2364
2334
|
/**
|
|
2365
|
-
*
|
|
2366
|
-
* schema-defined fields.
|
|
2367
|
-
*
|
|
2368
|
-
* **Details**
|
|
2369
|
-
*
|
|
2370
|
-
* The `fields` property exposes the original field map for reuse, and
|
|
2371
|
-
* `mapFields` creates a new struct schema by transforming that field map.
|
|
2335
|
+
* Type-level representation returned by {@link Struct}.
|
|
2372
2336
|
*
|
|
2373
2337
|
* @category models
|
|
2374
2338
|
* @since 3.10.0
|
|
@@ -2483,8 +2447,7 @@ interface fieldsAssign<NewFields extends Struct.Fields> extends Lambda {
|
|
|
2483
2447
|
*/
|
|
2484
2448
|
export declare function fieldsAssign<const NewFields extends Struct.Fields>(fields: NewFields): fieldsAssign<NewFields>;
|
|
2485
2449
|
/**
|
|
2486
|
-
*
|
|
2487
|
-
* {@link encodeKeys}.
|
|
2450
|
+
* Type-level representation returned by {@link encodeKeys}.
|
|
2488
2451
|
*
|
|
2489
2452
|
* @category transforming
|
|
2490
2453
|
* @since 4.0.0
|
|
@@ -2715,16 +2678,7 @@ export declare namespace Record {
|
|
|
2715
2678
|
};
|
|
2716
2679
|
}
|
|
2717
2680
|
/**
|
|
2718
|
-
*
|
|
2719
|
-
* Produced by {@link Record}.
|
|
2720
|
-
*
|
|
2721
|
-
* **When to use**
|
|
2722
|
-
*
|
|
2723
|
-
* Use as the concrete schema type returned by `Record` when an API needs to
|
|
2724
|
-
* accept or return a record schema with typed property keys and values.
|
|
2725
|
-
*
|
|
2726
|
-
* @see {@link Record} for constructing record schemas
|
|
2727
|
-
* @see {@link StructWithRest} for combining fixed struct fields with record index signatures
|
|
2681
|
+
* Type-level representation returned by {@link Record}.
|
|
2728
2682
|
*
|
|
2729
2683
|
* @category models
|
|
2730
2684
|
* @since 4.0.0
|
|
@@ -2853,16 +2807,7 @@ export declare namespace StructWithRest {
|
|
|
2853
2807
|
}>;
|
|
2854
2808
|
}
|
|
2855
2809
|
/**
|
|
2856
|
-
*
|
|
2857
|
-
* by {@link StructWithRest}.
|
|
2858
|
-
*
|
|
2859
|
-
* **When to use**
|
|
2860
|
-
*
|
|
2861
|
-
* Use as the schema type when generic code needs to retain the base struct
|
|
2862
|
-
* schema and all rest record schemas.
|
|
2863
|
-
*
|
|
2864
|
-
* @see {@link StructWithRest} for constructing this schema type
|
|
2865
|
-
* @see {@link Record} for constructing record schemas used as rest index signatures
|
|
2810
|
+
* Type-level representation returned by {@link StructWithRest}.
|
|
2866
2811
|
*
|
|
2867
2812
|
* @category models
|
|
2868
2813
|
* @since 4.0.0
|
|
@@ -2998,7 +2943,7 @@ export declare namespace Tuple {
|
|
|
2998
2943
|
type MakeIn<E extends Elements> = MakeIn_<E>;
|
|
2999
2944
|
}
|
|
3000
2945
|
/**
|
|
3001
|
-
*
|
|
2946
|
+
* Type-level representation returned by {@link Tuple}.
|
|
3002
2947
|
*
|
|
3003
2948
|
* @category models
|
|
3004
2949
|
* @since 3.10.0
|
|
@@ -3161,8 +3106,7 @@ export declare namespace TupleWithRest {
|
|
|
3161
3106
|
] : M;
|
|
3162
3107
|
}
|
|
3163
3108
|
/**
|
|
3164
|
-
*
|
|
3165
|
-
* {@link TupleWithRest}.
|
|
3109
|
+
* Type-level representation returned by {@link TupleWithRest}.
|
|
3166
3110
|
*
|
|
3167
3111
|
* @category models
|
|
3168
3112
|
* @since 4.0.0
|
|
@@ -3203,18 +3147,7 @@ export interface TupleWithRest<S extends TupleWithRest.TupleType, Rest extends T
|
|
|
3203
3147
|
*/
|
|
3204
3148
|
export declare function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extends TupleWithRest.Rest>(schema: S, rest: Rest): TupleWithRest<S, Rest>;
|
|
3205
3149
|
/**
|
|
3206
|
-
*
|
|
3207
|
-
*
|
|
3208
|
-
* **When to use**
|
|
3209
|
-
*
|
|
3210
|
-
* Use as the public companion type returned by `Schema.Array` when you need to
|
|
3211
|
-
* refer to a readonly array schema built from an element schema.
|
|
3212
|
-
*
|
|
3213
|
-
* **Details**
|
|
3214
|
-
*
|
|
3215
|
-
* The decoded type is `ReadonlyArray<S["Type"]>`, the encoded type is
|
|
3216
|
-
* `ReadonlyArray<S["Encoded"]>`, and the element schema is available as
|
|
3217
|
-
* `value`.
|
|
3150
|
+
* Type-level representation returned by {@link Array}.
|
|
3218
3151
|
*
|
|
3219
3152
|
* @category models
|
|
3220
3153
|
* @since 4.0.0
|
|
@@ -3252,13 +3185,7 @@ export {
|
|
|
3252
3185
|
*/
|
|
3253
3186
|
ArraySchema as Array };
|
|
3254
3187
|
/**
|
|
3255
|
-
*
|
|
3256
|
-
*
|
|
3257
|
-
* **Details**
|
|
3258
|
-
*
|
|
3259
|
-
* The decoded type is `readonly [S["Type"], ...Array<S["Type"]>]`, the encoded type is
|
|
3260
|
-
* `readonly [S["Encoded"], ...Array<S["Encoded"]>]`, and the element schema is available as
|
|
3261
|
-
* `value`.
|
|
3188
|
+
* Type-level representation returned by {@link NonEmptyArray}.
|
|
3262
3189
|
*
|
|
3263
3190
|
* @category models
|
|
3264
3191
|
* @since 3.10.0
|
|
@@ -3290,20 +3217,7 @@ interface NonEmptyArrayLambda extends Lambda {
|
|
|
3290
3217
|
*/
|
|
3291
3218
|
export declare const NonEmptyArray: NonEmptyArrayLambda;
|
|
3292
3219
|
/**
|
|
3293
|
-
*
|
|
3294
|
-
* an array of items into a readonly array.
|
|
3295
|
-
*
|
|
3296
|
-
* **When to use**
|
|
3297
|
-
*
|
|
3298
|
-
* Use as the schema type when generic code needs to retain the original item
|
|
3299
|
-
* schema.
|
|
3300
|
-
*
|
|
3301
|
-
* **Details**
|
|
3302
|
-
*
|
|
3303
|
-
* The schema decodes from `S` or `Schema.Array(S)` and produces
|
|
3304
|
-
* `ReadonlyArray<S["Type"]>`.
|
|
3305
|
-
*
|
|
3306
|
-
* @see {@link ArrayEnsure} for constructing this schema type
|
|
3220
|
+
* Type-level representation returned by {@link ArrayEnsure}.
|
|
3307
3221
|
*
|
|
3308
3222
|
* @category constructors
|
|
3309
3223
|
* @since 3.10.0
|
|
@@ -3339,7 +3253,7 @@ export interface ArrayEnsure<S extends Top> extends decodeTo<$Array<toType<S>>,
|
|
|
3339
3253
|
*/
|
|
3340
3254
|
export declare function ArrayEnsure<S extends Top>(schema: S): ArrayEnsure<S>;
|
|
3341
3255
|
/**
|
|
3342
|
-
*
|
|
3256
|
+
* Type-level representation returned by {@link UniqueArray}.
|
|
3343
3257
|
*
|
|
3344
3258
|
* @category models
|
|
3345
3259
|
* @since 4.0.0
|
|
@@ -3360,8 +3274,7 @@ export interface UniqueArray<S extends Top> extends $Array<S> {
|
|
|
3360
3274
|
*/
|
|
3361
3275
|
export declare function UniqueArray<S extends Top>(item: S): UniqueArray<S>;
|
|
3362
3276
|
/**
|
|
3363
|
-
*
|
|
3364
|
-
* Produced by {@link mutable}.
|
|
3277
|
+
* Type-level representation returned by {@link mutable}.
|
|
3365
3278
|
*
|
|
3366
3279
|
* @category transforming
|
|
3367
3280
|
* @since 3.10.0
|
|
@@ -3398,7 +3311,7 @@ interface mutableLambda extends Lambda {
|
|
|
3398
3311
|
*/
|
|
3399
3312
|
export declare const mutable: mutableLambda;
|
|
3400
3313
|
/**
|
|
3401
|
-
*
|
|
3314
|
+
* Type-level representation returned by {@link Union}.
|
|
3402
3315
|
*
|
|
3403
3316
|
* @category models
|
|
3404
3317
|
* @since 3.10.0
|
|
@@ -3467,9 +3380,8 @@ export declare function Union<const Members extends ReadonlyArray<Top>>(members:
|
|
|
3467
3380
|
mode?: "anyOf" | "oneOf";
|
|
3468
3381
|
}): Union<Members>;
|
|
3469
3382
|
/**
|
|
3470
|
-
*
|
|
3383
|
+
* Type-level representation returned by {@link Literals}.
|
|
3471
3384
|
*
|
|
3472
|
-
* @see {@link Literals} for the constructor function.
|
|
3473
3385
|
* @category models
|
|
3474
3386
|
* @since 4.0.0
|
|
3475
3387
|
*/
|
|
@@ -3507,7 +3419,7 @@ export interface Literals<L extends ReadonlyArray<AST.LiteralValue>> extends Bot
|
|
|
3507
3419
|
*/
|
|
3508
3420
|
export declare function Literals<const L extends ReadonlyArray<AST.LiteralValue>>(literals: L): Literals<L>;
|
|
3509
3421
|
/**
|
|
3510
|
-
*
|
|
3422
|
+
* Type-level representation returned by {@link NullOr}.
|
|
3511
3423
|
*
|
|
3512
3424
|
* @category models
|
|
3513
3425
|
* @since 3.10.0
|
|
@@ -3527,7 +3439,7 @@ interface NullOrLambda extends Lambda {
|
|
|
3527
3439
|
*/
|
|
3528
3440
|
export declare const NullOr: NullOrLambda;
|
|
3529
3441
|
/**
|
|
3530
|
-
*
|
|
3442
|
+
* Type-level representation returned by {@link UndefinedOr}.
|
|
3531
3443
|
*
|
|
3532
3444
|
* @category models
|
|
3533
3445
|
* @since 3.10.0
|
|
@@ -3547,7 +3459,7 @@ interface UndefinedOrLambda extends Lambda {
|
|
|
3547
3459
|
*/
|
|
3548
3460
|
export declare const UndefinedOr: UndefinedOrLambda;
|
|
3549
3461
|
/**
|
|
3550
|
-
*
|
|
3462
|
+
* Type-level representation returned by {@link NullishOr}.
|
|
3551
3463
|
*
|
|
3552
3464
|
* @category models
|
|
3553
3465
|
* @since 3.10.0
|
|
@@ -3567,7 +3479,7 @@ interface NullishOrLambda extends Lambda {
|
|
|
3567
3479
|
*/
|
|
3568
3480
|
export declare const NullishOr: NullishOrLambda;
|
|
3569
3481
|
/**
|
|
3570
|
-
*
|
|
3482
|
+
* Type-level representation returned by {@link suspend}.
|
|
3571
3483
|
*
|
|
3572
3484
|
* @category models
|
|
3573
3485
|
* @since 3.10.0
|
|
@@ -3618,8 +3530,7 @@ export declare function suspend<S extends Top>(f: () => S): suspend<S>;
|
|
|
3618
3530
|
*/
|
|
3619
3531
|
export declare function check<S extends Top>(...checks: readonly [AST.Check<S["Type"]>, ...Array<AST.Check<S["Type"]>>]): (self: S) => S["Rebuild"];
|
|
3620
3532
|
/**
|
|
3621
|
-
*
|
|
3622
|
-
* type guard.
|
|
3533
|
+
* Type-level representation returned by {@link refine}.
|
|
3623
3534
|
*
|
|
3624
3535
|
* @category filtering
|
|
3625
3536
|
* @since 3.10.0
|
|
@@ -3645,15 +3556,7 @@ export interface refine<T extends S["Type"], S extends Top> extends Bottom<T, S[
|
|
|
3645
3556
|
export declare function refine<S extends Top, T extends S["Type"]>(refinement: (value: S["Type"]) => value is T, annotations?: Annotations.Filter): (schema: S) => refine<T, S>;
|
|
3646
3557
|
type DistributeBrands<B> = UnionToIntersection<B extends infer U extends string ? Brand.Brand<U> : never>;
|
|
3647
3558
|
/**
|
|
3648
|
-
*
|
|
3649
|
-
* more {@link Brand.Brand} tags.
|
|
3650
|
-
*
|
|
3651
|
-
* **When to use**
|
|
3652
|
-
*
|
|
3653
|
-
* Use as the schema type when generic code needs to retain the wrapped schema
|
|
3654
|
-
* and nominal brand type.
|
|
3655
|
-
*
|
|
3656
|
-
* @see {@link brand} for adding the brand tag to an existing schema
|
|
3559
|
+
* Type-level representation returned by {@link brand}.
|
|
3657
3560
|
*
|
|
3658
3561
|
* @category branding
|
|
3659
3562
|
* @since 3.10.0
|
|
@@ -3693,14 +3596,8 @@ export declare function fromBrand<A extends Brand.Brand<any>>(identifier: string
|
|
|
3693
3596
|
readonly "Type": Brand.Brand.Unbranded<A>;
|
|
3694
3597
|
}>(self: S) => brand<S["Rebuild"], Brand.Brand.Keys<A>>;
|
|
3695
3598
|
/**
|
|
3696
|
-
*
|
|
3599
|
+
* Type-level representation returned by {@link middlewareDecoding}.
|
|
3697
3600
|
*
|
|
3698
|
-
* **Details**
|
|
3699
|
-
*
|
|
3700
|
-
* The interceptor receives the full decoding `Effect` and may replace, modify,
|
|
3701
|
-
* or augment it — including adding service requirements via `RD`.
|
|
3702
|
-
*
|
|
3703
|
-
* @see {@link middlewareDecoding} for the constructor
|
|
3704
3601
|
* @category decoding
|
|
3705
3602
|
* @since 4.0.0
|
|
3706
3603
|
*/
|
|
@@ -3734,14 +3631,8 @@ export interface middlewareDecoding<S extends Top, RD> extends Bottom<S["Type"],
|
|
|
3734
3631
|
*/
|
|
3735
3632
|
export declare function middlewareDecoding<S extends Top, RD>(decode: (effect: Effect.Effect<Option_.Option<S["Type"]>, Issue.Issue, S["DecodingServices"]>, options: AST.ParseOptions) => Effect.Effect<Option_.Option<S["Type"]>, Issue.Issue, RD>): (schema: S) => middlewareDecoding<S, RD>;
|
|
3736
3633
|
/**
|
|
3737
|
-
*
|
|
3634
|
+
* Type-level representation returned by {@link middlewareEncoding}.
|
|
3738
3635
|
*
|
|
3739
|
-
* **Details**
|
|
3740
|
-
*
|
|
3741
|
-
* The interceptor receives the full encoding `Effect` and may replace, modify,
|
|
3742
|
-
* or augment it — including adding service requirements via `RE`.
|
|
3743
|
-
*
|
|
3744
|
-
* @see {@link middlewareEncoding} for the constructor
|
|
3745
3636
|
* @category encoding
|
|
3746
3637
|
* @since 4.0.0
|
|
3747
3638
|
*/
|
|
@@ -3851,16 +3742,8 @@ export declare function catchEncoding<S extends Top>(f: (issue: Issue.Issue) =>
|
|
|
3851
3742
|
*/
|
|
3852
3743
|
export declare function catchEncodingWithContext<S extends Top, R = never>(f: (issue: Issue.Issue) => Effect.Effect<Option_.Option<S["Encoded"]>, Issue.Issue, R>): (self: S) => middlewareEncoding<S, S["EncodingServices"] | R>;
|
|
3853
3744
|
/**
|
|
3854
|
-
*
|
|
3855
|
-
* `From` schema with a `To` schema.
|
|
3856
|
-
*
|
|
3857
|
-
* **Details**
|
|
3745
|
+
* Type-level representation returned by {@link decodeTo}.
|
|
3858
3746
|
*
|
|
3859
|
-
* `Type` is `To["Type"]` and `Encoded` is `From["Encoded"]`. Decoding services
|
|
3860
|
-
* are `To["DecodingServices"] | From["DecodingServices"] | RD`; encoding
|
|
3861
|
-
* services are `To["EncodingServices"] | From["EncodingServices"] | RE`.
|
|
3862
|
-
*
|
|
3863
|
-
* @see {@link compose} for the passthrough (no transformation) variant
|
|
3864
3747
|
* @category transforming
|
|
3865
3748
|
* @since 4.0.0
|
|
3866
3749
|
*/
|
|
@@ -3869,14 +3752,8 @@ export interface decodeTo<To extends Top, From extends Top, RD = never, RE = nev
|
|
|
3869
3752
|
readonly to: To;
|
|
3870
3753
|
}
|
|
3871
3754
|
/**
|
|
3872
|
-
*
|
|
3873
|
-
*
|
|
3874
|
-
* **Details**
|
|
3755
|
+
* Type-level representation returned by {@link decodeTo} without a custom transformation.
|
|
3875
3756
|
*
|
|
3876
|
-
* Equivalent to {@link decodeTo} with `RD = never` and `RE = never`, meaning the schemas
|
|
3877
|
-
* are composed using their natural encoding/decoding chain.
|
|
3878
|
-
*
|
|
3879
|
-
* @see {@link decodeTo} for the transformation variant
|
|
3880
3757
|
* @category transforming
|
|
3881
3758
|
* @since 3.10.0
|
|
3882
3759
|
*/
|
|
@@ -4053,17 +3930,8 @@ export interface WithoutConstructorDefault {
|
|
|
4053
3930
|
readonly "~type.constructor.default": "no-default";
|
|
4054
3931
|
}
|
|
4055
3932
|
/**
|
|
4056
|
-
*
|
|
4057
|
-
* by constructor helpers.
|
|
4058
|
-
*
|
|
4059
|
-
* **Details**
|
|
3933
|
+
* Type-level representation returned by {@link withConstructorDefault}.
|
|
4060
3934
|
*
|
|
4061
|
-
* The default affects `make` and related constructor helpers only; decoding and
|
|
4062
|
-
* encoding still use the original schema behavior. The schema is marked as
|
|
4063
|
-
* already having a constructor default so another constructor default cannot be
|
|
4064
|
-
* added.
|
|
4065
|
-
*
|
|
4066
|
-
* @see {@link withConstructorDefault} for the constructor
|
|
4067
3935
|
* @category constructors
|
|
4068
3936
|
* @since 3.10.0
|
|
4069
3937
|
*/
|
|
@@ -4099,10 +3967,8 @@ export interface withConstructorDefault<S extends Top & WithoutConstructorDefaul
|
|
|
4099
3967
|
*/
|
|
4100
3968
|
export declare function withConstructorDefault<S extends Top & WithoutConstructorDefault>(defaultValue: Effect.Effect<S["~type.make.in"], SchemaError>): (schema: S) => withConstructorDefault<S>;
|
|
4101
3969
|
/**
|
|
4102
|
-
*
|
|
4103
|
-
* side is `optionalKey` and that fills in a default `Encoded` value during decoding.
|
|
3970
|
+
* Type-level representation returned by {@link withDecodingDefaultKey}.
|
|
4104
3971
|
*
|
|
4105
|
-
* @see {@link withDecodingDefaultKey} for the constructor
|
|
4106
3972
|
* @category decoding
|
|
4107
3973
|
* @since 4.0.0
|
|
4108
3974
|
*/
|
|
@@ -4118,7 +3984,7 @@ export interface withDecodingDefaultKey<S extends Top, R = never> extends decode
|
|
|
4118
3984
|
* - `"passthrough"` (default): pass the value through during encoding
|
|
4119
3985
|
* - `"omit"`: omit the key from the encoded output
|
|
4120
3986
|
*
|
|
4121
|
-
* @category
|
|
3987
|
+
* @category options
|
|
4122
3988
|
* @since 4.0.0
|
|
4123
3989
|
*/
|
|
4124
3990
|
export type DecodingDefaultOptions = {
|
|
@@ -4160,11 +4026,8 @@ export type DecodingDefaultOptions = {
|
|
|
4160
4026
|
*/
|
|
4161
4027
|
export declare function withDecodingDefaultKey<S extends Top, R = never>(defaultValue: Effect.Effect<S["Encoded"], SchemaError, R>, options?: DecodingDefaultOptions): (self: S) => withDecodingDefaultKey<S, R>;
|
|
4162
4028
|
/**
|
|
4163
|
-
*
|
|
4164
|
-
* `Encoded` side is `optionalKey` and that fills in a default `Type` value
|
|
4165
|
-
* during decoding.
|
|
4029
|
+
* Type-level representation returned by {@link withDecodingDefaultTypeKey}.
|
|
4166
4030
|
*
|
|
4167
|
-
* @see {@link withDecodingDefaultTypeKey} for the constructor
|
|
4168
4031
|
* @category decoding
|
|
4169
4032
|
* @since 4.0.0
|
|
4170
4033
|
*/
|
|
@@ -4195,10 +4058,8 @@ export interface withDecodingDefaultTypeKey<S extends Top, R = never> extends de
|
|
|
4195
4058
|
*/
|
|
4196
4059
|
export declare function withDecodingDefaultTypeKey<S extends Top, R = never>(defaultValue: Effect.Effect<S["Type"], SchemaError, R>, options?: DecodingDefaultOptions): (self: S) => withDecodingDefaultTypeKey<S, R>;
|
|
4197
4060
|
/**
|
|
4198
|
-
*
|
|
4199
|
-
* side is `optional` and that fills in a default `Encoded` value during decoding.
|
|
4061
|
+
* Type-level representation returned by {@link withDecodingDefault}.
|
|
4200
4062
|
*
|
|
4201
|
-
* @see {@link withDecodingDefault} for the constructor
|
|
4202
4063
|
* @category decoding
|
|
4203
4064
|
* @since 3.10.0
|
|
4204
4065
|
*/
|
|
@@ -4241,11 +4102,8 @@ export interface withDecodingDefault<S extends Top, R = never> extends decodeTo<
|
|
|
4241
4102
|
*/
|
|
4242
4103
|
export declare function withDecodingDefault<S extends Top, R = never>(defaultValue: Effect.Effect<S["Encoded"], SchemaError, R>, options?: DecodingDefaultOptions): (self: S) => withDecodingDefault<S, R>;
|
|
4243
4104
|
/**
|
|
4244
|
-
*
|
|
4245
|
-
* `Encoded` side is `optional` and that fills in a default `Type` value during
|
|
4246
|
-
* decoding.
|
|
4105
|
+
* Type-level representation returned by {@link withDecodingDefaultType}.
|
|
4247
4106
|
*
|
|
4248
|
-
* @see {@link withDecodingDefaultType} for the constructor
|
|
4249
4107
|
* @category decoding
|
|
4250
4108
|
* @since 4.0.0
|
|
4251
4109
|
*/
|
|
@@ -4276,13 +4134,8 @@ export interface withDecodingDefaultType<S extends Top, R = never> extends decod
|
|
|
4276
4134
|
*/
|
|
4277
4135
|
export declare function withDecodingDefaultType<S extends Top, R = never>(defaultValue: Effect.Effect<S["Type"], SchemaError, R>, options?: DecodingDefaultOptions): (self: S) => withDecodingDefaultType<S, R>;
|
|
4278
4136
|
/**
|
|
4279
|
-
*
|
|
4137
|
+
* Type-level representation returned by {@link tag}.
|
|
4280
4138
|
*
|
|
4281
|
-
* **Details**
|
|
4282
|
-
*
|
|
4283
|
-
* Used as the type of the `_tag` field in {@link TaggedStruct} and related helpers.
|
|
4284
|
-
*
|
|
4285
|
-
* @see {@link tag} for the constructor
|
|
4286
4139
|
* @category constructors
|
|
4287
4140
|
* @since 3.10.0
|
|
4288
4141
|
*/
|
|
@@ -4345,9 +4198,8 @@ export declare function tag<Tag extends AST.LiteralValue>(literal: Tag): tag<Tag
|
|
|
4345
4198
|
*/
|
|
4346
4199
|
export declare function tagDefaultOmit<Tag extends AST.LiteralValue>(literal: Tag): withDecodingDefaultKey<tag<Tag>, never>;
|
|
4347
4200
|
/**
|
|
4348
|
-
*
|
|
4201
|
+
* Type-level representation returned by {@link TaggedStruct}.
|
|
4349
4202
|
*
|
|
4350
|
-
* @see {@link TaggedStruct} for the constructor
|
|
4351
4203
|
* @category models
|
|
4352
4204
|
* @since 3.10.0
|
|
4353
4205
|
*/
|
|
@@ -4433,9 +4285,8 @@ type TaggedUnionUtils<Tag extends PropertyKey, Members extends ReadonlyArray<Top
|
|
|
4433
4285
|
};
|
|
4434
4286
|
};
|
|
4435
4287
|
/**
|
|
4436
|
-
*
|
|
4288
|
+
* Type-level representation returned by {@link toTaggedUnion}.
|
|
4437
4289
|
*
|
|
4438
|
-
* @see {@link toTaggedUnion} for the constructor
|
|
4439
4290
|
* @category combinators
|
|
4440
4291
|
* @since 4.0.0
|
|
4441
4292
|
*/
|
|
@@ -4472,10 +4323,8 @@ export declare function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag):
|
|
|
4472
4323
|
readonly Type: { readonly [K in Tag]: PropertyKey; };
|
|
4473
4324
|
}>>(self: Union<Members>) => toTaggedUnion<Tag, Members>;
|
|
4474
4325
|
/**
|
|
4475
|
-
*
|
|
4476
|
-
* Produced by {@link TaggedUnion}.
|
|
4326
|
+
* Type-level representation returned by {@link TaggedUnion}.
|
|
4477
4327
|
*
|
|
4478
|
-
* @see {@link TaggedUnion} for the constructor
|
|
4479
4328
|
* @category models
|
|
4480
4329
|
* @since 4.0.0
|
|
4481
4330
|
*/
|
|
@@ -4536,11 +4385,8 @@ export declare function TaggedUnion<const CasesByTag extends Record<string, Stru
|
|
|
4536
4385
|
readonly [K in keyof CasesByTag & string]: TaggedStruct<K, CasesByTag[K]>;
|
|
4537
4386
|
}>;
|
|
4538
4387
|
/**
|
|
4539
|
-
*
|
|
4540
|
-
* Carries the same encoded/decoded shape as `S` but replaces `Type` with `Self & Brand`,
|
|
4541
|
-
* making the decoded value nominally distinct.
|
|
4388
|
+
* Type-level representation returned by {@link Opaque}.
|
|
4542
4389
|
*
|
|
4543
|
-
* @see {@link Opaque} for the constructor
|
|
4544
4390
|
* @category models
|
|
4545
4391
|
* @since 4.0.0
|
|
4546
4392
|
*/
|
|
@@ -4573,9 +4419,8 @@ export interface Opaque<Self, S extends Top, Brand> extends Bottom<Self, S["Enco
|
|
|
4573
4419
|
*/
|
|
4574
4420
|
export declare function Opaque<Self, Brand = {}>(): <S extends Top>(schema: S) => Opaque<Self, S, Brand> & Omit<S, keyof Top>;
|
|
4575
4421
|
/**
|
|
4576
|
-
*
|
|
4422
|
+
* Type-level representation returned by {@link instanceOf}.
|
|
4577
4423
|
*
|
|
4578
|
-
* @see {@link instanceOf} for the constructor
|
|
4579
4424
|
* @category models
|
|
4580
4425
|
* @since 3.10.0
|
|
4581
4426
|
*/
|
|
@@ -4667,7 +4512,7 @@ export declare function link<T>(): <To extends Top>(encodeTo: To, transformation
|
|
|
4667
4512
|
* // at ["c"])]))
|
|
4668
4513
|
* ```
|
|
4669
4514
|
*
|
|
4670
|
-
* @category
|
|
4515
|
+
* @category constructors
|
|
4671
4516
|
* @since 4.0.0
|
|
4672
4517
|
*/
|
|
4673
4518
|
export declare const makeFilter: <T>(filter: (input: T, ast: AST.AST, options: AST.ParseOptions) => FilterOutput, annotations?: Annotations.Filter | undefined, abort?: boolean) => AST.Filter<T>;
|
|
@@ -4721,7 +4566,7 @@ export type FilterOutput = undefined | boolean | FilterIssue | ReadonlyArray<Fil
|
|
|
4721
4566
|
* Groups multiple checks into a single {@link AST.FilterGroup}, applying
|
|
4722
4567
|
* optional shared annotations to the group as a whole.
|
|
4723
4568
|
*
|
|
4724
|
-
* @category
|
|
4569
|
+
* @category constructors
|
|
4725
4570
|
* @since 4.0.0
|
|
4726
4571
|
*/
|
|
4727
4572
|
export declare function makeFilterGroup<T>(checks: readonly [AST.Check<T>, ...Array<AST.Check<T>>], annotations?: Annotations.Filter | undefined): AST.FilterGroup<T>;
|
|
@@ -5782,10 +5627,9 @@ export declare function isPropertyNames(keySchema: Top, annotations?: Annotation
|
|
|
5782
5627
|
*/
|
|
5783
5628
|
export declare function isUnique<T>(annotations?: Annotations.Filter): AST.Filter<readonly T[]>;
|
|
5784
5629
|
/**
|
|
5785
|
-
* Type-level representation of
|
|
5786
|
-
* strings with a length of at least one.
|
|
5630
|
+
* Type-level representation of {@link NonEmptyString}.
|
|
5787
5631
|
*
|
|
5788
|
-
* @category
|
|
5632
|
+
* @category string
|
|
5789
5633
|
* @since 3.10.0
|
|
5790
5634
|
*/
|
|
5791
5635
|
export interface NonEmptyString extends String {
|
|
@@ -5795,15 +5639,14 @@ export interface NonEmptyString extends String {
|
|
|
5795
5639
|
* Schema for non-empty strings. Validates that a string has at least one
|
|
5796
5640
|
* character.
|
|
5797
5641
|
*
|
|
5798
|
-
* @category
|
|
5642
|
+
* @category string
|
|
5799
5643
|
* @since 3.10.0
|
|
5800
5644
|
*/
|
|
5801
5645
|
export declare const NonEmptyString: NonEmptyString;
|
|
5802
5646
|
/**
|
|
5803
|
-
* Type-level representation of
|
|
5804
|
-
* length is exactly one.
|
|
5647
|
+
* Type-level representation of {@link Char}.
|
|
5805
5648
|
*
|
|
5806
|
-
* @category
|
|
5649
|
+
* @category string
|
|
5807
5650
|
* @since 3.10.0
|
|
5808
5651
|
*/
|
|
5809
5652
|
export interface Char extends String {
|
|
@@ -5825,26 +5668,12 @@ export interface Char extends String {
|
|
|
5825
5668
|
* @see {@link NonEmptyString} for strings with length greater than zero
|
|
5826
5669
|
* @see {@link isLengthBetween} for the underlying length check
|
|
5827
5670
|
*
|
|
5828
|
-
* @category
|
|
5671
|
+
* @category string
|
|
5829
5672
|
* @since 3.10.0
|
|
5830
5673
|
*/
|
|
5831
5674
|
export declare const Char: Char;
|
|
5832
5675
|
/**
|
|
5833
|
-
*
|
|
5834
|
-
* either `None` or `Some<A>`.
|
|
5835
|
-
*
|
|
5836
|
-
* **Example** (Option schema)
|
|
5837
|
-
*
|
|
5838
|
-
* ```ts
|
|
5839
|
-
* import { Option, Schema } from "effect"
|
|
5840
|
-
*
|
|
5841
|
-
* const schema = Schema.Option(Schema.Number)
|
|
5842
|
-
*
|
|
5843
|
-
* Schema.decodeUnknownSync(schema)(Option.some(1))
|
|
5844
|
-
* // => Some(1)
|
|
5845
|
-
* Schema.decodeUnknownSync(schema)(Option.none())
|
|
5846
|
-
* // => None
|
|
5847
|
-
* ```
|
|
5676
|
+
* Type-level representation returned by {@link Option}.
|
|
5848
5677
|
*
|
|
5849
5678
|
* @category Option
|
|
5850
5679
|
* @since 3.10.0
|
|
@@ -5878,8 +5707,7 @@ export type OptionIso<A extends Top> = {
|
|
|
5878
5707
|
*/
|
|
5879
5708
|
export declare function Option<A extends Top>(value: A): Option<A>;
|
|
5880
5709
|
/**
|
|
5881
|
-
* Type-level representation
|
|
5882
|
-
* other values as `Some`.
|
|
5710
|
+
* Type-level representation returned by {@link OptionFromNullOr}.
|
|
5883
5711
|
*
|
|
5884
5712
|
* @category Option
|
|
5885
5713
|
* @since 3.10.0
|
|
@@ -5905,8 +5733,7 @@ export interface OptionFromNullOr<S extends Top> extends decodeTo<Option<toType<
|
|
|
5905
5733
|
*/
|
|
5906
5734
|
export declare function OptionFromNullOr<S extends Top>(schema: S): OptionFromNullOr<S>;
|
|
5907
5735
|
/**
|
|
5908
|
-
* Type-level representation
|
|
5909
|
-
* all other values as `Some`.
|
|
5736
|
+
* Type-level representation returned by {@link OptionFromUndefinedOr}.
|
|
5910
5737
|
*
|
|
5911
5738
|
* @category Option
|
|
5912
5739
|
* @since 3.10.0
|
|
@@ -5932,8 +5759,7 @@ export interface OptionFromUndefinedOr<S extends Top> extends decodeTo<Option<to
|
|
|
5932
5759
|
*/
|
|
5933
5760
|
export declare function OptionFromUndefinedOr<S extends Top>(schema: S): OptionFromUndefinedOr<S>;
|
|
5934
5761
|
/**
|
|
5935
|
-
* Type-level representation
|
|
5936
|
-
* `None` and all other values as `Some`.
|
|
5762
|
+
* Type-level representation returned by {@link OptionFromNullishOr}.
|
|
5937
5763
|
*
|
|
5938
5764
|
* @category Option
|
|
5939
5765
|
* @since 3.10.0
|
|
@@ -5961,8 +5787,7 @@ export declare function OptionFromNullishOr<S extends Top>(schema: S, options?:
|
|
|
5961
5787
|
onNoneEncoding: null | undefined;
|
|
5962
5788
|
}): OptionFromNullishOr<S>;
|
|
5963
5789
|
/**
|
|
5964
|
-
* Type-level representation
|
|
5965
|
-
* `None` and a present key as `Some`.
|
|
5790
|
+
* Type-level representation returned by {@link OptionFromOptionalKey}.
|
|
5966
5791
|
*
|
|
5967
5792
|
* @category Option
|
|
5968
5793
|
* @since 4.0.0
|
|
@@ -5988,8 +5813,7 @@ export interface OptionFromOptionalKey<S extends Top> extends decodeTo<Option<to
|
|
|
5988
5813
|
*/
|
|
5989
5814
|
export declare function OptionFromOptionalKey<S extends Top>(schema: S): OptionFromOptionalKey<S>;
|
|
5990
5815
|
/**
|
|
5991
|
-
* Type-level representation
|
|
5992
|
-
* `undefined` value as `None` and other present values as `Some`.
|
|
5816
|
+
* Type-level representation returned by {@link OptionFromOptional}.
|
|
5993
5817
|
*
|
|
5994
5818
|
* @category Option
|
|
5995
5819
|
* @since 4.0.0
|
|
@@ -6017,8 +5841,7 @@ export interface OptionFromOptional<S extends Top> extends decodeTo<Option<toTyp
|
|
|
6017
5841
|
*/
|
|
6018
5842
|
export declare function OptionFromOptional<S extends Top>(schema: S): OptionFromOptional<S>;
|
|
6019
5843
|
/**
|
|
6020
|
-
* Type-level representation
|
|
6021
|
-
* or `null` as `None` and all other present values as `Some`.
|
|
5844
|
+
* Type-level representation returned by {@link OptionFromOptionalNullOr}.
|
|
6022
5845
|
*
|
|
6023
5846
|
* @category Option
|
|
6024
5847
|
* @since 4.0.0
|
|
@@ -6051,8 +5874,7 @@ export declare function OptionFromOptionalNullOr<S extends Top>(schema: S, optio
|
|
|
6051
5874
|
readonly onNoneEncoding: "omit" | null | undefined;
|
|
6052
5875
|
}): OptionFromOptionalNullOr<S>;
|
|
6053
5876
|
/**
|
|
6054
|
-
*
|
|
6055
|
-
* succeeds with `A` or fails with `E`.
|
|
5877
|
+
* Type-level representation returned by {@link Result}.
|
|
6056
5878
|
*
|
|
6057
5879
|
* @category schemas
|
|
6058
5880
|
* @since 4.0.0
|
|
@@ -6088,8 +5910,7 @@ export type ResultIso<A extends Top, E extends Top> = {
|
|
|
6088
5910
|
*/
|
|
6089
5911
|
export declare function Result<A extends Top, E extends Top>(success: A, failure: E): Result<A, E>;
|
|
6090
5912
|
/**
|
|
6091
|
-
*
|
|
6092
|
-
* values. The inner value is hidden from error messages.
|
|
5913
|
+
* Type-level representation returned by {@link Redacted}.
|
|
6093
5914
|
*
|
|
6094
5915
|
* @category Redacted
|
|
6095
5916
|
* @since 3.10.0
|
|
@@ -6126,8 +5947,7 @@ export declare function Redacted<S extends Top>(value: S, options?: {
|
|
|
6126
5947
|
readonly disallowJsonEncode?: boolean | undefined;
|
|
6127
5948
|
}): Redacted<S>;
|
|
6128
5949
|
/**
|
|
6129
|
-
* Type-level representation
|
|
6130
|
-
* provided schema and wraps the result in `Redacted`.
|
|
5950
|
+
* Type-level representation returned by {@link RedactedFromValue}.
|
|
6131
5951
|
*
|
|
6132
5952
|
* @category Redacted
|
|
6133
5953
|
* @since 4.0.0
|
|
@@ -6156,22 +5976,7 @@ export declare function RedactedFromValue<S extends Top>(value: S, options?: {
|
|
|
6156
5976
|
readonly disallowEncode?: boolean | undefined;
|
|
6157
5977
|
}): RedactedFromValue<S>;
|
|
6158
5978
|
/**
|
|
6159
|
-
*
|
|
6160
|
-
* a typed error (`Fail`), an unexpected defect (`Die`), or an interrupt
|
|
6161
|
-
* (`Interrupt`).
|
|
6162
|
-
*
|
|
6163
|
-
* **When to use**
|
|
6164
|
-
*
|
|
6165
|
-
* Use as the schema type when generic code needs to retain the typed failure
|
|
6166
|
-
* and defect schemas for a single cause reason.
|
|
6167
|
-
*
|
|
6168
|
-
* **Details**
|
|
6169
|
-
*
|
|
6170
|
-
* The `error` schema validates typed failures and the `defect` schema validates
|
|
6171
|
-
* unexpected defects.
|
|
6172
|
-
*
|
|
6173
|
-
* @see {@link CauseReason} for constructing this schema type
|
|
6174
|
-
* @see {@link CauseReasonIso} for the ISO shape of each cause reason
|
|
5979
|
+
* Type-level representation returned by {@link CauseReason}.
|
|
6175
5980
|
*
|
|
6176
5981
|
* @category CauseReason
|
|
6177
5982
|
* @since 4.0.0
|
|
@@ -6224,21 +6029,7 @@ export type CauseReasonIso<E extends Top, D extends Top> = {
|
|
|
6224
6029
|
*/
|
|
6225
6030
|
export declare function CauseReason<E extends Top, D extends Top>(error: E, defect: D): CauseReason<E, D>;
|
|
6226
6031
|
/**
|
|
6227
|
-
*
|
|
6228
|
-
* reasons combining typed errors, defects, and interrupts.
|
|
6229
|
-
*
|
|
6230
|
-
* **When to use**
|
|
6231
|
-
*
|
|
6232
|
-
* Use as the schema type when generic code needs to retain the typed failure
|
|
6233
|
-
* and defect schemas for a full cause.
|
|
6234
|
-
*
|
|
6235
|
-
* **Details**
|
|
6236
|
-
*
|
|
6237
|
-
* The `error` schema validates typed failures and the `defect` schema validates
|
|
6238
|
-
* unexpected defects.
|
|
6239
|
-
*
|
|
6240
|
-
* @see {@link Cause} for constructing this schema type
|
|
6241
|
-
* @see {@link CauseIso} for the ordered array representation used by the schema ISO
|
|
6032
|
+
* Type-level representation returned by {@link Cause}.
|
|
6242
6033
|
*
|
|
6243
6034
|
* @category Cause
|
|
6244
6035
|
* @since 3.10.0
|
|
@@ -6287,7 +6078,7 @@ export type CauseIso<E extends Top, D extends Top> = ReadonlyArray<CauseReasonIs
|
|
|
6287
6078
|
*/
|
|
6288
6079
|
export declare function Cause<E extends Top, D extends Top>(error: E, defect: D): Cause<E, D>;
|
|
6289
6080
|
/**
|
|
6290
|
-
* Type-level representation of
|
|
6081
|
+
* Type-level representation of {@link Error}.
|
|
6291
6082
|
*
|
|
6292
6083
|
* @category Error
|
|
6293
6084
|
* @since 4.0.0
|
|
@@ -6324,8 +6115,7 @@ export declare const Error: Error;
|
|
|
6324
6115
|
*/
|
|
6325
6116
|
export declare const ErrorWithStack: Error;
|
|
6326
6117
|
/**
|
|
6327
|
-
* Type-level representation of
|
|
6328
|
-
* `Error` values and arbitrary unknown defect values.
|
|
6118
|
+
* Type-level representation of {@link Defect}.
|
|
6329
6119
|
*
|
|
6330
6120
|
* @category Defect
|
|
6331
6121
|
* @since 3.10.0
|
|
@@ -6362,8 +6152,7 @@ export declare const Defect: Defect;
|
|
|
6362
6152
|
*/
|
|
6363
6153
|
export declare const DefectWithStack: Defect;
|
|
6364
6154
|
/**
|
|
6365
|
-
*
|
|
6366
|
-
* failure with a `Cause` containing typed errors and defects.
|
|
6155
|
+
* Type-level representation returned by {@link Exit}.
|
|
6367
6156
|
*
|
|
6368
6157
|
* @category Exit
|
|
6369
6158
|
* @since 3.10.0
|
|
@@ -6401,17 +6190,7 @@ export type ExitIso<A extends Top, E extends Top, D extends Top> = {
|
|
|
6401
6190
|
*/
|
|
6402
6191
|
export declare function Exit<A extends Top, E extends Top, D extends Top>(value: A, error: E, defect: D): Exit<A, E, D>;
|
|
6403
6192
|
/**
|
|
6404
|
-
* Type-level representation
|
|
6405
|
-
* validated by the provided schemas.
|
|
6406
|
-
*
|
|
6407
|
-
* **When to use**
|
|
6408
|
-
*
|
|
6409
|
-
* Use as a type annotation for a `ReadonlyMap` schema when exposing or returning
|
|
6410
|
-
* the schema while preserving its key schema, value schema, and ISO
|
|
6411
|
-
* representation.
|
|
6412
|
-
*
|
|
6413
|
-
* @see {@link ReadonlyMap} for constructing this schema type from key and value schemas
|
|
6414
|
-
* @see {@link ReadonlyMapIso} for the readonly tuple-array ISO representation used by this schema
|
|
6193
|
+
* Type-level representation returned by {@link ReadonlyMap}.
|
|
6415
6194
|
*
|
|
6416
6195
|
* @category ReadonlyMap
|
|
6417
6196
|
* @since 4.0.0
|
|
@@ -6438,8 +6217,7 @@ export type ReadonlyMapIso<Key extends Top, Value extends Top> = ReadonlyArray<r
|
|
|
6438
6217
|
*/
|
|
6439
6218
|
export declare function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value: Value): $ReadonlyMap<Key, Value>;
|
|
6440
6219
|
/**
|
|
6441
|
-
*
|
|
6442
|
-
* provided schemas.
|
|
6220
|
+
* Type-level representation returned by {@link HashMap}.
|
|
6443
6221
|
*
|
|
6444
6222
|
* @category HashMap
|
|
6445
6223
|
* @since 3.10.0
|
|
@@ -6465,16 +6243,7 @@ export type HashMapIso<Key extends Top, Value extends Top> = ReadonlyArray<reado
|
|
|
6465
6243
|
*/
|
|
6466
6244
|
export declare function HashMap<Key extends Top, Value extends Top>(key: Key, value: Value): HashMap<Key, Value>;
|
|
6467
6245
|
/**
|
|
6468
|
-
* Type-level representation
|
|
6469
|
-
* by the provided element schema.
|
|
6470
|
-
*
|
|
6471
|
-
* **When to use**
|
|
6472
|
-
*
|
|
6473
|
-
* Use to name or constrain the schema type produced by `ReadonlySet` when
|
|
6474
|
-
* generic code needs to retain the element schema type.
|
|
6475
|
-
*
|
|
6476
|
-
* @see {@link ReadonlySet} for constructing this schema type
|
|
6477
|
-
* @see {@link ReadonlySetIso} for the array representation used by this schema's ISO
|
|
6246
|
+
* Type-level representation returned by {@link ReadonlySet}.
|
|
6478
6247
|
*
|
|
6479
6248
|
* @category ReadonlySet
|
|
6480
6249
|
* @since 4.0.0
|
|
@@ -6499,8 +6268,7 @@ export type ReadonlySetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>;
|
|
|
6499
6268
|
*/
|
|
6500
6269
|
export declare function ReadonlySet<Value extends Top>(value: Value): $ReadonlySet<Value>;
|
|
6501
6270
|
/**
|
|
6502
|
-
*
|
|
6503
|
-
* schema.
|
|
6271
|
+
* Type-level representation returned by {@link HashSet}.
|
|
6504
6272
|
*
|
|
6505
6273
|
* @category HashSet
|
|
6506
6274
|
* @since 3.10.0
|
|
@@ -6525,8 +6293,7 @@ export type HashSetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>;
|
|
|
6525
6293
|
*/
|
|
6526
6294
|
export declare function HashSet<Value extends Top>(value: Value): HashSet<Value>;
|
|
6527
6295
|
/**
|
|
6528
|
-
*
|
|
6529
|
-
* must conform to the provided schema.
|
|
6296
|
+
* Type-level representation returned by {@link Chunk}.
|
|
6530
6297
|
*
|
|
6531
6298
|
* @category Chunk
|
|
6532
6299
|
* @since 3.10.0
|
|
@@ -6558,7 +6325,7 @@ export type ChunkIso<Value extends Top> = ReadonlyArray<Value["Iso"]>;
|
|
|
6558
6325
|
*/
|
|
6559
6326
|
export declare function Chunk<Value extends Top>(value: Value): Chunk<Value>;
|
|
6560
6327
|
/**
|
|
6561
|
-
* Type-level representation of
|
|
6328
|
+
* Type-level representation of {@link RegExp}.
|
|
6562
6329
|
*
|
|
6563
6330
|
* @category RegExp
|
|
6564
6331
|
* @since 4.0.0
|
|
@@ -6578,7 +6345,7 @@ export interface RegExp extends instanceOf<globalThis.RegExp> {
|
|
|
6578
6345
|
*/
|
|
6579
6346
|
export declare const RegExp: RegExp;
|
|
6580
6347
|
/**
|
|
6581
|
-
* Type-level representation of
|
|
6348
|
+
* Type-level representation of {@link URL}.
|
|
6582
6349
|
*
|
|
6583
6350
|
* @category URL
|
|
6584
6351
|
* @since 4.0.0
|
|
@@ -6600,8 +6367,7 @@ export interface URL extends instanceOf<globalThis.URL> {
|
|
|
6600
6367
|
*/
|
|
6601
6368
|
export declare const URL: URL;
|
|
6602
6369
|
/**
|
|
6603
|
-
* Type-level representation of
|
|
6604
|
-
* strings into JavaScript `URL` instances.
|
|
6370
|
+
* Type-level representation of {@link URLFromString}.
|
|
6605
6371
|
*
|
|
6606
6372
|
* @category URL
|
|
6607
6373
|
* @since 4.0.0
|
|
@@ -6625,8 +6391,7 @@ export interface URLFromString extends decodeTo<URL, String> {
|
|
|
6625
6391
|
*/
|
|
6626
6392
|
export declare const URLFromString: URLFromString;
|
|
6627
6393
|
/**
|
|
6628
|
-
* Type-level representation of
|
|
6629
|
-
* including invalid dates.
|
|
6394
|
+
* Type-level representation of {@link Date}.
|
|
6630
6395
|
*
|
|
6631
6396
|
* @category Date
|
|
6632
6397
|
* @since 4.0.0
|
|
@@ -6664,8 +6429,7 @@ export interface Date extends instanceOf<globalThis.Date> {
|
|
|
6664
6429
|
*/
|
|
6665
6430
|
export declare const Date: Date;
|
|
6666
6431
|
/**
|
|
6667
|
-
* Type-level representation of
|
|
6668
|
-
* JavaScript `Date` instances.
|
|
6432
|
+
* Type-level representation of {@link DateFromString}.
|
|
6669
6433
|
*
|
|
6670
6434
|
* @category Date
|
|
6671
6435
|
* @since 3.10.0
|
|
@@ -6702,8 +6466,7 @@ export interface DateFromString extends decodeTo<Date, String> {
|
|
|
6702
6466
|
*/
|
|
6703
6467
|
export declare const DateFromString: DateFromString;
|
|
6704
6468
|
/**
|
|
6705
|
-
* Type-level representation of
|
|
6706
|
-
* JavaScript `Date` instances.
|
|
6469
|
+
* Type-level representation of {@link DateValid}.
|
|
6707
6470
|
*
|
|
6708
6471
|
* @category Date
|
|
6709
6472
|
* @since 4.0.0
|
|
@@ -6724,7 +6487,7 @@ export interface DateValid extends Date {
|
|
|
6724
6487
|
*/
|
|
6725
6488
|
export declare const DateValid: DateValid;
|
|
6726
6489
|
/**
|
|
6727
|
-
* Type-level representation of
|
|
6490
|
+
* Type-level representation of {@link Duration}.
|
|
6728
6491
|
*
|
|
6729
6492
|
* @category Duration
|
|
6730
6493
|
* @since 3.10.0
|
|
@@ -6755,8 +6518,7 @@ export interface Duration extends declare<Duration_.Duration> {
|
|
|
6755
6518
|
*/
|
|
6756
6519
|
export declare const Duration: Duration;
|
|
6757
6520
|
/**
|
|
6758
|
-
* Type-level representation of
|
|
6759
|
-
* accepted by `Duration.fromInput` into `Duration` values.
|
|
6521
|
+
* Type-level representation of {@link DurationFromString}.
|
|
6760
6522
|
*
|
|
6761
6523
|
* @category Duration
|
|
6762
6524
|
* @since 4.0.0
|
|
@@ -6781,8 +6543,7 @@ export interface DurationFromString extends decodeTo<Duration, String> {
|
|
|
6781
6543
|
*/
|
|
6782
6544
|
export declare const DurationFromString: DurationFromString;
|
|
6783
6545
|
/**
|
|
6784
|
-
* Type-level representation of
|
|
6785
|
-
* nanosecond `bigint` values into `Duration` values.
|
|
6546
|
+
* Type-level representation of {@link DurationFromNanos}.
|
|
6786
6547
|
*
|
|
6787
6548
|
* @category Duration
|
|
6788
6549
|
* @since 3.10.0
|
|
@@ -6809,8 +6570,7 @@ export interface DurationFromNanos extends decodeTo<Duration, BigInt> {
|
|
|
6809
6570
|
*/
|
|
6810
6571
|
export declare const DurationFromNanos: DurationFromNanos;
|
|
6811
6572
|
/**
|
|
6812
|
-
* Type-level representation of
|
|
6813
|
-
* non-negative millisecond numbers into `Duration` values.
|
|
6573
|
+
* Type-level representation of {@link DurationFromMillis}.
|
|
6814
6574
|
*
|
|
6815
6575
|
* @category Duration
|
|
6816
6576
|
* @since 3.10.0
|
|
@@ -6838,7 +6598,7 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
|
|
|
6838
6598
|
*/
|
|
6839
6599
|
export declare const DurationFromMillis: DurationFromMillis;
|
|
6840
6600
|
/**
|
|
6841
|
-
* Type-level representation of
|
|
6601
|
+
* Type-level representation of {@link BigDecimal}.
|
|
6842
6602
|
*
|
|
6843
6603
|
* @category BigDecimal
|
|
6844
6604
|
* @since 3.10.0
|
|
@@ -6867,8 +6627,7 @@ export interface BigDecimal extends declare<BigDecimal_.BigDecimal> {
|
|
|
6867
6627
|
*/
|
|
6868
6628
|
export declare const BigDecimal: BigDecimal;
|
|
6869
6629
|
/**
|
|
6870
|
-
* Type-level representation of
|
|
6871
|
-
* `BigDecimal` values.
|
|
6630
|
+
* Type-level representation of {@link BigDecimalFromString}.
|
|
6872
6631
|
*
|
|
6873
6632
|
* @category BigDecimal
|
|
6874
6633
|
* @since 4.0.0
|
|
@@ -6905,10 +6664,9 @@ export interface BigDecimalFromString extends decodeTo<BigDecimal, String> {
|
|
|
6905
6664
|
*/
|
|
6906
6665
|
export declare const BigDecimalFromString: BigDecimalFromString;
|
|
6907
6666
|
/**
|
|
6908
|
-
* Type-level representation of
|
|
6909
|
-
* JSON-encoded strings into `unknown` values.
|
|
6667
|
+
* Type-level representation of {@link UnknownFromJsonString}.
|
|
6910
6668
|
*
|
|
6911
|
-
* @category
|
|
6669
|
+
* @category models
|
|
6912
6670
|
* @since 4.0.0
|
|
6913
6671
|
*/
|
|
6914
6672
|
export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
@@ -6936,15 +6694,14 @@ export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
|
6936
6694
|
* // => { a: 1, b: 2 }
|
|
6937
6695
|
* ```
|
|
6938
6696
|
*
|
|
6939
|
-
* @category
|
|
6697
|
+
* @category schemas
|
|
6940
6698
|
* @since 4.0.0
|
|
6941
6699
|
*/
|
|
6942
6700
|
export declare const UnknownFromJsonString: UnknownFromJsonString;
|
|
6943
6701
|
/**
|
|
6944
|
-
* Type-level representation
|
|
6945
|
-
* decodes the parsed value with the provided schema.
|
|
6702
|
+
* Type-level representation returned by {@link fromJsonString}.
|
|
6946
6703
|
*
|
|
6947
|
-
* @category
|
|
6704
|
+
* @category models
|
|
6948
6705
|
* @since 4.0.0
|
|
6949
6706
|
*/
|
|
6950
6707
|
export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
@@ -7013,14 +6770,14 @@ export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
|
7013
6770
|
* // }
|
|
7014
6771
|
* ```
|
|
7015
6772
|
*
|
|
7016
|
-
* @category
|
|
6773
|
+
* @category constructors
|
|
7017
6774
|
* @since 4.0.0
|
|
7018
6775
|
*/
|
|
7019
6776
|
export declare function fromJsonString<S extends Top>(schema: S): fromJsonString<S>;
|
|
7020
6777
|
/**
|
|
7021
|
-
* Type-level representation of
|
|
6778
|
+
* Type-level representation of {@link File}.
|
|
7022
6779
|
*
|
|
7023
|
-
* @category
|
|
6780
|
+
* @category file
|
|
7024
6781
|
* @since 4.0.0
|
|
7025
6782
|
*/
|
|
7026
6783
|
export interface File extends instanceOf<globalThis.File> {
|
|
@@ -7034,12 +6791,12 @@ export interface File extends instanceOf<globalThis.File> {
|
|
|
7034
6791
|
* The default JSON serializer encodes a `File` as `{ data, type, name, lastModified }`
|
|
7035
6792
|
* where `data` is base64-encoded.
|
|
7036
6793
|
*
|
|
7037
|
-
* @category
|
|
6794
|
+
* @category file
|
|
7038
6795
|
* @since 4.0.0
|
|
7039
6796
|
*/
|
|
7040
6797
|
export declare const File: File;
|
|
7041
6798
|
/**
|
|
7042
|
-
* Type-level representation of
|
|
6799
|
+
* Type-level representation of {@link FormData}.
|
|
7043
6800
|
*
|
|
7044
6801
|
* @category FormData
|
|
7045
6802
|
* @since 4.0.0
|
|
@@ -7060,8 +6817,7 @@ export interface FormData extends instanceOf<globalThis.FormData> {
|
|
|
7060
6817
|
*/
|
|
7061
6818
|
export declare const FormData: FormData;
|
|
7062
6819
|
/**
|
|
7063
|
-
* Type-level representation
|
|
7064
|
-
* record and then decodes it with the provided schema.
|
|
6820
|
+
* Type-level representation returned by {@link fromFormData}.
|
|
7065
6821
|
*
|
|
7066
6822
|
* @category FormData
|
|
7067
6823
|
* @since 4.0.0
|
|
@@ -7159,10 +6915,9 @@ export interface fromFormData<S extends Top> extends decodeTo<S, FormData> {
|
|
|
7159
6915
|
*/
|
|
7160
6916
|
export declare function fromFormData<S extends Top>(schema: S): fromFormData<S>;
|
|
7161
6917
|
/**
|
|
7162
|
-
* Type-level representation of
|
|
7163
|
-
* instances.
|
|
6918
|
+
* Type-level representation of {@link URLSearchParams}.
|
|
7164
6919
|
*
|
|
7165
|
-
* @category
|
|
6920
|
+
* @category search params
|
|
7166
6921
|
* @since 4.0.0
|
|
7167
6922
|
*/
|
|
7168
6923
|
export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams> {
|
|
@@ -7175,15 +6930,14 @@ export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams>
|
|
|
7175
6930
|
*
|
|
7176
6931
|
* The default JSON serializer encodes a `URLSearchParams` as a query string.
|
|
7177
6932
|
*
|
|
7178
|
-
* @category
|
|
6933
|
+
* @category search params
|
|
7179
6934
|
* @since 4.0.0
|
|
7180
6935
|
*/
|
|
7181
6936
|
export declare const URLSearchParams: URLSearchParams;
|
|
7182
6937
|
/**
|
|
7183
|
-
* Type-level representation
|
|
7184
|
-
* tree record and then decodes it with the provided schema.
|
|
6938
|
+
* Type-level representation returned by {@link fromURLSearchParams}.
|
|
7185
6939
|
*
|
|
7186
|
-
* @category
|
|
6940
|
+
* @category search params
|
|
7187
6941
|
* @since 4.0.0
|
|
7188
6942
|
*/
|
|
7189
6943
|
export interface fromURLSearchParams<S extends Top> extends decodeTo<S, URLSearchParams> {
|
|
@@ -7271,8 +7025,7 @@ export interface fromURLSearchParams<S extends Top> extends decodeTo<S, URLSearc
|
|
|
7271
7025
|
*/
|
|
7272
7026
|
export declare function fromURLSearchParams<S extends Top>(schema: S): fromURLSearchParams<S>;
|
|
7273
7027
|
/**
|
|
7274
|
-
* Type-level representation of
|
|
7275
|
-
* `Infinity`, and `-Infinity`.
|
|
7028
|
+
* Type-level representation of {@link Finite}.
|
|
7276
7029
|
*
|
|
7277
7030
|
* @category Number
|
|
7278
7031
|
* @since 3.10.0
|
|
@@ -7288,8 +7041,7 @@ export interface Finite extends Number {
|
|
|
7288
7041
|
*/
|
|
7289
7042
|
export declare const Finite: Finite;
|
|
7290
7043
|
/**
|
|
7291
|
-
* Type-level representation of
|
|
7292
|
-
* integer numbers.
|
|
7044
|
+
* Type-level representation of {@link Int}.
|
|
7293
7045
|
*
|
|
7294
7046
|
* @category Number
|
|
7295
7047
|
* @since 3.10.0
|
|
@@ -7305,8 +7057,7 @@ export interface Int extends Number {
|
|
|
7305
7057
|
*/
|
|
7306
7058
|
export declare const Int: Int;
|
|
7307
7059
|
/**
|
|
7308
|
-
* Type-level representation of
|
|
7309
|
-
* numbers using JavaScript number coercion.
|
|
7060
|
+
* Type-level representation of {@link NumberFromString}.
|
|
7310
7061
|
*
|
|
7311
7062
|
* @category Number
|
|
7312
7063
|
* @since 3.10.0
|
|
@@ -7333,8 +7084,7 @@ export interface NumberFromString extends decodeTo<Finite, String> {
|
|
|
7333
7084
|
*/
|
|
7334
7085
|
export declare const NumberFromString: NumberFromString;
|
|
7335
7086
|
/**
|
|
7336
|
-
* Type-level representation of
|
|
7337
|
-
* finite numbers.
|
|
7087
|
+
* Type-level representation of {@link FiniteFromString}.
|
|
7338
7088
|
*
|
|
7339
7089
|
* @category Number
|
|
7340
7090
|
* @since 4.0.0
|
|
@@ -7359,8 +7109,7 @@ export interface FiniteFromString extends decodeTo<Finite, String> {
|
|
|
7359
7109
|
*/
|
|
7360
7110
|
export declare const FiniteFromString: FiniteFromString;
|
|
7361
7111
|
/**
|
|
7362
|
-
* Type-level representation of
|
|
7363
|
-
* `bigint` values.
|
|
7112
|
+
* Type-level representation of {@link BigIntFromString}.
|
|
7364
7113
|
*
|
|
7365
7114
|
* @category BigInt
|
|
7366
7115
|
* @since 4.0.0
|
|
@@ -7398,10 +7147,9 @@ export interface BigIntFromString extends decodeTo<BigInt, String> {
|
|
|
7398
7147
|
*/
|
|
7399
7148
|
export declare const BigIntFromString: BigIntFromString;
|
|
7400
7149
|
/**
|
|
7401
|
-
*
|
|
7402
|
-
* trailing whitespace.
|
|
7150
|
+
* Type-level representation of {@link Trimmed}.
|
|
7403
7151
|
*
|
|
7404
|
-
* @category
|
|
7152
|
+
* @category string
|
|
7405
7153
|
* @since 3.10.0
|
|
7406
7154
|
*/
|
|
7407
7155
|
export interface Trimmed extends String {
|
|
@@ -7410,15 +7158,14 @@ export interface Trimmed extends String {
|
|
|
7410
7158
|
/**
|
|
7411
7159
|
* Schema for strings that contains no leading or trailing whitespaces.
|
|
7412
7160
|
*
|
|
7413
|
-
* @category
|
|
7161
|
+
* @category string
|
|
7414
7162
|
* @since 3.10.0
|
|
7415
7163
|
*/
|
|
7416
7164
|
export declare const Trimmed: Trimmed;
|
|
7417
7165
|
/**
|
|
7418
|
-
*
|
|
7419
|
-
* whitespace while decoding and encodes the trimmed string unchanged.
|
|
7166
|
+
* Type-level representation of {@link Trim}.
|
|
7420
7167
|
*
|
|
7421
|
-
* @category
|
|
7168
|
+
* @category string
|
|
7422
7169
|
* @since 3.10.0
|
|
7423
7170
|
*/
|
|
7424
7171
|
export interface Trim extends decodeTo<Trimmed, String> {
|
|
@@ -7435,15 +7182,14 @@ export interface Trim extends decodeTo<Trimmed, String> {
|
|
|
7435
7182
|
* Encoding:
|
|
7436
7183
|
* - The trimmed string is encoded as is.
|
|
7437
7184
|
*
|
|
7438
|
-
* @category
|
|
7185
|
+
* @category string
|
|
7439
7186
|
* @since 3.10.0
|
|
7440
7187
|
*/
|
|
7441
7188
|
export declare const Trim: Trim;
|
|
7442
7189
|
/**
|
|
7443
|
-
*
|
|
7444
|
-
* base64-encoded strings and UTF-8 strings.
|
|
7190
|
+
* Type-level representation of {@link StringFromBase64}.
|
|
7445
7191
|
*
|
|
7446
|
-
* @category
|
|
7192
|
+
* @category string
|
|
7447
7193
|
* @since 3.10.0
|
|
7448
7194
|
*/
|
|
7449
7195
|
export interface StringFromBase64 extends decodeTo<String, String> {
|
|
@@ -7460,15 +7206,14 @@ export interface StringFromBase64 extends decodeTo<String, String> {
|
|
|
7460
7206
|
* Encoding:
|
|
7461
7207
|
* - A `string` is encoded as a base64-encoded string.
|
|
7462
7208
|
*
|
|
7463
|
-
* @category
|
|
7209
|
+
* @category string
|
|
7464
7210
|
* @since 3.10.0
|
|
7465
7211
|
*/
|
|
7466
7212
|
export declare const StringFromBase64: StringFromBase64;
|
|
7467
7213
|
/**
|
|
7468
|
-
*
|
|
7469
|
-
* base64-encoded strings and UTF-8 strings.
|
|
7214
|
+
* Type-level representation of {@link StringFromBase64Url}.
|
|
7470
7215
|
*
|
|
7471
|
-
* @category
|
|
7216
|
+
* @category string
|
|
7472
7217
|
* @since 3.10.0
|
|
7473
7218
|
*/
|
|
7474
7219
|
export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
@@ -7485,15 +7230,14 @@ export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
|
7485
7230
|
* Encoding:
|
|
7486
7231
|
* - A `string` is encoded as a base64 (URL) encoded string.
|
|
7487
7232
|
*
|
|
7488
|
-
* @category
|
|
7233
|
+
* @category string
|
|
7489
7234
|
* @since 3.10.0
|
|
7490
7235
|
*/
|
|
7491
7236
|
export declare const StringFromBase64Url: StringFromBase64Url;
|
|
7492
7237
|
/**
|
|
7493
|
-
*
|
|
7494
|
-
* strings and UTF-8 strings.
|
|
7238
|
+
* Type-level representation of {@link StringFromHex}.
|
|
7495
7239
|
*
|
|
7496
|
-
* @category
|
|
7240
|
+
* @category string
|
|
7497
7241
|
* @since 3.10.0
|
|
7498
7242
|
*/
|
|
7499
7243
|
export interface StringFromHex extends decodeTo<String, String> {
|
|
@@ -7510,15 +7254,14 @@ export interface StringFromHex extends decodeTo<String, String> {
|
|
|
7510
7254
|
* Encoding:
|
|
7511
7255
|
* - A `string` is encoded as a hex string.
|
|
7512
7256
|
*
|
|
7513
|
-
* @category
|
|
7257
|
+
* @category string
|
|
7514
7258
|
* @since 3.10.0
|
|
7515
7259
|
*/
|
|
7516
7260
|
export declare const StringFromHex: StringFromHex;
|
|
7517
7261
|
/**
|
|
7518
|
-
*
|
|
7519
|
-
* URI-component encoded strings and UTF-8 strings.
|
|
7262
|
+
* Type-level representation of {@link StringFromUriComponent}.
|
|
7520
7263
|
*
|
|
7521
|
-
* @category
|
|
7264
|
+
* @category string
|
|
7522
7265
|
* @since 3.12.0
|
|
7523
7266
|
*/
|
|
7524
7267
|
export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
@@ -7554,7 +7297,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
7554
7297
|
* // %7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D
|
|
7555
7298
|
* ```
|
|
7556
7299
|
*
|
|
7557
|
-
* @category
|
|
7300
|
+
* @category string
|
|
7558
7301
|
* @since 3.12.0
|
|
7559
7302
|
*/
|
|
7560
7303
|
export declare const StringFromUriComponent: StringFromUriComponent;
|
|
@@ -7574,7 +7317,7 @@ export declare const PropertyKey: Union<readonly [Finite, Symbol, String]>;
|
|
|
7574
7317
|
* The result contains an `issues` array where each issue has a message and an
|
|
7575
7318
|
* optional path made of property keys or keyed path segments.
|
|
7576
7319
|
*
|
|
7577
|
-
* @category
|
|
7320
|
+
* @category Standard Schema
|
|
7578
7321
|
* @since 4.0.0
|
|
7579
7322
|
*/
|
|
7580
7323
|
export declare const StandardSchemaV1FailureResult: Struct<{
|
|
@@ -7586,10 +7329,9 @@ export declare const StandardSchemaV1FailureResult: Struct<{
|
|
|
7586
7329
|
}>>;
|
|
7587
7330
|
}>;
|
|
7588
7331
|
/**
|
|
7589
|
-
*
|
|
7590
|
-
* `0 | 1` and boolean values.
|
|
7332
|
+
* Type-level representation of {@link BooleanFromBit}.
|
|
7591
7333
|
*
|
|
7592
|
-
* @category
|
|
7334
|
+
* @category boolean
|
|
7593
7335
|
* @since 4.0.0
|
|
7594
7336
|
*/
|
|
7595
7337
|
export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0, 1]>> {
|
|
@@ -7611,13 +7353,12 @@ export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0,
|
|
|
7611
7353
|
* @see {@link Boolean} for validating values that are already booleans
|
|
7612
7354
|
* @see {@link Literals} for keeping bit literals instead of decoding them
|
|
7613
7355
|
*
|
|
7614
|
-
* @category
|
|
7356
|
+
* @category boolean
|
|
7615
7357
|
* @since 4.0.0
|
|
7616
7358
|
*/
|
|
7617
7359
|
export declare const BooleanFromBit: BooleanFromBit;
|
|
7618
7360
|
/**
|
|
7619
|
-
*
|
|
7620
|
-
* instances with base64 JSON encoding.
|
|
7361
|
+
* Type-level representation of {@link Uint8Array}.
|
|
7621
7362
|
*
|
|
7622
7363
|
* @category Uint8Array
|
|
7623
7364
|
* @since 4.0.0
|
|
@@ -7639,8 +7380,7 @@ export interface Uint8Array extends instanceOf<globalThis.Uint8Array<ArrayBuffer
|
|
|
7639
7380
|
*/
|
|
7640
7381
|
export declare const Uint8Array: Uint8Array;
|
|
7641
7382
|
/**
|
|
7642
|
-
*
|
|
7643
|
-
* base64-encoded strings and `Uint8Array` values.
|
|
7383
|
+
* Type-level representation of {@link Uint8ArrayFromBase64}.
|
|
7644
7384
|
*
|
|
7645
7385
|
* @category Uint8Array
|
|
7646
7386
|
* @since 3.10.0
|
|
@@ -7665,8 +7405,7 @@ export interface Uint8ArrayFromBase64 extends decodeTo<Uint8Array, String> {
|
|
|
7665
7405
|
*/
|
|
7666
7406
|
export declare const Uint8ArrayFromBase64: Uint8ArrayFromBase64;
|
|
7667
7407
|
/**
|
|
7668
|
-
*
|
|
7669
|
-
* URL-safe base64-encoded strings and `Uint8Array` values.
|
|
7408
|
+
* Type-level representation of {@link Uint8ArrayFromBase64Url}.
|
|
7670
7409
|
*
|
|
7671
7410
|
* @category Uint8Array
|
|
7672
7411
|
* @since 3.10.0
|
|
@@ -7691,8 +7430,7 @@ export interface Uint8ArrayFromBase64Url extends decodeTo<Uint8Array, String> {
|
|
|
7691
7430
|
*/
|
|
7692
7431
|
export declare const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url;
|
|
7693
7432
|
/**
|
|
7694
|
-
*
|
|
7695
|
-
* hex-encoded strings and `Uint8Array` values.
|
|
7433
|
+
* Type-level representation of {@link Uint8ArrayFromHex}.
|
|
7696
7434
|
*
|
|
7697
7435
|
* @category Uint8Array
|
|
7698
7436
|
* @since 3.10.0
|
|
@@ -7717,8 +7455,7 @@ export interface Uint8ArrayFromHex extends decodeTo<Uint8Array, String> {
|
|
|
7717
7455
|
*/
|
|
7718
7456
|
export declare const Uint8ArrayFromHex: Uint8ArrayFromHex;
|
|
7719
7457
|
/**
|
|
7720
|
-
*
|
|
7721
|
-
* UTC ISO string JSON encoding.
|
|
7458
|
+
* Type-level representation of {@link DateTimeUtc}.
|
|
7722
7459
|
*
|
|
7723
7460
|
* @category DateTime
|
|
7724
7461
|
* @since 3.10.0
|
|
@@ -7749,8 +7486,7 @@ export interface DateTimeUtc extends declare<DateTime.Utc> {
|
|
|
7749
7486
|
*/
|
|
7750
7487
|
export declare const DateTimeUtc: DateTimeUtc;
|
|
7751
7488
|
/**
|
|
7752
|
-
*
|
|
7753
|
-
* JavaScript `Date` values to `DateTime.Utc`.
|
|
7489
|
+
* Type-level representation of {@link DateTimeUtcFromDate}.
|
|
7754
7490
|
*
|
|
7755
7491
|
* @category DateTime
|
|
7756
7492
|
* @since 3.12.0
|
|
@@ -7784,8 +7520,7 @@ export interface DateTimeUtcFromDate extends decodeTo<DateTimeUtc, Date> {
|
|
|
7784
7520
|
*/
|
|
7785
7521
|
export declare const DateTimeUtcFromDate: DateTimeUtcFromDate;
|
|
7786
7522
|
/**
|
|
7787
|
-
*
|
|
7788
|
-
* strings to `DateTime.Utc`.
|
|
7523
|
+
* Type-level representation of {@link DateTimeUtcFromString}.
|
|
7789
7524
|
*
|
|
7790
7525
|
* @category DateTime
|
|
7791
7526
|
* @since 4.0.0
|
|
@@ -7812,8 +7547,7 @@ export interface DateTimeUtcFromString extends decodeTo<DateTimeUtc, String> {
|
|
|
7812
7547
|
*/
|
|
7813
7548
|
export declare const DateTimeUtcFromString: DateTimeUtcFromString;
|
|
7814
7549
|
/**
|
|
7815
|
-
*
|
|
7816
|
-
* milliseconds and `DateTime.Utc` values.
|
|
7550
|
+
* Type-level representation of {@link DateTimeUtcFromMillis}.
|
|
7817
7551
|
*
|
|
7818
7552
|
* @category DateTime
|
|
7819
7553
|
* @since 4.0.0
|
|
@@ -7837,8 +7571,7 @@ export interface DateTimeUtcFromMillis extends decodeTo<instanceOf<DateTime.Utc>
|
|
|
7837
7571
|
*/
|
|
7838
7572
|
export declare const DateTimeUtcFromMillis: DateTimeUtcFromMillis;
|
|
7839
7573
|
/**
|
|
7840
|
-
*
|
|
7841
|
-
* `DateTime.TimeZone.Offset` values encoded as offset milliseconds.
|
|
7574
|
+
* Type-level representation of {@link TimeZoneOffset}.
|
|
7842
7575
|
*
|
|
7843
7576
|
* @category DateTime
|
|
7844
7577
|
* @since 3.10.0
|
|
@@ -7860,8 +7593,7 @@ export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
|
|
|
7860
7593
|
*/
|
|
7861
7594
|
export declare const TimeZoneOffset: TimeZoneOffset;
|
|
7862
7595
|
/**
|
|
7863
|
-
*
|
|
7864
|
-
* `DateTime.TimeZone.Named` values encoded as IANA time zone identifiers.
|
|
7596
|
+
* Type-level representation of {@link TimeZoneNamed}.
|
|
7865
7597
|
*
|
|
7866
7598
|
* @category DateTime
|
|
7867
7599
|
* @since 3.10.0
|
|
@@ -7883,8 +7615,7 @@ export interface TimeZoneNamed extends declare<DateTime.TimeZone.Named> {
|
|
|
7883
7615
|
*/
|
|
7884
7616
|
export declare const TimeZoneNamed: TimeZoneNamed;
|
|
7885
7617
|
/**
|
|
7886
|
-
*
|
|
7887
|
-
* time zone identifier strings and `DateTime.TimeZone.Named` values.
|
|
7618
|
+
* Type-level representation of {@link TimeZoneNamedFromString}.
|
|
7888
7619
|
*
|
|
7889
7620
|
* @category DateTime
|
|
7890
7621
|
* @since 4.0.0
|
|
@@ -7908,8 +7639,7 @@ export interface TimeZoneNamedFromString extends decodeTo<TimeZoneNamed, String>
|
|
|
7908
7639
|
*/
|
|
7909
7640
|
export declare const TimeZoneNamedFromString: TimeZoneNamedFromString;
|
|
7910
7641
|
/**
|
|
7911
|
-
*
|
|
7912
|
-
* encoded as either IANA identifiers or numeric offset strings.
|
|
7642
|
+
* Type-level representation of {@link TimeZone}.
|
|
7913
7643
|
*
|
|
7914
7644
|
* @category DateTime
|
|
7915
7645
|
* @since 3.10.0
|
|
@@ -7932,8 +7662,7 @@ export interface TimeZone extends declare<DateTime.TimeZone> {
|
|
|
7932
7662
|
*/
|
|
7933
7663
|
export declare const TimeZone: TimeZone;
|
|
7934
7664
|
/**
|
|
7935
|
-
*
|
|
7936
|
-
* identifier or offset strings to `DateTime.TimeZone` values.
|
|
7665
|
+
* Type-level representation of {@link TimeZoneFromString}.
|
|
7937
7666
|
*
|
|
7938
7667
|
* @category DateTime
|
|
7939
7668
|
* @since 4.0.0
|
|
@@ -7957,8 +7686,7 @@ export interface TimeZoneFromString extends decodeTo<TimeZone, String> {
|
|
|
7957
7686
|
*/
|
|
7958
7687
|
export declare const TimeZoneFromString: TimeZoneFromString;
|
|
7959
7688
|
/**
|
|
7960
|
-
*
|
|
7961
|
-
* with ISO offset or named-zone string JSON encoding.
|
|
7689
|
+
* Type-level representation of {@link DateTimeZoned}.
|
|
7962
7690
|
*
|
|
7963
7691
|
* @category DateTime
|
|
7964
7692
|
* @since 3.10.0
|
|
@@ -7983,8 +7711,7 @@ export interface DateTimeZoned extends declare<DateTime.Zoned> {
|
|
|
7983
7711
|
*/
|
|
7984
7712
|
export declare const DateTimeZoned: DateTimeZoned;
|
|
7985
7713
|
/**
|
|
7986
|
-
*
|
|
7987
|
-
* zoned date-time strings and `DateTime.Zoned` values.
|
|
7714
|
+
* Type-level representation of {@link DateTimeZonedFromString}.
|
|
7988
7715
|
*
|
|
7989
7716
|
* @category DateTime
|
|
7990
7717
|
* @since 4.0.0
|
|
@@ -8008,15 +7735,7 @@ export interface DateTimeZonedFromString extends decodeTo<DateTimeZoned, String>
|
|
|
8008
7735
|
*/
|
|
8009
7736
|
export declare const DateTimeZonedFromString: DateTimeZonedFromString;
|
|
8010
7737
|
/**
|
|
8011
|
-
*
|
|
8012
|
-
*
|
|
8013
|
-
* **Details**
|
|
8014
|
-
*
|
|
8015
|
-
* A `Class` is a TypeScript class whose constructor validates its input
|
|
8016
|
-
* against a {@link Struct} schema. Instances are always structurally valid.
|
|
8017
|
-
*
|
|
8018
|
-
* The interface exposes the schema's `fields`, an `identifier` string, and
|
|
8019
|
-
* helpers such as `mapFields`, `annotate`, `check`, and `extend`.
|
|
7738
|
+
* Type-level representation returned by {@link Class}.
|
|
8020
7739
|
*
|
|
8021
7740
|
* @category models
|
|
8022
7741
|
* @since 3.10.0
|
|
@@ -8720,7 +8439,7 @@ export declare function toFormatter<T>(schema: Schema<T>, options?: {
|
|
|
8720
8439
|
* Use when the default structural equivalence derived by {@link toEquivalence}
|
|
8721
8440
|
* is not appropriate for a type.
|
|
8722
8441
|
*
|
|
8723
|
-
* @category
|
|
8442
|
+
* @category instances
|
|
8724
8443
|
* @since 4.0.0
|
|
8725
8444
|
*/
|
|
8726
8445
|
export declare function overrideToEquivalence<S extends Top>(toEquivalence: () => Equivalence.Equivalence<S["Type"]>): (self: S) => S["Rebuild"];
|
|
@@ -8740,7 +8459,7 @@ export declare function overrideToEquivalence<S extends Top>(toEquivalence: () =
|
|
|
8740
8459
|
* console.log(eq({ id: 1, name: "Alice" }, { id: 2, name: "Alice" })) // false
|
|
8741
8460
|
* ```
|
|
8742
8461
|
*
|
|
8743
|
-
* @category
|
|
8462
|
+
* @category instances
|
|
8744
8463
|
* @since 4.0.0
|
|
8745
8464
|
*/
|
|
8746
8465
|
export declare function toEquivalence<T>(schema: Schema<T>): Equivalence.Equivalence<T>;
|
|
@@ -8756,7 +8475,7 @@ export declare function toRepresentation(schema: Top): SchemaRepresentation.Docu
|
|
|
8756
8475
|
/**
|
|
8757
8476
|
* Options for {@link toJsonSchemaDocument}.
|
|
8758
8477
|
*
|
|
8759
|
-
* @category
|
|
8478
|
+
* @category options
|
|
8760
8479
|
* @since 4.0.0
|
|
8761
8480
|
*/
|
|
8762
8481
|
export interface ToJsonSchemaOptions {
|
|
@@ -8835,7 +8554,7 @@ export interface ToJsonSchemaOptions {
|
|
|
8835
8554
|
* properties and synthesized check descriptions; it does not change the draft
|
|
8836
8555
|
* target.
|
|
8837
8556
|
*
|
|
8838
|
-
* @category
|
|
8557
|
+
* @category converting
|
|
8839
8558
|
* @since 4.0.0
|
|
8840
8559
|
*/
|
|
8841
8560
|
export declare function toJsonSchemaDocument(schema: Top, options?: ToJsonSchemaOptions): JsonSchema.Document<"draft-2020-12">;
|
|
@@ -8935,8 +8654,7 @@ export declare function toIsoSource<S extends Top>(_: S): Optic_.Iso<S["Type"],
|
|
|
8935
8654
|
*/
|
|
8936
8655
|
export declare function toIsoFocus<S extends Top>(_: S): Optic_.Iso<S["Iso"], S["Iso"]>;
|
|
8937
8656
|
/**
|
|
8938
|
-
*
|
|
8939
|
-
* `Iso` type parameter and exposes the original `schema`.
|
|
8657
|
+
* Type-level representation returned by {@link overrideToCodecIso}.
|
|
8940
8658
|
*
|
|
8941
8659
|
* @category Optic
|
|
8942
8660
|
* @since 4.0.0
|
|
@@ -8970,7 +8688,7 @@ export declare function overrideToCodecIso<S extends Top, Iso>(to: Codec<Iso>, t
|
|
|
8970
8688
|
* {@link toCodecJson}), computes RFC 6902 JSON Patch operations between old
|
|
8971
8689
|
* and new values, and can apply patches back to the typed value.
|
|
8972
8690
|
*
|
|
8973
|
-
* @category
|
|
8691
|
+
* @category converting
|
|
8974
8692
|
* @since 4.0.0
|
|
8975
8693
|
*/
|
|
8976
8694
|
export declare function toDifferJsonPatch<T, E>(schema: Codec<T, E>): Differ<T, JsonPatch.JsonPatch>;
|
|
@@ -9007,14 +8725,14 @@ export declare function Tree<S extends Top>(node: S): Union<readonly [S, $Array<
|
|
|
9007
8725
|
* readonly record of `string → Json`. For the corresponding schema, see the
|
|
9008
8726
|
* {@link Json} const.
|
|
9009
8727
|
*
|
|
9010
|
-
* @category
|
|
8728
|
+
* @category models
|
|
9011
8729
|
* @since 4.0.0
|
|
9012
8730
|
*/
|
|
9013
8731
|
export type Json = null | number | boolean | string | JsonArray | JsonObject;
|
|
9014
8732
|
/**
|
|
9015
8733
|
* A readonly array of {@link Json} values.
|
|
9016
8734
|
*
|
|
9017
|
-
* @category
|
|
8735
|
+
* @category models
|
|
9018
8736
|
* @since 4.0.0
|
|
9019
8737
|
*/
|
|
9020
8738
|
export interface JsonArray extends ReadonlyArray<Json> {
|
|
@@ -9022,7 +8740,7 @@ export interface JsonArray extends ReadonlyArray<Json> {
|
|
|
9022
8740
|
/**
|
|
9023
8741
|
* A readonly record whose values are {@link Json} values.
|
|
9024
8742
|
*
|
|
9025
|
-
* @category
|
|
8743
|
+
* @category models
|
|
9026
8744
|
* @since 4.0.0
|
|
9027
8745
|
*/
|
|
9028
8746
|
export interface JsonObject {
|
|
@@ -9040,7 +8758,7 @@ export interface JsonObject {
|
|
|
9040
8758
|
* console.log(result._tag) // "Some"
|
|
9041
8759
|
* ```
|
|
9042
8760
|
*
|
|
9043
|
-
* @category
|
|
8761
|
+
* @category schemas
|
|
9044
8762
|
* @since 4.0.0
|
|
9045
8763
|
*/
|
|
9046
8764
|
export declare const Json: Codec<Json>;
|
|
@@ -9048,14 +8766,14 @@ export declare const Json: Codec<Json>;
|
|
|
9048
8766
|
* Recursive TypeScript type for mutable JSON values: `null`, `number`,
|
|
9049
8767
|
* `boolean`, `string`, mutable arrays, or mutable string-keyed records.
|
|
9050
8768
|
*
|
|
9051
|
-
* @category
|
|
8769
|
+
* @category models
|
|
9052
8770
|
* @since 4.0.0
|
|
9053
8771
|
*/
|
|
9054
8772
|
export type MutableJson = null | number | boolean | string | MutableJsonArray | MutableJsonObject;
|
|
9055
8773
|
/**
|
|
9056
8774
|
* A mutable array of {@link MutableJson} values.
|
|
9057
8775
|
*
|
|
9058
|
-
* @category
|
|
8776
|
+
* @category models
|
|
9059
8777
|
* @since 4.0.0
|
|
9060
8778
|
*/
|
|
9061
8779
|
export interface MutableJsonArray extends Array<MutableJson> {
|
|
@@ -9063,7 +8781,7 @@ export interface MutableJsonArray extends Array<MutableJson> {
|
|
|
9063
8781
|
/**
|
|
9064
8782
|
* A mutable record whose values are {@link MutableJson} values.
|
|
9065
8783
|
*
|
|
9066
|
-
* @category
|
|
8784
|
+
* @category models
|
|
9067
8785
|
* @since 4.0.0
|
|
9068
8786
|
*/
|
|
9069
8787
|
export interface MutableJsonObject {
|
|
@@ -9073,7 +8791,7 @@ export interface MutableJsonObject {
|
|
|
9073
8791
|
* Schema that accepts any mutable JSON-compatible value. See {@link Json} for
|
|
9074
8792
|
* the immutable variant.
|
|
9075
8793
|
*
|
|
9076
|
-
* @category
|
|
8794
|
+
* @category schemas
|
|
9077
8795
|
* @since 4.0.0
|
|
9078
8796
|
*/
|
|
9079
8797
|
export declare const MutableJson: Codec<MutableJson>;
|