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/src/Schema.ts
CHANGED
|
@@ -182,7 +182,7 @@ export type ConstructorDefault = "no-default" | "with-default"
|
|
|
182
182
|
* @see {@link Bottom.makeEffect}
|
|
183
183
|
* @see {@link Bottom.make}
|
|
184
184
|
*
|
|
185
|
-
* @category
|
|
185
|
+
* @category options
|
|
186
186
|
* @since 3.13.4
|
|
187
187
|
*/
|
|
188
188
|
export interface MakeOptions {
|
|
@@ -313,9 +313,7 @@ export interface Bottom<
|
|
|
313
313
|
}
|
|
314
314
|
|
|
315
315
|
/**
|
|
316
|
-
*
|
|
317
|
-
* type `T`, the encoded type `E`, and the list of type-parameter schemas
|
|
318
|
-
* `TypeParameters`.
|
|
316
|
+
* Type-level representation returned by {@link declareConstructor}.
|
|
319
317
|
*
|
|
320
318
|
* @category constructors
|
|
321
319
|
* @since 4.0.0
|
|
@@ -404,8 +402,7 @@ export function declareConstructor<T, E = T, Iso = T>() {
|
|
|
404
402
|
}
|
|
405
403
|
|
|
406
404
|
/**
|
|
407
|
-
*
|
|
408
|
-
* opaque type `T` with no type parameters.
|
|
405
|
+
* Type-level representation returned by {@link declare}.
|
|
409
406
|
*
|
|
410
407
|
* @category constructors
|
|
411
408
|
* @since 3.13.3
|
|
@@ -485,7 +482,7 @@ export function declare<T, Iso = T>(
|
|
|
485
482
|
* type E = typeof bottom["Encoded"] // string
|
|
486
483
|
* ```
|
|
487
484
|
*
|
|
488
|
-
* @category
|
|
485
|
+
* @category utility types
|
|
489
486
|
* @since 4.0.0
|
|
490
487
|
*/
|
|
491
488
|
export function revealBottom<S extends Top>(
|
|
@@ -910,7 +907,7 @@ export interface Encoder<out E, out RE = never> extends Codec<unknown, E, unknow
|
|
|
910
907
|
* type Enc = typeof codec["Encoded"] // string
|
|
911
908
|
* ```
|
|
912
909
|
*
|
|
913
|
-
* @category
|
|
910
|
+
* @category utility types
|
|
914
911
|
* @since 4.0.0
|
|
915
912
|
*/
|
|
916
913
|
export function revealCodec<T, E, RD, RE>(codec: Codec<T, E, RD, RE>) {
|
|
@@ -1839,9 +1836,7 @@ export function isSchema(u: unknown): u is Top {
|
|
|
1839
1836
|
}
|
|
1840
1837
|
|
|
1841
1838
|
/**
|
|
1842
|
-
*
|
|
1843
|
-
* when present must match the wrapped schema (no implicit `undefined`).
|
|
1844
|
-
* Produced by {@link optionalKey}.
|
|
1839
|
+
* Type-level representation returned by {@link optionalKey}.
|
|
1845
1840
|
*
|
|
1846
1841
|
* @category models
|
|
1847
1842
|
* @since 4.0.0
|
|
@@ -1917,8 +1912,7 @@ interface requiredKeyLambda extends Lambda {
|
|
|
1917
1912
|
export const requiredKey = Struct_.lambda<requiredKeyLambda>((self) => self.schema)
|
|
1918
1913
|
|
|
1919
1914
|
/**
|
|
1920
|
-
*
|
|
1921
|
-
* Equivalent to `optionalKey<UndefinedOr<S>>`. Produced by {@link optional}.
|
|
1915
|
+
* Type-level representation returned by {@link optional}.
|
|
1922
1916
|
*
|
|
1923
1917
|
* @category models
|
|
1924
1918
|
* @since 3.10.0
|
|
@@ -1987,8 +1981,7 @@ interface requiredLambda extends Lambda {
|
|
|
1987
1981
|
export const required = Struct_.lambda<requiredLambda>((self) => self.schema.members[0])
|
|
1988
1982
|
|
|
1989
1983
|
/**
|
|
1990
|
-
*
|
|
1991
|
-
* Produced by {@link mutableKey}.
|
|
1984
|
+
* Type-level representation returned by {@link mutableKey}.
|
|
1992
1985
|
*
|
|
1993
1986
|
* @category models
|
|
1994
1987
|
* @since 4.0.0
|
|
@@ -2049,8 +2042,7 @@ interface readonlyKeyLambda extends Lambda {
|
|
|
2049
2042
|
export const readonlyKey = Struct_.lambda<readonlyKeyLambda>((self) => self.schema)
|
|
2050
2043
|
|
|
2051
2044
|
/**
|
|
2052
|
-
*
|
|
2053
|
-
* both sides (Type = Encoded = S["Type"]). Produced by {@link toType}.
|
|
2045
|
+
* Type-level representation returned by {@link toType}.
|
|
2054
2046
|
*
|
|
2055
2047
|
* @category transforming
|
|
2056
2048
|
* @since 4.0.0
|
|
@@ -2090,8 +2082,7 @@ interface toTypeLambda extends Lambda {
|
|
|
2090
2082
|
export const toType = Struct_.lambda<toTypeLambda>((schema) => make(AST.toType(schema.ast), { schema }))
|
|
2091
2083
|
|
|
2092
2084
|
/**
|
|
2093
|
-
*
|
|
2094
|
-
* both sides (Type = Encoded = S["Encoded"]). Produced by {@link toEncoded}.
|
|
2085
|
+
* Type-level representation returned by {@link toEncoded}.
|
|
2095
2086
|
*
|
|
2096
2087
|
* @category transforming
|
|
2097
2088
|
* @since 4.0.0
|
|
@@ -2133,8 +2124,7 @@ export const toEncoded = Struct_.lambda<toEncodedLambda>((schema) => make(AST.to
|
|
|
2133
2124
|
const FlipTypeId = "~effect/Schema/flip"
|
|
2134
2125
|
|
|
2135
2126
|
/**
|
|
2136
|
-
*
|
|
2137
|
-
* swapped. Produced by {@link flip}.
|
|
2127
|
+
* Type-level representation returned by {@link flip}.
|
|
2138
2128
|
*
|
|
2139
2129
|
* @category transforming
|
|
2140
2130
|
* @since 4.0.0
|
|
@@ -2199,9 +2189,8 @@ export function flip<S extends Top>(schema: S): flip<S> {
|
|
|
2199
2189
|
}
|
|
2200
2190
|
|
|
2201
2191
|
/**
|
|
2202
|
-
*
|
|
2192
|
+
* Type-level representation returned by {@link Literal}.
|
|
2203
2193
|
*
|
|
2204
|
-
* @see {@link Literal} for the constructor function.
|
|
2205
2194
|
* @category models
|
|
2206
2195
|
* @since 3.10.0
|
|
2207
2196
|
*/
|
|
@@ -2306,10 +2295,8 @@ export declare namespace TemplateLiteral {
|
|
|
2306
2295
|
}
|
|
2307
2296
|
|
|
2308
2297
|
/**
|
|
2309
|
-
*
|
|
2310
|
-
* The encoded type is a string formed by concatenating the parts.
|
|
2298
|
+
* Type-level representation returned by {@link TemplateLiteral}.
|
|
2311
2299
|
*
|
|
2312
|
-
* @see {@link TemplateLiteral} for the constructor function.
|
|
2313
2300
|
* @category models
|
|
2314
2301
|
* @since 3.10.0
|
|
2315
2302
|
*/
|
|
@@ -2378,10 +2365,8 @@ export declare namespace TemplateLiteralParser {
|
|
|
2378
2365
|
}
|
|
2379
2366
|
|
|
2380
2367
|
/**
|
|
2381
|
-
*
|
|
2382
|
-
* them into a tuple of typed values, one per schema part.
|
|
2368
|
+
* Type-level representation returned by {@link TemplateLiteralParser}.
|
|
2383
2369
|
*
|
|
2384
|
-
* @see {@link TemplateLiteralParser} for the constructor function.
|
|
2385
2370
|
* @category models
|
|
2386
2371
|
* @since 3.10.0
|
|
2387
2372
|
*/
|
|
@@ -2431,10 +2416,8 @@ export function TemplateLiteralParser<const Parts extends TemplateLiteral.Parts>
|
|
|
2431
2416
|
}
|
|
2432
2417
|
|
|
2433
2418
|
/**
|
|
2434
|
-
*
|
|
2435
|
-
* `as const` object, accepting any of its values.
|
|
2419
|
+
* Type-level representation returned by {@link Enum}.
|
|
2436
2420
|
*
|
|
2437
|
-
* @see {@link Enum} for the constructor function.
|
|
2438
2421
|
* @category models
|
|
2439
2422
|
* @since 4.0.0
|
|
2440
2423
|
*/
|
|
@@ -2476,9 +2459,8 @@ export function Enum<A extends { [x: string]: string | number }>(enums: A): Enum
|
|
|
2476
2459
|
}
|
|
2477
2460
|
|
|
2478
2461
|
/**
|
|
2479
|
-
*
|
|
2462
|
+
* Type-level representation of {@link Never}.
|
|
2480
2463
|
*
|
|
2481
|
-
* @see {@link Never} for the schema value.
|
|
2482
2464
|
* @category models
|
|
2483
2465
|
* @since 3.10.0
|
|
2484
2466
|
*/
|
|
@@ -2493,9 +2475,8 @@ export interface Never extends Bottom<never, never, never, never, AST.Never, Nev
|
|
|
2493
2475
|
export const Never: Never = make(AST.never)
|
|
2494
2476
|
|
|
2495
2477
|
/**
|
|
2496
|
-
*
|
|
2478
|
+
* Type-level representation of {@link Any}.
|
|
2497
2479
|
*
|
|
2498
|
-
* @see {@link Any} for the schema value.
|
|
2499
2480
|
* @category models
|
|
2500
2481
|
* @since 3.10.0
|
|
2501
2482
|
*/
|
|
@@ -2511,9 +2492,8 @@ export interface Any extends Bottom<any, any, never, never, AST.Any, Any> {}
|
|
|
2511
2492
|
export const Any: Any = make(AST.any)
|
|
2512
2493
|
|
|
2513
2494
|
/**
|
|
2514
|
-
*
|
|
2495
|
+
* Type-level representation of {@link Unknown}.
|
|
2515
2496
|
*
|
|
2516
|
-
* @see {@link Unknown} for the schema value.
|
|
2517
2497
|
* @category models
|
|
2518
2498
|
* @since 3.10.0
|
|
2519
2499
|
*/
|
|
@@ -2529,9 +2509,8 @@ export interface Unknown extends Bottom<unknown, unknown, never, never, AST.Unkn
|
|
|
2529
2509
|
export const Unknown: Unknown = make(AST.unknown)
|
|
2530
2510
|
|
|
2531
2511
|
/**
|
|
2532
|
-
*
|
|
2512
|
+
* Type-level representation of {@link Null}.
|
|
2533
2513
|
*
|
|
2534
|
-
* @see {@link Null} for the schema value.
|
|
2535
2514
|
* @category models
|
|
2536
2515
|
* @since 3.10.0
|
|
2537
2516
|
*/
|
|
@@ -2547,9 +2526,8 @@ export interface Null extends Bottom<null, null, never, never, AST.Null, Null> {
|
|
|
2547
2526
|
export const Null: Null = make(AST.null)
|
|
2548
2527
|
|
|
2549
2528
|
/**
|
|
2550
|
-
*
|
|
2529
|
+
* Type-level representation of {@link Undefined}.
|
|
2551
2530
|
*
|
|
2552
|
-
* @see {@link Undefined} for the schema value.
|
|
2553
2531
|
* @category models
|
|
2554
2532
|
* @since 3.10.0
|
|
2555
2533
|
*/
|
|
@@ -2565,9 +2543,8 @@ export interface Undefined extends Bottom<undefined, undefined, never, never, AS
|
|
|
2565
2543
|
export const Undefined: Undefined = make(AST.undefined)
|
|
2566
2544
|
|
|
2567
2545
|
/**
|
|
2568
|
-
*
|
|
2546
|
+
* Type-level representation of {@link String}.
|
|
2569
2547
|
*
|
|
2570
|
-
* @see {@link String} for the schema value.
|
|
2571
2548
|
* @category models
|
|
2572
2549
|
* @since 4.0.0
|
|
2573
2550
|
*/
|
|
@@ -2582,9 +2559,8 @@ export interface String extends Bottom<string, string, never, never, AST.String,
|
|
|
2582
2559
|
export const String: String = make(AST.string)
|
|
2583
2560
|
|
|
2584
2561
|
/**
|
|
2585
|
-
*
|
|
2562
|
+
* Type-level representation of {@link Number}.
|
|
2586
2563
|
*
|
|
2587
|
-
* @see {@link Number} for the schema value.
|
|
2588
2564
|
* @category models
|
|
2589
2565
|
* @since 4.0.0
|
|
2590
2566
|
*/
|
|
@@ -2607,9 +2583,8 @@ export interface Number extends Bottom<number, number, never, never, AST.Number,
|
|
|
2607
2583
|
export const Number: Number = make(AST.number)
|
|
2608
2584
|
|
|
2609
2585
|
/**
|
|
2610
|
-
*
|
|
2586
|
+
* Type-level representation of {@link Boolean}.
|
|
2611
2587
|
*
|
|
2612
|
-
* @see {@link Boolean} for the schema value.
|
|
2613
2588
|
* @category models
|
|
2614
2589
|
* @since 4.0.0
|
|
2615
2590
|
*/
|
|
@@ -2624,15 +2599,14 @@ export interface Boolean extends Bottom<boolean, boolean, never, never, AST.Bool
|
|
|
2624
2599
|
*
|
|
2625
2600
|
* @see {@link BooleanFromBit} for a schema that decodes bit literals `0` or `1` into a boolean
|
|
2626
2601
|
*
|
|
2627
|
-
* @category
|
|
2602
|
+
* @category boolean
|
|
2628
2603
|
* @since 4.0.0
|
|
2629
2604
|
*/
|
|
2630
2605
|
export const Boolean: Boolean = make(AST.boolean)
|
|
2631
2606
|
|
|
2632
2607
|
/**
|
|
2633
|
-
*
|
|
2608
|
+
* Type-level representation of {@link Symbol}.
|
|
2634
2609
|
*
|
|
2635
|
-
* @see {@link Symbol} for the schema value.
|
|
2636
2610
|
* @category models
|
|
2637
2611
|
* @since 4.0.0
|
|
2638
2612
|
*/
|
|
@@ -2648,9 +2622,8 @@ export interface Symbol extends Bottom<symbol, symbol, never, never, AST.Symbol,
|
|
|
2648
2622
|
export const Symbol: Symbol = make(AST.symbol)
|
|
2649
2623
|
|
|
2650
2624
|
/**
|
|
2651
|
-
*
|
|
2625
|
+
* Type-level representation of {@link BigInt}.
|
|
2652
2626
|
*
|
|
2653
|
-
* @see {@link BigInt} for the schema value.
|
|
2654
2627
|
* @category models
|
|
2655
2628
|
* @since 4.0.0
|
|
2656
2629
|
*/
|
|
@@ -2672,9 +2645,8 @@ export interface BigInt extends Bottom<bigint, bigint, never, never, AST.BigInt,
|
|
|
2672
2645
|
export const BigInt: BigInt = make(AST.bigInt)
|
|
2673
2646
|
|
|
2674
2647
|
/**
|
|
2675
|
-
*
|
|
2648
|
+
* Type-level representation of {@link Void}.
|
|
2676
2649
|
*
|
|
2677
|
-
* @see {@link Void} for the schema value.
|
|
2678
2650
|
* @category models
|
|
2679
2651
|
* @since 3.10.0
|
|
2680
2652
|
*/
|
|
@@ -2689,9 +2661,8 @@ export interface Void extends Bottom<void, void, never, never, AST.Void, Void> {
|
|
|
2689
2661
|
export const Void: Void = make(AST.void)
|
|
2690
2662
|
|
|
2691
2663
|
/**
|
|
2692
|
-
*
|
|
2664
|
+
* Type-level representation of {@link ObjectKeyword}.
|
|
2693
2665
|
*
|
|
2694
|
-
* @see {@link ObjectKeyword} for the schema value.
|
|
2695
2666
|
* @category models
|
|
2696
2667
|
* @since 4.0.0
|
|
2697
2668
|
*/
|
|
@@ -2707,9 +2678,8 @@ export interface ObjectKeyword extends Bottom<object, object, never, never, AST.
|
|
|
2707
2678
|
export const ObjectKeyword: ObjectKeyword = make(AST.objectKeyword)
|
|
2708
2679
|
|
|
2709
2680
|
/**
|
|
2710
|
-
*
|
|
2681
|
+
* Type-level representation returned by {@link UniqueSymbol}.
|
|
2711
2682
|
*
|
|
2712
|
-
* @see {@link UniqueSymbol} for the constructor function.
|
|
2713
2683
|
* @category models
|
|
2714
2684
|
* @since 4.0.0
|
|
2715
2685
|
*/
|
|
@@ -2899,13 +2869,7 @@ export declare namespace Struct {
|
|
|
2899
2869
|
}
|
|
2900
2870
|
|
|
2901
2871
|
/**
|
|
2902
|
-
*
|
|
2903
|
-
* schema-defined fields.
|
|
2904
|
-
*
|
|
2905
|
-
* **Details**
|
|
2906
|
-
*
|
|
2907
|
-
* The `fields` property exposes the original field map for reuse, and
|
|
2908
|
-
* `mapFields` creates a new struct schema by transforming that field map.
|
|
2872
|
+
* Type-level representation returned by {@link Struct}.
|
|
2909
2873
|
*
|
|
2910
2874
|
* @category models
|
|
2911
2875
|
* @since 3.10.0
|
|
@@ -3062,8 +3026,7 @@ export function fieldsAssign<const NewFields extends Struct.Fields>(fields: NewF
|
|
|
3062
3026
|
}
|
|
3063
3027
|
|
|
3064
3028
|
/**
|
|
3065
|
-
*
|
|
3066
|
-
* {@link encodeKeys}.
|
|
3029
|
+
* Type-level representation returned by {@link encodeKeys}.
|
|
3067
3030
|
*
|
|
3068
3031
|
* @category transforming
|
|
3069
3032
|
* @since 4.0.0
|
|
@@ -3328,16 +3291,7 @@ export declare namespace Record {
|
|
|
3328
3291
|
}
|
|
3329
3292
|
|
|
3330
3293
|
/**
|
|
3331
|
-
*
|
|
3332
|
-
* Produced by {@link Record}.
|
|
3333
|
-
*
|
|
3334
|
-
* **When to use**
|
|
3335
|
-
*
|
|
3336
|
-
* Use as the concrete schema type returned by `Record` when an API needs to
|
|
3337
|
-
* accept or return a record schema with typed property keys and values.
|
|
3338
|
-
*
|
|
3339
|
-
* @see {@link Record} for constructing record schemas
|
|
3340
|
-
* @see {@link StructWithRest} for combining fixed struct fields with record index signatures
|
|
3294
|
+
* Type-level representation returned by {@link Record}.
|
|
3341
3295
|
*
|
|
3342
3296
|
* @category models
|
|
3343
3297
|
* @since 4.0.0
|
|
@@ -3497,16 +3451,7 @@ export declare namespace StructWithRest {
|
|
|
3497
3451
|
}
|
|
3498
3452
|
|
|
3499
3453
|
/**
|
|
3500
|
-
*
|
|
3501
|
-
* by {@link StructWithRest}.
|
|
3502
|
-
*
|
|
3503
|
-
* **When to use**
|
|
3504
|
-
*
|
|
3505
|
-
* Use as the schema type when generic code needs to retain the base struct
|
|
3506
|
-
* schema and all rest record schemas.
|
|
3507
|
-
*
|
|
3508
|
-
* @see {@link StructWithRest} for constructing this schema type
|
|
3509
|
-
* @see {@link Record} for constructing record schemas used as rest index signatures
|
|
3454
|
+
* Type-level representation returned by {@link StructWithRest}.
|
|
3510
3455
|
*
|
|
3511
3456
|
* @category models
|
|
3512
3457
|
* @since 4.0.0
|
|
@@ -3693,7 +3638,7 @@ export declare namespace Tuple {
|
|
|
3693
3638
|
}
|
|
3694
3639
|
|
|
3695
3640
|
/**
|
|
3696
|
-
*
|
|
3641
|
+
* Type-level representation returned by {@link Tuple}.
|
|
3697
3642
|
*
|
|
3698
3643
|
* @category models
|
|
3699
3644
|
* @since 3.10.0
|
|
@@ -3896,8 +3841,7 @@ export declare namespace TupleWithRest {
|
|
|
3896
3841
|
}
|
|
3897
3842
|
|
|
3898
3843
|
/**
|
|
3899
|
-
*
|
|
3900
|
-
* {@link TupleWithRest}.
|
|
3844
|
+
* Type-level representation returned by {@link TupleWithRest}.
|
|
3901
3845
|
*
|
|
3902
3846
|
* @category models
|
|
3903
3847
|
* @since 4.0.0
|
|
@@ -3959,18 +3903,7 @@ export function TupleWithRest<S extends Tuple<Tuple.Elements>, const Rest extend
|
|
|
3959
3903
|
}
|
|
3960
3904
|
|
|
3961
3905
|
/**
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
3964
|
-
* **When to use**
|
|
3965
|
-
*
|
|
3966
|
-
* Use as the public companion type returned by `Schema.Array` when you need to
|
|
3967
|
-
* refer to a readonly array schema built from an element schema.
|
|
3968
|
-
*
|
|
3969
|
-
* **Details**
|
|
3970
|
-
*
|
|
3971
|
-
* The decoded type is `ReadonlyArray<S["Type"]>`, the encoded type is
|
|
3972
|
-
* `ReadonlyArray<S["Encoded"]>`, and the element schema is available as
|
|
3973
|
-
* `value`.
|
|
3906
|
+
* Type-level representation returned by {@link Array}.
|
|
3974
3907
|
*
|
|
3975
3908
|
* @category models
|
|
3976
3909
|
* @since 4.0.0
|
|
@@ -4026,13 +3959,7 @@ export {
|
|
|
4026
3959
|
}
|
|
4027
3960
|
|
|
4028
3961
|
/**
|
|
4029
|
-
*
|
|
4030
|
-
*
|
|
4031
|
-
* **Details**
|
|
4032
|
-
*
|
|
4033
|
-
* The decoded type is `readonly [S["Type"], ...Array<S["Type"]>]`, the encoded type is
|
|
4034
|
-
* `readonly [S["Encoded"], ...Array<S["Encoded"]>]`, and the element schema is available as
|
|
4035
|
-
* `value`.
|
|
3962
|
+
* Type-level representation returned by {@link NonEmptyArray}.
|
|
4036
3963
|
*
|
|
4037
3964
|
* @category models
|
|
4038
3965
|
* @since 3.10.0
|
|
@@ -4080,20 +4007,7 @@ export const NonEmptyArray = Struct_.lambda<NonEmptyArrayLambda>((schema) =>
|
|
|
4080
4007
|
)
|
|
4081
4008
|
|
|
4082
4009
|
/**
|
|
4083
|
-
*
|
|
4084
|
-
* an array of items into a readonly array.
|
|
4085
|
-
*
|
|
4086
|
-
* **When to use**
|
|
4087
|
-
*
|
|
4088
|
-
* Use as the schema type when generic code needs to retain the original item
|
|
4089
|
-
* schema.
|
|
4090
|
-
*
|
|
4091
|
-
* **Details**
|
|
4092
|
-
*
|
|
4093
|
-
* The schema decodes from `S` or `Schema.Array(S)` and produces
|
|
4094
|
-
* `ReadonlyArray<S["Type"]>`.
|
|
4095
|
-
*
|
|
4096
|
-
* @see {@link ArrayEnsure} for constructing this schema type
|
|
4010
|
+
* Type-level representation returned by {@link ArrayEnsure}.
|
|
4097
4011
|
*
|
|
4098
4012
|
* @category constructors
|
|
4099
4013
|
* @since 3.10.0
|
|
@@ -4139,7 +4053,7 @@ export function ArrayEnsure<S extends Top>(schema: S): ArrayEnsure<S> {
|
|
|
4139
4053
|
}
|
|
4140
4054
|
|
|
4141
4055
|
/**
|
|
4142
|
-
*
|
|
4056
|
+
* Type-level representation returned by {@link UniqueArray}.
|
|
4143
4057
|
*
|
|
4144
4058
|
* @category models
|
|
4145
4059
|
* @since 4.0.0
|
|
@@ -4164,8 +4078,7 @@ export function UniqueArray<S extends Top>(item: S): UniqueArray<S> {
|
|
|
4164
4078
|
}
|
|
4165
4079
|
|
|
4166
4080
|
/**
|
|
4167
|
-
*
|
|
4168
|
-
* Produced by {@link mutable}.
|
|
4081
|
+
* Type-level representation returned by {@link mutable}.
|
|
4169
4082
|
*
|
|
4170
4083
|
* @category transforming
|
|
4171
4084
|
* @since 3.10.0
|
|
@@ -4221,7 +4134,7 @@ export const mutable = Struct_.lambda<mutableLambda>((schema) => {
|
|
|
4221
4134
|
})
|
|
4222
4135
|
|
|
4223
4136
|
/**
|
|
4224
|
-
*
|
|
4137
|
+
* Type-level representation returned by {@link Union}.
|
|
4225
4138
|
*
|
|
4226
4139
|
* @category models
|
|
4227
4140
|
* @since 3.10.0
|
|
@@ -4317,9 +4230,8 @@ export function Union<const Members extends ReadonlyArray<Top>>(
|
|
|
4317
4230
|
}
|
|
4318
4231
|
|
|
4319
4232
|
/**
|
|
4320
|
-
*
|
|
4233
|
+
* Type-level representation returned by {@link Literals}.
|
|
4321
4234
|
*
|
|
4322
|
-
* @see {@link Literals} for the constructor function.
|
|
4323
4235
|
* @category models
|
|
4324
4236
|
* @since 4.0.0
|
|
4325
4237
|
*/
|
|
@@ -4379,7 +4291,7 @@ export function Literals<const L extends ReadonlyArray<AST.LiteralValue>>(litera
|
|
|
4379
4291
|
}
|
|
4380
4292
|
|
|
4381
4293
|
/**
|
|
4382
|
-
*
|
|
4294
|
+
* Type-level representation returned by {@link NullOr}.
|
|
4383
4295
|
*
|
|
4384
4296
|
* @category models
|
|
4385
4297
|
* @since 3.10.0
|
|
@@ -4402,7 +4314,7 @@ interface NullOrLambda extends Lambda {
|
|
|
4402
4314
|
export const NullOr = Struct_.lambda<NullOrLambda>((self) => Union([self, Null]))
|
|
4403
4315
|
|
|
4404
4316
|
/**
|
|
4405
|
-
*
|
|
4317
|
+
* Type-level representation returned by {@link UndefinedOr}.
|
|
4406
4318
|
*
|
|
4407
4319
|
* @category models
|
|
4408
4320
|
* @since 3.10.0
|
|
@@ -4425,7 +4337,7 @@ interface UndefinedOrLambda extends Lambda {
|
|
|
4425
4337
|
export const UndefinedOr = Struct_.lambda<UndefinedOrLambda>((self) => Union([self, Undefined]))
|
|
4426
4338
|
|
|
4427
4339
|
/**
|
|
4428
|
-
*
|
|
4340
|
+
* Type-level representation returned by {@link NullishOr}.
|
|
4429
4341
|
*
|
|
4430
4342
|
* @category models
|
|
4431
4343
|
* @since 3.10.0
|
|
@@ -4448,7 +4360,7 @@ interface NullishOrLambda extends Lambda {
|
|
|
4448
4360
|
export const NullishOr = Struct_.lambda<NullishOrLambda>((self) => Union([self, Null, Undefined]))
|
|
4449
4361
|
|
|
4450
4362
|
/**
|
|
4451
|
-
*
|
|
4363
|
+
* Type-level representation returned by {@link suspend}.
|
|
4452
4364
|
*
|
|
4453
4365
|
* @category models
|
|
4454
4366
|
* @since 3.10.0
|
|
@@ -4523,8 +4435,7 @@ export function check<S extends Top>(...checks: readonly [AST.Check<S["Type"]>,
|
|
|
4523
4435
|
}
|
|
4524
4436
|
|
|
4525
4437
|
/**
|
|
4526
|
-
*
|
|
4527
|
-
* type guard.
|
|
4438
|
+
* Type-level representation returned by {@link refine}.
|
|
4528
4439
|
*
|
|
4529
4440
|
* @category filtering
|
|
4530
4441
|
* @since 3.10.0
|
|
@@ -4577,15 +4488,7 @@ export function refine<S extends Top, T extends S["Type"]>(
|
|
|
4577
4488
|
type DistributeBrands<B> = UnionToIntersection<B extends infer U extends string ? Brand.Brand<U> : never>
|
|
4578
4489
|
|
|
4579
4490
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
* more {@link Brand.Brand} tags.
|
|
4582
|
-
*
|
|
4583
|
-
* **When to use**
|
|
4584
|
-
*
|
|
4585
|
-
* Use as the schema type when generic code needs to retain the wrapped schema
|
|
4586
|
-
* and nominal brand type.
|
|
4587
|
-
*
|
|
4588
|
-
* @see {@link brand} for adding the brand tag to an existing schema
|
|
4491
|
+
* Type-level representation returned by {@link brand}.
|
|
4589
4492
|
*
|
|
4590
4493
|
* @category branding
|
|
4591
4494
|
* @since 3.10.0
|
|
@@ -4653,14 +4556,8 @@ export function fromBrand<A extends Brand.Brand<any>>(identifier: string, ctor:
|
|
|
4653
4556
|
}
|
|
4654
4557
|
|
|
4655
4558
|
/**
|
|
4656
|
-
*
|
|
4559
|
+
* Type-level representation returned by {@link middlewareDecoding}.
|
|
4657
4560
|
*
|
|
4658
|
-
* **Details**
|
|
4659
|
-
*
|
|
4660
|
-
* The interceptor receives the full decoding `Effect` and may replace, modify,
|
|
4661
|
-
* or augment it — including adding service requirements via `RD`.
|
|
4662
|
-
*
|
|
4663
|
-
* @see {@link middlewareDecoding} for the constructor
|
|
4664
4561
|
* @category decoding
|
|
4665
4562
|
* @since 4.0.0
|
|
4666
4563
|
*/
|
|
@@ -4725,14 +4622,8 @@ export function middlewareDecoding<S extends Top, RD>(
|
|
|
4725
4622
|
}
|
|
4726
4623
|
|
|
4727
4624
|
/**
|
|
4728
|
-
*
|
|
4625
|
+
* Type-level representation returned by {@link middlewareEncoding}.
|
|
4729
4626
|
*
|
|
4730
|
-
* **Details**
|
|
4731
|
-
*
|
|
4732
|
-
* The interceptor receives the full encoding `Effect` and may replace, modify,
|
|
4733
|
-
* or augment it — including adding service requirements via `RE`.
|
|
4734
|
-
*
|
|
4735
|
-
* @see {@link middlewareEncoding} for the constructor
|
|
4736
4627
|
* @category encoding
|
|
4737
4628
|
* @since 4.0.0
|
|
4738
4629
|
*/
|
|
@@ -4895,16 +4786,8 @@ export function catchEncodingWithContext<S extends Top, R = never>(
|
|
|
4895
4786
|
}
|
|
4896
4787
|
|
|
4897
4788
|
/**
|
|
4898
|
-
*
|
|
4899
|
-
* `From` schema with a `To` schema.
|
|
4900
|
-
*
|
|
4901
|
-
* **Details**
|
|
4789
|
+
* Type-level representation returned by {@link decodeTo}.
|
|
4902
4790
|
*
|
|
4903
|
-
* `Type` is `To["Type"]` and `Encoded` is `From["Encoded"]`. Decoding services
|
|
4904
|
-
* are `To["DecodingServices"] | From["DecodingServices"] | RD`; encoding
|
|
4905
|
-
* services are `To["EncodingServices"] | From["EncodingServices"] | RE`.
|
|
4906
|
-
*
|
|
4907
|
-
* @see {@link compose} for the passthrough (no transformation) variant
|
|
4908
4791
|
* @category transforming
|
|
4909
4792
|
* @since 4.0.0
|
|
4910
4793
|
*/
|
|
@@ -4932,14 +4815,8 @@ export interface decodeTo<To extends Top, From extends Top, RD = never, RE = nev
|
|
|
4932
4815
|
}
|
|
4933
4816
|
|
|
4934
4817
|
/**
|
|
4935
|
-
*
|
|
4936
|
-
*
|
|
4937
|
-
* **Details**
|
|
4818
|
+
* Type-level representation returned by {@link decodeTo} without a custom transformation.
|
|
4938
4819
|
*
|
|
4939
|
-
* Equivalent to {@link decodeTo} with `RD = never` and `RE = never`, meaning the schemas
|
|
4940
|
-
* are composed using their natural encoding/decoding chain.
|
|
4941
|
-
*
|
|
4942
|
-
* @see {@link decodeTo} for the transformation variant
|
|
4943
4820
|
* @category transforming
|
|
4944
4821
|
* @since 3.10.0
|
|
4945
4822
|
*/
|
|
@@ -5171,17 +5048,8 @@ export interface WithoutConstructorDefault {
|
|
|
5171
5048
|
}
|
|
5172
5049
|
|
|
5173
5050
|
/**
|
|
5174
|
-
*
|
|
5175
|
-
* by constructor helpers.
|
|
5176
|
-
*
|
|
5177
|
-
* **Details**
|
|
5051
|
+
* Type-level representation returned by {@link withConstructorDefault}.
|
|
5178
5052
|
*
|
|
5179
|
-
* The default affects `make` and related constructor helpers only; decoding and
|
|
5180
|
-
* encoding still use the original schema behavior. The schema is marked as
|
|
5181
|
-
* already having a constructor default so another constructor default cannot be
|
|
5182
|
-
* added.
|
|
5183
|
-
*
|
|
5184
|
-
* @see {@link withConstructorDefault} for the constructor
|
|
5185
5053
|
* @category constructors
|
|
5186
5054
|
* @since 3.10.0
|
|
5187
5055
|
*/
|
|
@@ -5244,10 +5112,8 @@ export function withConstructorDefault<S extends Top & WithoutConstructorDefault
|
|
|
5244
5112
|
}
|
|
5245
5113
|
|
|
5246
5114
|
/**
|
|
5247
|
-
*
|
|
5248
|
-
* side is `optionalKey` and that fills in a default `Encoded` value during decoding.
|
|
5115
|
+
* Type-level representation returned by {@link withDecodingDefaultKey}.
|
|
5249
5116
|
*
|
|
5250
|
-
* @see {@link withDecodingDefaultKey} for the constructor
|
|
5251
5117
|
* @category decoding
|
|
5252
5118
|
* @since 4.0.0
|
|
5253
5119
|
*/
|
|
@@ -5264,7 +5130,7 @@ export interface withDecodingDefaultKey<S extends Top, R = never> extends decode
|
|
|
5264
5130
|
* - `"passthrough"` (default): pass the value through during encoding
|
|
5265
5131
|
* - `"omit"`: omit the key from the encoded output
|
|
5266
5132
|
*
|
|
5267
|
-
* @category
|
|
5133
|
+
* @category options
|
|
5268
5134
|
* @since 4.0.0
|
|
5269
5135
|
*/
|
|
5270
5136
|
export type DecodingDefaultOptions = {
|
|
@@ -5319,11 +5185,8 @@ export function withDecodingDefaultKey<S extends Top, R = never>(
|
|
|
5319
5185
|
}
|
|
5320
5186
|
|
|
5321
5187
|
/**
|
|
5322
|
-
*
|
|
5323
|
-
* `Encoded` side is `optionalKey` and that fills in a default `Type` value
|
|
5324
|
-
* during decoding.
|
|
5188
|
+
* Type-level representation returned by {@link withDecodingDefaultTypeKey}.
|
|
5325
5189
|
*
|
|
5326
|
-
* @see {@link withDecodingDefaultTypeKey} for the constructor
|
|
5327
5190
|
* @category decoding
|
|
5328
5191
|
* @since 4.0.0
|
|
5329
5192
|
*/
|
|
@@ -5368,10 +5231,8 @@ export function withDecodingDefaultTypeKey<S extends Top, R = never>(
|
|
|
5368
5231
|
}
|
|
5369
5232
|
|
|
5370
5233
|
/**
|
|
5371
|
-
*
|
|
5372
|
-
* side is `optional` and that fills in a default `Encoded` value during decoding.
|
|
5234
|
+
* Type-level representation returned by {@link withDecodingDefault}.
|
|
5373
5235
|
*
|
|
5374
|
-
* @see {@link withDecodingDefault} for the constructor
|
|
5375
5236
|
* @category decoding
|
|
5376
5237
|
* @since 3.10.0
|
|
5377
5238
|
*/
|
|
@@ -5427,11 +5288,8 @@ export function withDecodingDefault<S extends Top, R = never>(
|
|
|
5427
5288
|
}
|
|
5428
5289
|
|
|
5429
5290
|
/**
|
|
5430
|
-
*
|
|
5431
|
-
* `Encoded` side is `optional` and that fills in a default `Type` value during
|
|
5432
|
-
* decoding.
|
|
5291
|
+
* Type-level representation returned by {@link withDecodingDefaultType}.
|
|
5433
5292
|
*
|
|
5434
|
-
* @see {@link withDecodingDefaultType} for the constructor
|
|
5435
5293
|
* @category decoding
|
|
5436
5294
|
* @since 4.0.0
|
|
5437
5295
|
*/
|
|
@@ -5476,13 +5334,8 @@ export function withDecodingDefaultType<S extends Top, R = never>(
|
|
|
5476
5334
|
}
|
|
5477
5335
|
|
|
5478
5336
|
/**
|
|
5479
|
-
*
|
|
5337
|
+
* Type-level representation returned by {@link tag}.
|
|
5480
5338
|
*
|
|
5481
|
-
* **Details**
|
|
5482
|
-
*
|
|
5483
|
-
* Used as the type of the `_tag` field in {@link TaggedStruct} and related helpers.
|
|
5484
|
-
*
|
|
5485
|
-
* @see {@link tag} for the constructor
|
|
5486
5339
|
* @category constructors
|
|
5487
5340
|
* @since 3.10.0
|
|
5488
5341
|
*/
|
|
@@ -5551,9 +5404,8 @@ export function tagDefaultOmit<Tag extends AST.LiteralValue>(literal: Tag) {
|
|
|
5551
5404
|
}
|
|
5552
5405
|
|
|
5553
5406
|
/**
|
|
5554
|
-
*
|
|
5407
|
+
* Type-level representation returned by {@link TaggedStruct}.
|
|
5555
5408
|
*
|
|
5556
|
-
* @see {@link TaggedStruct} for the constructor
|
|
5557
5409
|
* @category models
|
|
5558
5410
|
* @since 3.10.0
|
|
5559
5411
|
*/
|
|
@@ -5652,9 +5504,8 @@ type TaggedUnionUtils<
|
|
|
5652
5504
|
}
|
|
5653
5505
|
|
|
5654
5506
|
/**
|
|
5655
|
-
*
|
|
5507
|
+
* Type-level representation returned by {@link toTaggedUnion}.
|
|
5656
5508
|
*
|
|
5657
|
-
* @see {@link toTaggedUnion} for the constructor
|
|
5658
5509
|
* @category combinators
|
|
5659
5510
|
* @since 4.0.0
|
|
5660
5511
|
*/
|
|
@@ -5737,10 +5588,8 @@ export function toTaggedUnion<const Tag extends PropertyKey>(tag: Tag) {
|
|
|
5737
5588
|
}
|
|
5738
5589
|
|
|
5739
5590
|
/**
|
|
5740
|
-
*
|
|
5741
|
-
* Produced by {@link TaggedUnion}.
|
|
5591
|
+
* Type-level representation returned by {@link TaggedUnion}.
|
|
5742
5592
|
*
|
|
5743
|
-
* @see {@link TaggedUnion} for the constructor
|
|
5744
5593
|
* @category models
|
|
5745
5594
|
* @since 4.0.0
|
|
5746
5595
|
*/
|
|
@@ -5811,11 +5660,8 @@ export function TaggedUnion<const CasesByTag extends Record<string, Struct.Field
|
|
|
5811
5660
|
}
|
|
5812
5661
|
|
|
5813
5662
|
/**
|
|
5814
|
-
*
|
|
5815
|
-
* Carries the same encoded/decoded shape as `S` but replaces `Type` with `Self & Brand`,
|
|
5816
|
-
* making the decoded value nominally distinct.
|
|
5663
|
+
* Type-level representation returned by {@link Opaque}.
|
|
5817
5664
|
*
|
|
5818
|
-
* @see {@link Opaque} for the constructor
|
|
5819
5665
|
* @category models
|
|
5820
5666
|
* @since 4.0.0
|
|
5821
5667
|
*/
|
|
@@ -5874,9 +5720,8 @@ export function Opaque<Self, Brand = {}>() {
|
|
|
5874
5720
|
}
|
|
5875
5721
|
|
|
5876
5722
|
/**
|
|
5877
|
-
*
|
|
5723
|
+
* Type-level representation returned by {@link instanceOf}.
|
|
5878
5724
|
*
|
|
5879
|
-
* @see {@link instanceOf} for the constructor
|
|
5880
5725
|
* @category models
|
|
5881
5726
|
* @since 3.10.0
|
|
5882
5727
|
*/
|
|
@@ -5987,7 +5832,7 @@ export function link<T>() {
|
|
|
5987
5832
|
* // at ["c"])]))
|
|
5988
5833
|
* ```
|
|
5989
5834
|
*
|
|
5990
|
-
* @category
|
|
5835
|
+
* @category constructors
|
|
5991
5836
|
* @since 4.0.0
|
|
5992
5837
|
*/
|
|
5993
5838
|
export const makeFilter: <T>(
|
|
@@ -6052,7 +5897,7 @@ export type FilterOutput =
|
|
|
6052
5897
|
* Groups multiple checks into a single {@link AST.FilterGroup}, applying
|
|
6053
5898
|
* optional shared annotations to the group as a whole.
|
|
6054
5899
|
*
|
|
6055
|
-
* @category
|
|
5900
|
+
* @category constructors
|
|
6056
5901
|
* @since 4.0.0
|
|
6057
5902
|
*/
|
|
6058
5903
|
export function makeFilterGroup<T>(
|
|
@@ -8006,10 +7851,9 @@ export function isUnique<T>(annotations?: Annotations.Filter) {
|
|
|
8006
7851
|
// -----------------------------------------------------------------------------
|
|
8007
7852
|
|
|
8008
7853
|
/**
|
|
8009
|
-
* Type-level representation of
|
|
8010
|
-
* strings with a length of at least one.
|
|
7854
|
+
* Type-level representation of {@link NonEmptyString}.
|
|
8011
7855
|
*
|
|
8012
|
-
* @category
|
|
7856
|
+
* @category string
|
|
8013
7857
|
* @since 3.10.0
|
|
8014
7858
|
*/
|
|
8015
7859
|
export interface NonEmptyString extends String {
|
|
@@ -8020,16 +7864,15 @@ export interface NonEmptyString extends String {
|
|
|
8020
7864
|
* Schema for non-empty strings. Validates that a string has at least one
|
|
8021
7865
|
* character.
|
|
8022
7866
|
*
|
|
8023
|
-
* @category
|
|
7867
|
+
* @category string
|
|
8024
7868
|
* @since 3.10.0
|
|
8025
7869
|
*/
|
|
8026
7870
|
export const NonEmptyString: NonEmptyString = String.check(isNonEmpty())
|
|
8027
7871
|
|
|
8028
7872
|
/**
|
|
8029
|
-
* Type-level representation of
|
|
8030
|
-
* length is exactly one.
|
|
7873
|
+
* Type-level representation of {@link Char}.
|
|
8031
7874
|
*
|
|
8032
|
-
* @category
|
|
7875
|
+
* @category string
|
|
8033
7876
|
* @since 3.10.0
|
|
8034
7877
|
*/
|
|
8035
7878
|
export interface Char extends String {
|
|
@@ -8052,27 +7895,13 @@ export interface Char extends String {
|
|
|
8052
7895
|
* @see {@link NonEmptyString} for strings with length greater than zero
|
|
8053
7896
|
* @see {@link isLengthBetween} for the underlying length check
|
|
8054
7897
|
*
|
|
8055
|
-
* @category
|
|
7898
|
+
* @category string
|
|
8056
7899
|
* @since 3.10.0
|
|
8057
7900
|
*/
|
|
8058
7901
|
export const Char: Char = String.check(isLengthBetween(1, 1))
|
|
8059
7902
|
|
|
8060
7903
|
/**
|
|
8061
|
-
*
|
|
8062
|
-
* either `None` or `Some<A>`.
|
|
8063
|
-
*
|
|
8064
|
-
* **Example** (Option schema)
|
|
8065
|
-
*
|
|
8066
|
-
* ```ts
|
|
8067
|
-
* import { Option, Schema } from "effect"
|
|
8068
|
-
*
|
|
8069
|
-
* const schema = Schema.Option(Schema.Number)
|
|
8070
|
-
*
|
|
8071
|
-
* Schema.decodeUnknownSync(schema)(Option.some(1))
|
|
8072
|
-
* // => Some(1)
|
|
8073
|
-
* Schema.decodeUnknownSync(schema)(Option.none())
|
|
8074
|
-
* // => None
|
|
8075
|
-
* ```
|
|
7904
|
+
* Type-level representation returned by {@link Option}.
|
|
8076
7905
|
*
|
|
8077
7906
|
* @category Option
|
|
8078
7907
|
* @since 3.10.0
|
|
@@ -8172,8 +8001,7 @@ export function Option<A extends Top>(value: A): Option<A> {
|
|
|
8172
8001
|
}
|
|
8173
8002
|
|
|
8174
8003
|
/**
|
|
8175
|
-
* Type-level representation
|
|
8176
|
-
* other values as `Some`.
|
|
8004
|
+
* Type-level representation returned by {@link OptionFromNullOr}.
|
|
8177
8005
|
*
|
|
8178
8006
|
* @category Option
|
|
8179
8007
|
* @since 3.10.0
|
|
@@ -8206,8 +8034,7 @@ export function OptionFromNullOr<S extends Top>(schema: S): OptionFromNullOr<S>
|
|
|
8206
8034
|
}
|
|
8207
8035
|
|
|
8208
8036
|
/**
|
|
8209
|
-
* Type-level representation
|
|
8210
|
-
* all other values as `Some`.
|
|
8037
|
+
* Type-level representation returned by {@link OptionFromUndefinedOr}.
|
|
8211
8038
|
*
|
|
8212
8039
|
* @category Option
|
|
8213
8040
|
* @since 3.10.0
|
|
@@ -8240,8 +8067,7 @@ export function OptionFromUndefinedOr<S extends Top>(schema: S): OptionFromUndef
|
|
|
8240
8067
|
}
|
|
8241
8068
|
|
|
8242
8069
|
/**
|
|
8243
|
-
* Type-level representation
|
|
8244
|
-
* `None` and all other values as `Some`.
|
|
8070
|
+
* Type-level representation returned by {@link OptionFromNullishOr}.
|
|
8245
8071
|
*
|
|
8246
8072
|
* @category Option
|
|
8247
8073
|
* @since 3.10.0
|
|
@@ -8279,8 +8105,7 @@ export function OptionFromNullishOr<S extends Top>(
|
|
|
8279
8105
|
}
|
|
8280
8106
|
|
|
8281
8107
|
/**
|
|
8282
|
-
* Type-level representation
|
|
8283
|
-
* `None` and a present key as `Some`.
|
|
8108
|
+
* Type-level representation returned by {@link OptionFromOptionalKey}.
|
|
8284
8109
|
*
|
|
8285
8110
|
* @category Option
|
|
8286
8111
|
* @since 4.0.0
|
|
@@ -8313,8 +8138,7 @@ export function OptionFromOptionalKey<S extends Top>(schema: S): OptionFromOptio
|
|
|
8313
8138
|
}
|
|
8314
8139
|
|
|
8315
8140
|
/**
|
|
8316
|
-
* Type-level representation
|
|
8317
|
-
* `undefined` value as `None` and other present values as `Some`.
|
|
8141
|
+
* Type-level representation returned by {@link OptionFromOptional}.
|
|
8318
8142
|
*
|
|
8319
8143
|
* @category Option
|
|
8320
8144
|
* @since 4.0.0
|
|
@@ -8349,8 +8173,7 @@ export function OptionFromOptional<S extends Top>(schema: S): OptionFromOptional
|
|
|
8349
8173
|
}
|
|
8350
8174
|
|
|
8351
8175
|
/**
|
|
8352
|
-
* Type-level representation
|
|
8353
|
-
* or `null` as `None` and all other present values as `Some`.
|
|
8176
|
+
* Type-level representation returned by {@link OptionFromOptionalNullOr}.
|
|
8354
8177
|
*
|
|
8355
8178
|
* @category Option
|
|
8356
8179
|
* @since 4.0.0
|
|
@@ -8402,8 +8225,7 @@ export function OptionFromOptionalNullOr<S extends Top>(
|
|
|
8402
8225
|
}
|
|
8403
8226
|
|
|
8404
8227
|
/**
|
|
8405
|
-
*
|
|
8406
|
-
* succeeds with `A` or fails with `E`.
|
|
8228
|
+
* Type-level representation returned by {@link Result}.
|
|
8407
8229
|
*
|
|
8408
8230
|
* @category schemas
|
|
8409
8231
|
* @since 4.0.0
|
|
@@ -8513,8 +8335,7 @@ export function Result<A extends Top, E extends Top>(
|
|
|
8513
8335
|
}
|
|
8514
8336
|
|
|
8515
8337
|
/**
|
|
8516
|
-
*
|
|
8517
|
-
* values. The inner value is hidden from error messages.
|
|
8338
|
+
* Type-level representation returned by {@link Redacted}.
|
|
8518
8339
|
*
|
|
8519
8340
|
* @category Redacted
|
|
8520
8341
|
* @since 3.10.0
|
|
@@ -8621,8 +8442,7 @@ export function Redacted<S extends Top>(value: S, options?: {
|
|
|
8621
8442
|
}
|
|
8622
8443
|
|
|
8623
8444
|
/**
|
|
8624
|
-
* Type-level representation
|
|
8625
|
-
* provided schema and wraps the result in `Redacted`.
|
|
8445
|
+
* Type-level representation returned by {@link RedactedFromValue}.
|
|
8626
8446
|
*
|
|
8627
8447
|
* @category Redacted
|
|
8628
8448
|
* @since 4.0.0
|
|
@@ -8676,22 +8496,7 @@ export function RedactedFromValue<S extends Top>(value: S, options?: {
|
|
|
8676
8496
|
}
|
|
8677
8497
|
|
|
8678
8498
|
/**
|
|
8679
|
-
*
|
|
8680
|
-
* a typed error (`Fail`), an unexpected defect (`Die`), or an interrupt
|
|
8681
|
-
* (`Interrupt`).
|
|
8682
|
-
*
|
|
8683
|
-
* **When to use**
|
|
8684
|
-
*
|
|
8685
|
-
* Use as the schema type when generic code needs to retain the typed failure
|
|
8686
|
-
* and defect schemas for a single cause reason.
|
|
8687
|
-
*
|
|
8688
|
-
* **Details**
|
|
8689
|
-
*
|
|
8690
|
-
* The `error` schema validates typed failures and the `defect` schema validates
|
|
8691
|
-
* unexpected defects.
|
|
8692
|
-
*
|
|
8693
|
-
* @see {@link CauseReason} for constructing this schema type
|
|
8694
|
-
* @see {@link CauseReasonIso} for the ISO shape of each cause reason
|
|
8499
|
+
* Type-level representation returned by {@link CauseReason}.
|
|
8695
8500
|
*
|
|
8696
8501
|
* @category CauseReason
|
|
8697
8502
|
* @since 4.0.0
|
|
@@ -8859,21 +8664,7 @@ function causeReasonToFormatter<E>(error: Formatter<E>, defect: Formatter<unknow
|
|
|
8859
8664
|
}
|
|
8860
8665
|
|
|
8861
8666
|
/**
|
|
8862
|
-
*
|
|
8863
|
-
* reasons combining typed errors, defects, and interrupts.
|
|
8864
|
-
*
|
|
8865
|
-
* **When to use**
|
|
8866
|
-
*
|
|
8867
|
-
* Use as the schema type when generic code needs to retain the typed failure
|
|
8868
|
-
* and defect schemas for a full cause.
|
|
8869
|
-
*
|
|
8870
|
-
* **Details**
|
|
8871
|
-
*
|
|
8872
|
-
* The `error` schema validates typed failures and the `defect` schema validates
|
|
8873
|
-
* unexpected defects.
|
|
8874
|
-
*
|
|
8875
|
-
* @see {@link Cause} for constructing this schema type
|
|
8876
|
-
* @see {@link CauseIso} for the ordered array representation used by the schema ISO
|
|
8667
|
+
* Type-level representation returned by {@link Cause}.
|
|
8877
8668
|
*
|
|
8878
8669
|
* @category Cause
|
|
8879
8670
|
* @since 3.10.0
|
|
@@ -8987,7 +8778,7 @@ function causeToFormatter<E>(error: Formatter<E>, defect: Formatter<unknown>) {
|
|
|
8987
8778
|
}
|
|
8988
8779
|
|
|
8989
8780
|
/**
|
|
8990
|
-
* Type-level representation of
|
|
8781
|
+
* Type-level representation of {@link Error}.
|
|
8991
8782
|
*
|
|
8992
8783
|
* @category Error
|
|
8993
8784
|
* @since 4.0.0
|
|
@@ -9061,8 +8852,7 @@ export const ErrorWithStack: Error = instanceOf(globalThis.Error, {
|
|
|
9061
8852
|
})
|
|
9062
8853
|
|
|
9063
8854
|
/**
|
|
9064
|
-
* Type-level representation of
|
|
9065
|
-
* `Error` values and arbitrary unknown defect values.
|
|
8855
|
+
* Type-level representation of {@link Defect}.
|
|
9066
8856
|
*
|
|
9067
8857
|
* @category Defect
|
|
9068
8858
|
* @since 3.10.0
|
|
@@ -9143,8 +8933,7 @@ export const DefectWithStack: Defect = Union([
|
|
|
9143
8933
|
])
|
|
9144
8934
|
|
|
9145
8935
|
/**
|
|
9146
|
-
*
|
|
9147
|
-
* failure with a `Cause` containing typed errors and defects.
|
|
8936
|
+
* Type-level representation returned by {@link Exit}.
|
|
9148
8937
|
*
|
|
9149
8938
|
* @category Exit
|
|
9150
8939
|
* @since 3.10.0
|
|
@@ -9284,17 +9073,7 @@ export function Exit<A extends Top, E extends Top, D extends Top>(value: A, erro
|
|
|
9284
9073
|
}
|
|
9285
9074
|
|
|
9286
9075
|
/**
|
|
9287
|
-
* Type-level representation
|
|
9288
|
-
* validated by the provided schemas.
|
|
9289
|
-
*
|
|
9290
|
-
* **When to use**
|
|
9291
|
-
*
|
|
9292
|
-
* Use as a type annotation for a `ReadonlyMap` schema when exposing or returning
|
|
9293
|
-
* the schema while preserving its key schema, value schema, and ISO
|
|
9294
|
-
* representation.
|
|
9295
|
-
*
|
|
9296
|
-
* @see {@link ReadonlyMap} for constructing this schema type from key and value schemas
|
|
9297
|
-
* @see {@link ReadonlyMapIso} for the readonly tuple-array ISO representation used by this schema
|
|
9076
|
+
* Type-level representation returned by {@link ReadonlyMap}.
|
|
9298
9077
|
*
|
|
9299
9078
|
* @category ReadonlyMap
|
|
9300
9079
|
* @since 4.0.0
|
|
@@ -9390,8 +9169,7 @@ export function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value:
|
|
|
9390
9169
|
}
|
|
9391
9170
|
|
|
9392
9171
|
/**
|
|
9393
|
-
*
|
|
9394
|
-
* provided schemas.
|
|
9172
|
+
* Type-level representation returned by {@link HashMap}.
|
|
9395
9173
|
*
|
|
9396
9174
|
* @category HashMap
|
|
9397
9175
|
* @since 3.10.0
|
|
@@ -9487,16 +9265,7 @@ export function HashMap<Key extends Top, Value extends Top>(key: Key, value: Val
|
|
|
9487
9265
|
}
|
|
9488
9266
|
|
|
9489
9267
|
/**
|
|
9490
|
-
* Type-level representation
|
|
9491
|
-
* by the provided element schema.
|
|
9492
|
-
*
|
|
9493
|
-
* **When to use**
|
|
9494
|
-
*
|
|
9495
|
-
* Use to name or constrain the schema type produced by `ReadonlySet` when
|
|
9496
|
-
* generic code needs to retain the element schema type.
|
|
9497
|
-
*
|
|
9498
|
-
* @see {@link ReadonlySet} for constructing this schema type
|
|
9499
|
-
* @see {@link ReadonlySetIso} for the array representation used by this schema's ISO
|
|
9268
|
+
* Type-level representation returned by {@link ReadonlySet}.
|
|
9500
9269
|
*
|
|
9501
9270
|
* @category ReadonlySet
|
|
9502
9271
|
* @since 4.0.0
|
|
@@ -9590,8 +9359,7 @@ export function ReadonlySet<Value extends Top>(value: Value): $ReadonlySet<Value
|
|
|
9590
9359
|
}
|
|
9591
9360
|
|
|
9592
9361
|
/**
|
|
9593
|
-
*
|
|
9594
|
-
* schema.
|
|
9362
|
+
* Type-level representation returned by {@link HashSet}.
|
|
9595
9363
|
*
|
|
9596
9364
|
* @category HashSet
|
|
9597
9365
|
* @since 3.10.0
|
|
@@ -9685,8 +9453,7 @@ export function HashSet<Value extends Top>(value: Value): HashSet<Value> {
|
|
|
9685
9453
|
}
|
|
9686
9454
|
|
|
9687
9455
|
/**
|
|
9688
|
-
*
|
|
9689
|
-
* must conform to the provided schema.
|
|
9456
|
+
* Type-level representation returned by {@link Chunk}.
|
|
9690
9457
|
*
|
|
9691
9458
|
* @category Chunk
|
|
9692
9459
|
* @since 3.10.0
|
|
@@ -9787,7 +9554,7 @@ export function Chunk<Value extends Top>(value: Value): Chunk<Value> {
|
|
|
9787
9554
|
}
|
|
9788
9555
|
|
|
9789
9556
|
/**
|
|
9790
|
-
* Type-level representation of
|
|
9557
|
+
* Type-level representation of {@link RegExp}.
|
|
9791
9558
|
*
|
|
9792
9559
|
* @category RegExp
|
|
9793
9560
|
* @since 4.0.0
|
|
@@ -9863,7 +9630,7 @@ export const RegExp: RegExp = instanceOf(
|
|
|
9863
9630
|
)
|
|
9864
9631
|
|
|
9865
9632
|
/**
|
|
9866
|
-
* Type-level representation of
|
|
9633
|
+
* Type-level representation of {@link URL}.
|
|
9867
9634
|
*
|
|
9868
9635
|
* @category URL
|
|
9869
9636
|
* @since 4.0.0
|
|
@@ -9908,8 +9675,7 @@ export const URL: URL = instanceOf(
|
|
|
9908
9675
|
)
|
|
9909
9676
|
|
|
9910
9677
|
/**
|
|
9911
|
-
* Type-level representation of
|
|
9912
|
-
* strings into JavaScript `URL` instances.
|
|
9678
|
+
* Type-level representation of {@link URLFromString}.
|
|
9913
9679
|
*
|
|
9914
9680
|
* @category URL
|
|
9915
9681
|
* @since 4.0.0
|
|
@@ -9935,8 +9701,7 @@ export interface URLFromString extends decodeTo<URL, String> {
|
|
|
9935
9701
|
export const URLFromString: URLFromString = URLString.pipe(decodeTo(URL, Transformation.urlFromString))
|
|
9936
9702
|
|
|
9937
9703
|
/**
|
|
9938
|
-
* Type-level representation of
|
|
9939
|
-
* including invalid dates.
|
|
9704
|
+
* Type-level representation of {@link Date}.
|
|
9940
9705
|
*
|
|
9941
9706
|
* @category Date
|
|
9942
9707
|
* @since 4.0.0
|
|
@@ -9996,8 +9761,7 @@ export const Date: Date = instanceOf(
|
|
|
9996
9761
|
)
|
|
9997
9762
|
|
|
9998
9763
|
/**
|
|
9999
|
-
* Type-level representation of
|
|
10000
|
-
* JavaScript `Date` instances.
|
|
9764
|
+
* Type-level representation of {@link DateFromString}.
|
|
10001
9765
|
*
|
|
10002
9766
|
* @category Date
|
|
10003
9767
|
* @since 3.10.0
|
|
@@ -10036,8 +9800,7 @@ export interface DateFromString extends decodeTo<Date, String> {
|
|
|
10036
9800
|
export const DateFromString: DateFromString = DateString.pipe(decodeTo(Date, Transformation.dateFromString))
|
|
10037
9801
|
|
|
10038
9802
|
/**
|
|
10039
|
-
* Type-level representation of
|
|
10040
|
-
* JavaScript `Date` instances.
|
|
9803
|
+
* Type-level representation of {@link DateValid}.
|
|
10041
9804
|
*
|
|
10042
9805
|
* @category Date
|
|
10043
9806
|
* @since 4.0.0
|
|
@@ -10060,7 +9823,7 @@ export interface DateValid extends Date {
|
|
|
10060
9823
|
export const DateValid: DateValid = Date.check(isDateValid())
|
|
10061
9824
|
|
|
10062
9825
|
/**
|
|
10063
|
-
* Type-level representation of
|
|
9826
|
+
* Type-level representation of {@link Duration}.
|
|
10064
9827
|
*
|
|
10065
9828
|
* @category Duration
|
|
10066
9829
|
* @since 3.10.0
|
|
@@ -10152,8 +9915,7 @@ export const Duration: Duration = declare(
|
|
|
10152
9915
|
const DurationString = String.annotate({ expected: "a string that will be decoded as a Duration" })
|
|
10153
9916
|
|
|
10154
9917
|
/**
|
|
10155
|
-
* Type-level representation of
|
|
10156
|
-
* accepted by `Duration.fromInput` into `Duration` values.
|
|
9918
|
+
* Type-level representation of {@link DurationFromString}.
|
|
10157
9919
|
*
|
|
10158
9920
|
* @category Duration
|
|
10159
9921
|
* @since 4.0.0
|
|
@@ -10182,8 +9944,7 @@ export const DurationFromString: DurationFromString = DurationString.pipe(
|
|
|
10182
9944
|
)
|
|
10183
9945
|
|
|
10184
9946
|
/**
|
|
10185
|
-
* Type-level representation of
|
|
10186
|
-
* nanosecond `bigint` values into `Duration` values.
|
|
9947
|
+
* Type-level representation of {@link DurationFromNanos}.
|
|
10187
9948
|
*
|
|
10188
9949
|
* @category Duration
|
|
10189
9950
|
* @since 3.10.0
|
|
@@ -10216,8 +9977,7 @@ export const DurationFromNanos: DurationFromNanos = BigInt.check(isGreaterThanOr
|
|
|
10216
9977
|
)
|
|
10217
9978
|
|
|
10218
9979
|
/**
|
|
10219
|
-
* Type-level representation of
|
|
10220
|
-
* non-negative millisecond numbers into `Duration` values.
|
|
9980
|
+
* Type-level representation of {@link DurationFromMillis}.
|
|
10221
9981
|
*
|
|
10222
9982
|
* @category Duration
|
|
10223
9983
|
* @since 3.10.0
|
|
@@ -10249,7 +10009,7 @@ export const DurationFromMillis: DurationFromMillis = Number.check(isGreaterThan
|
|
|
10249
10009
|
)
|
|
10250
10010
|
|
|
10251
10011
|
/**
|
|
10252
|
-
* Type-level representation of
|
|
10012
|
+
* Type-level representation of {@link BigDecimal}.
|
|
10253
10013
|
*
|
|
10254
10014
|
* @category BigDecimal
|
|
10255
10015
|
* @since 3.10.0
|
|
@@ -10305,8 +10065,7 @@ export const BigDecimal: BigDecimal = declare(
|
|
|
10305
10065
|
)
|
|
10306
10066
|
|
|
10307
10067
|
/**
|
|
10308
|
-
* Type-level representation of
|
|
10309
|
-
* `BigDecimal` values.
|
|
10068
|
+
* Type-level representation of {@link BigDecimalFromString}.
|
|
10310
10069
|
*
|
|
10311
10070
|
* @category BigDecimal
|
|
10312
10071
|
* @since 4.0.0
|
|
@@ -10347,10 +10106,9 @@ export const BigDecimalFromString: BigDecimalFromString = BigDecimalString.pipe(
|
|
|
10347
10106
|
)
|
|
10348
10107
|
|
|
10349
10108
|
/**
|
|
10350
|
-
* Type-level representation of
|
|
10351
|
-
* JSON-encoded strings into `unknown` values.
|
|
10109
|
+
* Type-level representation of {@link UnknownFromJsonString}.
|
|
10352
10110
|
*
|
|
10353
|
-
* @category
|
|
10111
|
+
* @category models
|
|
10354
10112
|
* @since 4.0.0
|
|
10355
10113
|
*/
|
|
10356
10114
|
export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
@@ -10379,16 +10137,15 @@ export interface UnknownFromJsonString extends fromJsonString<Unknown> {
|
|
|
10379
10137
|
* // => { a: 1, b: 2 }
|
|
10380
10138
|
* ```
|
|
10381
10139
|
*
|
|
10382
|
-
* @category
|
|
10140
|
+
* @category schemas
|
|
10383
10141
|
* @since 4.0.0
|
|
10384
10142
|
*/
|
|
10385
10143
|
export const UnknownFromJsonString: UnknownFromJsonString = fromJsonString(Unknown)
|
|
10386
10144
|
|
|
10387
10145
|
/**
|
|
10388
|
-
* Type-level representation
|
|
10389
|
-
* decodes the parsed value with the provided schema.
|
|
10146
|
+
* Type-level representation returned by {@link fromJsonString}.
|
|
10390
10147
|
*
|
|
10391
|
-
* @category
|
|
10148
|
+
* @category models
|
|
10392
10149
|
* @since 4.0.0
|
|
10393
10150
|
*/
|
|
10394
10151
|
export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
@@ -10458,7 +10215,7 @@ export interface fromJsonString<S extends Top> extends decodeTo<S, String> {
|
|
|
10458
10215
|
* // }
|
|
10459
10216
|
* ```
|
|
10460
10217
|
*
|
|
10461
|
-
* @category
|
|
10218
|
+
* @category constructors
|
|
10462
10219
|
* @since 4.0.0
|
|
10463
10220
|
*/
|
|
10464
10221
|
export function fromJsonString<S extends Top>(schema: S): fromJsonString<S> {
|
|
@@ -10470,9 +10227,9 @@ export function fromJsonString<S extends Top>(schema: S): fromJsonString<S> {
|
|
|
10470
10227
|
}
|
|
10471
10228
|
|
|
10472
10229
|
/**
|
|
10473
|
-
* Type-level representation of
|
|
10230
|
+
* Type-level representation of {@link File}.
|
|
10474
10231
|
*
|
|
10475
|
-
* @category
|
|
10232
|
+
* @category file
|
|
10476
10233
|
* @since 4.0.0
|
|
10477
10234
|
*/
|
|
10478
10235
|
export interface File extends instanceOf<globalThis.File> {
|
|
@@ -10487,7 +10244,7 @@ export interface File extends instanceOf<globalThis.File> {
|
|
|
10487
10244
|
* The default JSON serializer encodes a `File` as `{ data, type, name, lastModified }`
|
|
10488
10245
|
* where `data` is base64-encoded.
|
|
10489
10246
|
*
|
|
10490
|
-
* @category
|
|
10247
|
+
* @category file
|
|
10491
10248
|
* @since 4.0.0
|
|
10492
10249
|
*/
|
|
10493
10250
|
export const File: File = instanceOf(globalThis.File, {
|
|
@@ -10544,7 +10301,7 @@ export const File: File = instanceOf(globalThis.File, {
|
|
|
10544
10301
|
})
|
|
10545
10302
|
|
|
10546
10303
|
/**
|
|
10547
|
-
* Type-level representation of
|
|
10304
|
+
* Type-level representation of {@link FormData}.
|
|
10548
10305
|
*
|
|
10549
10306
|
* @category FormData
|
|
10550
10307
|
* @since 4.0.0
|
|
@@ -10608,8 +10365,7 @@ export const FormData: FormData = instanceOf(globalThis.FormData, {
|
|
|
10608
10365
|
})
|
|
10609
10366
|
|
|
10610
10367
|
/**
|
|
10611
|
-
* Type-level representation
|
|
10612
|
-
* record and then decodes it with the provided schema.
|
|
10368
|
+
* Type-level representation returned by {@link fromFormData}.
|
|
10613
10369
|
*
|
|
10614
10370
|
* @category FormData
|
|
10615
10371
|
* @since 4.0.0
|
|
@@ -10711,10 +10467,9 @@ export function fromFormData<S extends Top>(schema: S): fromFormData<S> {
|
|
|
10711
10467
|
}
|
|
10712
10468
|
|
|
10713
10469
|
/**
|
|
10714
|
-
* Type-level representation of
|
|
10715
|
-
* instances.
|
|
10470
|
+
* Type-level representation of {@link URLSearchParams}.
|
|
10716
10471
|
*
|
|
10717
|
-
* @category
|
|
10472
|
+
* @category search params
|
|
10718
10473
|
* @since 4.0.0
|
|
10719
10474
|
*/
|
|
10720
10475
|
export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams> {
|
|
@@ -10728,7 +10483,7 @@ export interface URLSearchParams extends instanceOf<globalThis.URLSearchParams>
|
|
|
10728
10483
|
*
|
|
10729
10484
|
* The default JSON serializer encodes a `URLSearchParams` as a query string.
|
|
10730
10485
|
*
|
|
10731
|
-
* @category
|
|
10486
|
+
* @category search params
|
|
10732
10487
|
* @since 4.0.0
|
|
10733
10488
|
*/
|
|
10734
10489
|
export const URLSearchParams: URLSearchParams = instanceOf(globalThis.URLSearchParams, {
|
|
@@ -10751,10 +10506,9 @@ export const URLSearchParams: URLSearchParams = instanceOf(globalThis.URLSearchP
|
|
|
10751
10506
|
})
|
|
10752
10507
|
|
|
10753
10508
|
/**
|
|
10754
|
-
* Type-level representation
|
|
10755
|
-
* tree record and then decodes it with the provided schema.
|
|
10509
|
+
* Type-level representation returned by {@link fromURLSearchParams}.
|
|
10756
10510
|
*
|
|
10757
|
-
* @category
|
|
10511
|
+
* @category search params
|
|
10758
10512
|
* @since 4.0.0
|
|
10759
10513
|
*/
|
|
10760
10514
|
export interface fromURLSearchParams<S extends Top> extends decodeTo<S, URLSearchParams> {
|
|
@@ -10846,8 +10600,7 @@ export function fromURLSearchParams<S extends Top>(schema: S): fromURLSearchPara
|
|
|
10846
10600
|
}
|
|
10847
10601
|
|
|
10848
10602
|
/**
|
|
10849
|
-
* Type-level representation of
|
|
10850
|
-
* `Infinity`, and `-Infinity`.
|
|
10603
|
+
* Type-level representation of {@link Finite}.
|
|
10851
10604
|
*
|
|
10852
10605
|
* @category Number
|
|
10853
10606
|
* @since 3.10.0
|
|
@@ -10865,8 +10618,7 @@ export interface Finite extends Number {
|
|
|
10865
10618
|
export const Finite: Finite = Number.check(isFinite())
|
|
10866
10619
|
|
|
10867
10620
|
/**
|
|
10868
|
-
* Type-level representation of
|
|
10869
|
-
* integer numbers.
|
|
10621
|
+
* Type-level representation of {@link Int}.
|
|
10870
10622
|
*
|
|
10871
10623
|
* @category Number
|
|
10872
10624
|
* @since 3.10.0
|
|
@@ -10884,8 +10636,7 @@ export interface Int extends Number {
|
|
|
10884
10636
|
export const Int: Int = Number.check(isInt())
|
|
10885
10637
|
|
|
10886
10638
|
/**
|
|
10887
|
-
* Type-level representation of
|
|
10888
|
-
* numbers using JavaScript number coercion.
|
|
10639
|
+
* Type-level representation of {@link NumberFromString}.
|
|
10889
10640
|
*
|
|
10890
10641
|
* @category Number
|
|
10891
10642
|
* @since 3.10.0
|
|
@@ -10916,8 +10667,7 @@ export const NumberFromString: NumberFromString = String.annotate({
|
|
|
10916
10667
|
}).pipe(decodeTo(Number, Transformation.numberFromString))
|
|
10917
10668
|
|
|
10918
10669
|
/**
|
|
10919
|
-
* Type-level representation of
|
|
10920
|
-
* finite numbers.
|
|
10670
|
+
* Type-level representation of {@link FiniteFromString}.
|
|
10921
10671
|
*
|
|
10922
10672
|
* @category Number
|
|
10923
10673
|
* @since 4.0.0
|
|
@@ -10946,8 +10696,7 @@ export const FiniteFromString: FiniteFromString = String.annotate({
|
|
|
10946
10696
|
}).pipe(decodeTo(Finite, Transformation.numberFromString))
|
|
10947
10697
|
|
|
10948
10698
|
/**
|
|
10949
|
-
* Type-level representation of
|
|
10950
|
-
* `bigint` values.
|
|
10699
|
+
* Type-level representation of {@link BigIntFromString}.
|
|
10951
10700
|
*
|
|
10952
10701
|
* @category BigInt
|
|
10953
10702
|
* @since 4.0.0
|
|
@@ -10989,10 +10738,9 @@ export const BigIntFromString: BigIntFromString = make<String>(AST.bigIntString)
|
|
|
10989
10738
|
)
|
|
10990
10739
|
|
|
10991
10740
|
/**
|
|
10992
|
-
*
|
|
10993
|
-
* trailing whitespace.
|
|
10741
|
+
* Type-level representation of {@link Trimmed}.
|
|
10994
10742
|
*
|
|
10995
|
-
* @category
|
|
10743
|
+
* @category string
|
|
10996
10744
|
* @since 3.10.0
|
|
10997
10745
|
*/
|
|
10998
10746
|
export interface Trimmed extends String {
|
|
@@ -11002,16 +10750,15 @@ export interface Trimmed extends String {
|
|
|
11002
10750
|
/**
|
|
11003
10751
|
* Schema for strings that contains no leading or trailing whitespaces.
|
|
11004
10752
|
*
|
|
11005
|
-
* @category
|
|
10753
|
+
* @category string
|
|
11006
10754
|
* @since 3.10.0
|
|
11007
10755
|
*/
|
|
11008
10756
|
export const Trimmed: Trimmed = String.check(isTrimmed())
|
|
11009
10757
|
|
|
11010
10758
|
/**
|
|
11011
|
-
*
|
|
11012
|
-
* whitespace while decoding and encodes the trimmed string unchanged.
|
|
10759
|
+
* Type-level representation of {@link Trim}.
|
|
11013
10760
|
*
|
|
11014
|
-
* @category
|
|
10761
|
+
* @category string
|
|
11015
10762
|
* @since 3.10.0
|
|
11016
10763
|
*/
|
|
11017
10764
|
export interface Trim extends decodeTo<Trimmed, String> {
|
|
@@ -11029,7 +10776,7 @@ export interface Trim extends decodeTo<Trimmed, String> {
|
|
|
11029
10776
|
* Encoding:
|
|
11030
10777
|
* - The trimmed string is encoded as is.
|
|
11031
10778
|
*
|
|
11032
|
-
* @category
|
|
10779
|
+
* @category string
|
|
11033
10780
|
* @since 3.10.0
|
|
11034
10781
|
*/
|
|
11035
10782
|
export const Trim: Trim = String.annotate({
|
|
@@ -11037,10 +10784,9 @@ export const Trim: Trim = String.annotate({
|
|
|
11037
10784
|
}).pipe(decodeTo(Trimmed, Transformation.trim()))
|
|
11038
10785
|
|
|
11039
10786
|
/**
|
|
11040
|
-
*
|
|
11041
|
-
* base64-encoded strings and UTF-8 strings.
|
|
10787
|
+
* Type-level representation of {@link StringFromBase64}.
|
|
11042
10788
|
*
|
|
11043
|
-
* @category
|
|
10789
|
+
* @category string
|
|
11044
10790
|
* @since 3.10.0
|
|
11045
10791
|
*/
|
|
11046
10792
|
export interface StringFromBase64 extends decodeTo<String, String> {
|
|
@@ -11058,7 +10804,7 @@ export interface StringFromBase64 extends decodeTo<String, String> {
|
|
|
11058
10804
|
* Encoding:
|
|
11059
10805
|
* - A `string` is encoded as a base64-encoded string.
|
|
11060
10806
|
*
|
|
11061
|
-
* @category
|
|
10807
|
+
* @category string
|
|
11062
10808
|
* @since 3.10.0
|
|
11063
10809
|
*/
|
|
11064
10810
|
export const StringFromBase64: StringFromBase64 = String.annotate({
|
|
@@ -11068,10 +10814,9 @@ export const StringFromBase64: StringFromBase64 = String.annotate({
|
|
|
11068
10814
|
)
|
|
11069
10815
|
|
|
11070
10816
|
/**
|
|
11071
|
-
*
|
|
11072
|
-
* base64-encoded strings and UTF-8 strings.
|
|
10817
|
+
* Type-level representation of {@link StringFromBase64Url}.
|
|
11073
10818
|
*
|
|
11074
|
-
* @category
|
|
10819
|
+
* @category string
|
|
11075
10820
|
* @since 3.10.0
|
|
11076
10821
|
*/
|
|
11077
10822
|
export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
@@ -11089,7 +10834,7 @@ export interface StringFromBase64Url extends decodeTo<String, String> {
|
|
|
11089
10834
|
* Encoding:
|
|
11090
10835
|
* - A `string` is encoded as a base64 (URL) encoded string.
|
|
11091
10836
|
*
|
|
11092
|
-
* @category
|
|
10837
|
+
* @category string
|
|
11093
10838
|
* @since 3.10.0
|
|
11094
10839
|
*/
|
|
11095
10840
|
export const StringFromBase64Url: StringFromBase64Url = String.annotate({
|
|
@@ -11099,10 +10844,9 @@ export const StringFromBase64Url: StringFromBase64Url = String.annotate({
|
|
|
11099
10844
|
)
|
|
11100
10845
|
|
|
11101
10846
|
/**
|
|
11102
|
-
*
|
|
11103
|
-
* strings and UTF-8 strings.
|
|
10847
|
+
* Type-level representation of {@link StringFromHex}.
|
|
11104
10848
|
*
|
|
11105
|
-
* @category
|
|
10849
|
+
* @category string
|
|
11106
10850
|
* @since 3.10.0
|
|
11107
10851
|
*/
|
|
11108
10852
|
export interface StringFromHex extends decodeTo<String, String> {
|
|
@@ -11120,7 +10864,7 @@ export interface StringFromHex extends decodeTo<String, String> {
|
|
|
11120
10864
|
* Encoding:
|
|
11121
10865
|
* - A `string` is encoded as a hex string.
|
|
11122
10866
|
*
|
|
11123
|
-
* @category
|
|
10867
|
+
* @category string
|
|
11124
10868
|
* @since 3.10.0
|
|
11125
10869
|
*/
|
|
11126
10870
|
export const StringFromHex: StringFromHex = String.annotate({
|
|
@@ -11130,10 +10874,9 @@ export const StringFromHex: StringFromHex = String.annotate({
|
|
|
11130
10874
|
)
|
|
11131
10875
|
|
|
11132
10876
|
/**
|
|
11133
|
-
*
|
|
11134
|
-
* URI-component encoded strings and UTF-8 strings.
|
|
10877
|
+
* Type-level representation of {@link StringFromUriComponent}.
|
|
11135
10878
|
*
|
|
11136
|
-
* @category
|
|
10879
|
+
* @category string
|
|
11137
10880
|
* @since 3.12.0
|
|
11138
10881
|
*/
|
|
11139
10882
|
export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
@@ -11170,7 +10913,7 @@ export interface StringFromUriComponent extends decodeTo<String, String> {
|
|
|
11170
10913
|
* // %7B%22maxItemPerPage%22%3A10%2C%22page%22%3A1%7D
|
|
11171
10914
|
* ```
|
|
11172
10915
|
*
|
|
11173
|
-
* @category
|
|
10916
|
+
* @category string
|
|
11174
10917
|
* @since 3.12.0
|
|
11175
10918
|
*/
|
|
11176
10919
|
export const StringFromUriComponent: StringFromUriComponent = String.annotate({
|
|
@@ -11196,7 +10939,7 @@ export const PropertyKey = Union([Finite, Symbol, String])
|
|
|
11196
10939
|
* The result contains an `issues` array where each issue has a message and an
|
|
11197
10940
|
* optional path made of property keys or keyed path segments.
|
|
11198
10941
|
*
|
|
11199
|
-
* @category
|
|
10942
|
+
* @category Standard Schema
|
|
11200
10943
|
* @since 4.0.0
|
|
11201
10944
|
*/
|
|
11202
10945
|
export const StandardSchemaV1FailureResult = Struct({
|
|
@@ -11207,10 +10950,9 @@ export const StandardSchemaV1FailureResult = Struct({
|
|
|
11207
10950
|
})
|
|
11208
10951
|
|
|
11209
10952
|
/**
|
|
11210
|
-
*
|
|
11211
|
-
* `0 | 1` and boolean values.
|
|
10953
|
+
* Type-level representation of {@link BooleanFromBit}.
|
|
11212
10954
|
*
|
|
11213
|
-
* @category
|
|
10955
|
+
* @category boolean
|
|
11214
10956
|
* @since 4.0.0
|
|
11215
10957
|
*/
|
|
11216
10958
|
export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0, 1]>> {
|
|
@@ -11233,7 +10975,7 @@ export interface BooleanFromBit extends decodeTo<Boolean, Literals<readonly [0,
|
|
|
11233
10975
|
* @see {@link Boolean} for validating values that are already booleans
|
|
11234
10976
|
* @see {@link Literals} for keeping bit literals instead of decoding them
|
|
11235
10977
|
*
|
|
11236
|
-
* @category
|
|
10978
|
+
* @category boolean
|
|
11237
10979
|
* @since 4.0.0
|
|
11238
10980
|
*/
|
|
11239
10981
|
export const BooleanFromBit: BooleanFromBit = Literals([0, 1]).pipe(
|
|
@@ -11247,8 +10989,7 @@ export const BooleanFromBit: BooleanFromBit = Literals([0, 1]).pipe(
|
|
|
11247
10989
|
)
|
|
11248
10990
|
|
|
11249
10991
|
/**
|
|
11250
|
-
*
|
|
11251
|
-
* instances with base64 JSON encoding.
|
|
10992
|
+
* Type-level representation of {@link Uint8Array}.
|
|
11252
10993
|
*
|
|
11253
10994
|
* @category Uint8Array
|
|
11254
10995
|
* @since 4.0.0
|
|
@@ -11293,8 +11034,7 @@ export const Uint8Array: Uint8Array = instanceOf(globalThis.Uint8Array<ArrayBuff
|
|
|
11293
11034
|
})
|
|
11294
11035
|
|
|
11295
11036
|
/**
|
|
11296
|
-
*
|
|
11297
|
-
* base64-encoded strings and `Uint8Array` values.
|
|
11037
|
+
* Type-level representation of {@link Uint8ArrayFromBase64}.
|
|
11298
11038
|
*
|
|
11299
11039
|
* @category Uint8Array
|
|
11300
11040
|
* @since 3.10.0
|
|
@@ -11323,8 +11063,7 @@ export const Uint8ArrayFromBase64: Uint8ArrayFromBase64 = Base64String.pipe(
|
|
|
11323
11063
|
)
|
|
11324
11064
|
|
|
11325
11065
|
/**
|
|
11326
|
-
*
|
|
11327
|
-
* URL-safe base64-encoded strings and `Uint8Array` values.
|
|
11066
|
+
* Type-level representation of {@link Uint8ArrayFromBase64Url}.
|
|
11328
11067
|
*
|
|
11329
11068
|
* @category Uint8Array
|
|
11330
11069
|
* @since 3.10.0
|
|
@@ -11358,8 +11097,7 @@ export const Uint8ArrayFromBase64Url: Uint8ArrayFromBase64Url = String.annotate(
|
|
|
11358
11097
|
)
|
|
11359
11098
|
|
|
11360
11099
|
/**
|
|
11361
|
-
*
|
|
11362
|
-
* hex-encoded strings and `Uint8Array` values.
|
|
11100
|
+
* Type-level representation of {@link Uint8ArrayFromHex}.
|
|
11363
11101
|
*
|
|
11364
11102
|
* @category Uint8Array
|
|
11365
11103
|
* @since 3.10.0
|
|
@@ -11393,8 +11131,7 @@ export const Uint8ArrayFromHex: Uint8ArrayFromHex = String.annotate({
|
|
|
11393
11131
|
)
|
|
11394
11132
|
|
|
11395
11133
|
/**
|
|
11396
|
-
*
|
|
11397
|
-
* UTC ISO string JSON encoding.
|
|
11134
|
+
* Type-level representation of {@link DateTimeUtc}.
|
|
11398
11135
|
*
|
|
11399
11136
|
* @category DateTime
|
|
11400
11137
|
* @since 3.10.0
|
|
@@ -11449,8 +11186,7 @@ export const DateTimeUtc: DateTimeUtc = declare(
|
|
|
11449
11186
|
)
|
|
11450
11187
|
|
|
11451
11188
|
/**
|
|
11452
|
-
*
|
|
11453
|
-
* JavaScript `Date` values to `DateTime.Utc`.
|
|
11189
|
+
* Type-level representation of {@link DateTimeUtcFromDate}.
|
|
11454
11190
|
*
|
|
11455
11191
|
* @category DateTime
|
|
11456
11192
|
* @since 3.12.0
|
|
@@ -11491,8 +11227,7 @@ export const DateTimeUtcFromDate: DateTimeUtcFromDate = DateValid.pipe(
|
|
|
11491
11227
|
)
|
|
11492
11228
|
|
|
11493
11229
|
/**
|
|
11494
|
-
*
|
|
11495
|
-
* strings to `DateTime.Utc`.
|
|
11230
|
+
* Type-level representation of {@link DateTimeUtcFromString}.
|
|
11496
11231
|
*
|
|
11497
11232
|
* @category DateTime
|
|
11498
11233
|
* @since 4.0.0
|
|
@@ -11528,8 +11263,7 @@ export const DateTimeUtcFromString: DateTimeUtcFromString = String.annotate({
|
|
|
11528
11263
|
)
|
|
11529
11264
|
|
|
11530
11265
|
/**
|
|
11531
|
-
*
|
|
11532
|
-
* milliseconds and `DateTime.Utc` values.
|
|
11266
|
+
* Type-level representation of {@link DateTimeUtcFromMillis}.
|
|
11533
11267
|
*
|
|
11534
11268
|
* @category DateTime
|
|
11535
11269
|
* @since 4.0.0
|
|
@@ -11560,8 +11294,7 @@ export const DateTimeUtcFromMillis: DateTimeUtcFromMillis = Number.pipe(
|
|
|
11560
11294
|
)
|
|
11561
11295
|
|
|
11562
11296
|
/**
|
|
11563
|
-
*
|
|
11564
|
-
* `DateTime.TimeZone.Offset` values encoded as offset milliseconds.
|
|
11297
|
+
* Type-level representation of {@link TimeZoneOffset}.
|
|
11565
11298
|
*
|
|
11566
11299
|
* @category DateTime
|
|
11567
11300
|
* @since 3.10.0
|
|
@@ -11607,8 +11340,7 @@ export const TimeZoneOffset: TimeZoneOffset = declare(
|
|
|
11607
11340
|
)
|
|
11608
11341
|
|
|
11609
11342
|
/**
|
|
11610
|
-
*
|
|
11611
|
-
* `DateTime.TimeZone.Named` values encoded as IANA time zone identifiers.
|
|
11343
|
+
* Type-level representation of {@link TimeZoneNamed}.
|
|
11612
11344
|
*
|
|
11613
11345
|
* @category DateTime
|
|
11614
11346
|
* @since 3.10.0
|
|
@@ -11660,8 +11392,7 @@ export const TimeZoneNamed: TimeZoneNamed = declare(
|
|
|
11660
11392
|
)
|
|
11661
11393
|
|
|
11662
11394
|
/**
|
|
11663
|
-
*
|
|
11664
|
-
* time zone identifier strings and `DateTime.TimeZone.Named` values.
|
|
11395
|
+
* Type-level representation of {@link TimeZoneNamedFromString}.
|
|
11665
11396
|
*
|
|
11666
11397
|
* @category DateTime
|
|
11667
11398
|
* @since 4.0.0
|
|
@@ -11689,8 +11420,7 @@ export const TimeZoneNamedFromString: TimeZoneNamedFromString = TimeZoneNamedStr
|
|
|
11689
11420
|
)
|
|
11690
11421
|
|
|
11691
11422
|
/**
|
|
11692
|
-
*
|
|
11693
|
-
* encoded as either IANA identifiers or numeric offset strings.
|
|
11423
|
+
* Type-level representation of {@link TimeZone}.
|
|
11694
11424
|
*
|
|
11695
11425
|
* @category DateTime
|
|
11696
11426
|
* @since 3.10.0
|
|
@@ -11748,8 +11478,7 @@ export const TimeZone: TimeZone = declare(
|
|
|
11748
11478
|
)
|
|
11749
11479
|
|
|
11750
11480
|
/**
|
|
11751
|
-
*
|
|
11752
|
-
* identifier or offset strings to `DateTime.TimeZone` values.
|
|
11481
|
+
* Type-level representation of {@link TimeZoneFromString}.
|
|
11753
11482
|
*
|
|
11754
11483
|
* @category DateTime
|
|
11755
11484
|
* @since 4.0.0
|
|
@@ -11777,8 +11506,7 @@ export const TimeZoneFromString: TimeZoneFromString = TimeZoneString.pipe(
|
|
|
11777
11506
|
)
|
|
11778
11507
|
|
|
11779
11508
|
/**
|
|
11780
|
-
*
|
|
11781
|
-
* with ISO offset or named-zone string JSON encoding.
|
|
11509
|
+
* Type-level representation of {@link DateTimeZoned}.
|
|
11782
11510
|
*
|
|
11783
11511
|
* @category DateTime
|
|
11784
11512
|
* @since 3.10.0
|
|
@@ -11839,8 +11567,7 @@ export const DateTimeZoned: DateTimeZoned = declare(
|
|
|
11839
11567
|
)
|
|
11840
11568
|
|
|
11841
11569
|
/**
|
|
11842
|
-
*
|
|
11843
|
-
* zoned date-time strings and `DateTime.Zoned` values.
|
|
11570
|
+
* Type-level representation of {@link DateTimeZonedFromString}.
|
|
11844
11571
|
*
|
|
11845
11572
|
* @category DateTime
|
|
11846
11573
|
* @since 4.0.0
|
|
@@ -11872,15 +11599,7 @@ export const DateTimeZonedFromString: DateTimeZonedFromString = DateTimeZonedStr
|
|
|
11872
11599
|
// -----------------------------------------------------------------------------
|
|
11873
11600
|
|
|
11874
11601
|
/**
|
|
11875
|
-
*
|
|
11876
|
-
*
|
|
11877
|
-
* **Details**
|
|
11878
|
-
*
|
|
11879
|
-
* A `Class` is a TypeScript class whose constructor validates its input
|
|
11880
|
-
* against a {@link Struct} schema. Instances are always structurally valid.
|
|
11881
|
-
*
|
|
11882
|
-
* The interface exposes the schema's `fields`, an `identifier` string, and
|
|
11883
|
-
* helpers such as `mapFields`, `annotate`, `check`, and `extend`.
|
|
11602
|
+
* Type-level representation returned by {@link Class}.
|
|
11884
11603
|
*
|
|
11885
11604
|
* @category models
|
|
11886
11605
|
* @since 3.10.0
|
|
@@ -13023,7 +12742,7 @@ export function toFormatter<T>(schema: Schema<T>, options?: {
|
|
|
13023
12742
|
* Use when the default structural equivalence derived by {@link toEquivalence}
|
|
13024
12743
|
* is not appropriate for a type.
|
|
13025
12744
|
*
|
|
13026
|
-
* @category
|
|
12745
|
+
* @category instances
|
|
13027
12746
|
* @since 4.0.0
|
|
13028
12747
|
*/
|
|
13029
12748
|
export function overrideToEquivalence<S extends Top>(toEquivalence: () => Equivalence.Equivalence<S["Type"]>) {
|
|
@@ -13046,7 +12765,7 @@ export function overrideToEquivalence<S extends Top>(toEquivalence: () => Equiva
|
|
|
13046
12765
|
* console.log(eq({ id: 1, name: "Alice" }, { id: 2, name: "Alice" })) // false
|
|
13047
12766
|
* ```
|
|
13048
12767
|
*
|
|
13049
|
-
* @category
|
|
12768
|
+
* @category instances
|
|
13050
12769
|
* @since 4.0.0
|
|
13051
12770
|
*/
|
|
13052
12771
|
export function toEquivalence<T>(schema: Schema<T>): Equivalence.Equivalence<T> {
|
|
@@ -13076,7 +12795,7 @@ export function toRepresentation(schema: Top): SchemaRepresentation.Document {
|
|
|
13076
12795
|
/**
|
|
13077
12796
|
* Options for {@link toJsonSchemaDocument}.
|
|
13078
12797
|
*
|
|
13079
|
-
* @category
|
|
12798
|
+
* @category options
|
|
13080
12799
|
* @since 4.0.0
|
|
13081
12800
|
*/
|
|
13082
12801
|
export interface ToJsonSchemaOptions {
|
|
@@ -13156,7 +12875,7 @@ export interface ToJsonSchemaOptions {
|
|
|
13156
12875
|
* properties and synthesized check descriptions; it does not change the draft
|
|
13157
12876
|
* target.
|
|
13158
12877
|
*
|
|
13159
|
-
* @category
|
|
12878
|
+
* @category converting
|
|
13160
12879
|
* @since 4.0.0
|
|
13161
12880
|
*/
|
|
13162
12881
|
export function toJsonSchemaDocument(schema: Top, options?: ToJsonSchemaOptions): JsonSchema.Document<"draft-2020-12"> {
|
|
@@ -13640,8 +13359,7 @@ export function toIsoFocus<S extends Top>(_: S): Optic_.Iso<S["Iso"], S["Iso"]>
|
|
|
13640
13359
|
}
|
|
13641
13360
|
|
|
13642
13361
|
/**
|
|
13643
|
-
*
|
|
13644
|
-
* `Iso` type parameter and exposes the original `schema`.
|
|
13362
|
+
* Type-level representation returned by {@link overrideToCodecIso}.
|
|
13645
13363
|
*
|
|
13646
13364
|
* @category Optic
|
|
13647
13365
|
* @since 4.0.0
|
|
@@ -13711,7 +13429,7 @@ export function overrideToCodecIso<S extends Top, Iso>(
|
|
|
13711
13429
|
* {@link toCodecJson}), computes RFC 6902 JSON Patch operations between old
|
|
13712
13430
|
* and new values, and can apply patches back to the typed value.
|
|
13713
13431
|
*
|
|
13714
|
-
* @category
|
|
13432
|
+
* @category converting
|
|
13715
13433
|
* @since 4.0.0
|
|
13716
13434
|
*/
|
|
13717
13435
|
export function toDifferJsonPatch<T, E>(schema: Codec<T, E>): Differ<T, JsonPatch.JsonPatch> {
|
|
@@ -13779,7 +13497,7 @@ export function Tree<S extends Top>(node: S) {
|
|
|
13779
13497
|
* readonly record of `string → Json`. For the corresponding schema, see the
|
|
13780
13498
|
* {@link Json} const.
|
|
13781
13499
|
*
|
|
13782
|
-
* @category
|
|
13500
|
+
* @category models
|
|
13783
13501
|
* @since 4.0.0
|
|
13784
13502
|
*/
|
|
13785
13503
|
export type Json = null | number | boolean | string | JsonArray | JsonObject
|
|
@@ -13787,7 +13505,7 @@ export type Json = null | number | boolean | string | JsonArray | JsonObject
|
|
|
13787
13505
|
/**
|
|
13788
13506
|
* A readonly array of {@link Json} values.
|
|
13789
13507
|
*
|
|
13790
|
-
* @category
|
|
13508
|
+
* @category models
|
|
13791
13509
|
* @since 4.0.0
|
|
13792
13510
|
*/
|
|
13793
13511
|
export interface JsonArray extends ReadonlyArray<Json> {}
|
|
@@ -13795,7 +13513,7 @@ export interface JsonArray extends ReadonlyArray<Json> {}
|
|
|
13795
13513
|
/**
|
|
13796
13514
|
* A readonly record whose values are {@link Json} values.
|
|
13797
13515
|
*
|
|
13798
|
-
* @category
|
|
13516
|
+
* @category models
|
|
13799
13517
|
* @since 4.0.0
|
|
13800
13518
|
*/
|
|
13801
13519
|
export interface JsonObject {
|
|
@@ -13814,7 +13532,7 @@ export interface JsonObject {
|
|
|
13814
13532
|
* console.log(result._tag) // "Some"
|
|
13815
13533
|
* ```
|
|
13816
13534
|
*
|
|
13817
|
-
* @category
|
|
13535
|
+
* @category schemas
|
|
13818
13536
|
* @since 4.0.0
|
|
13819
13537
|
*/
|
|
13820
13538
|
export const Json: Codec<Json> = make(AST.Json)
|
|
@@ -13823,7 +13541,7 @@ export const Json: Codec<Json> = make(AST.Json)
|
|
|
13823
13541
|
* Recursive TypeScript type for mutable JSON values: `null`, `number`,
|
|
13824
13542
|
* `boolean`, `string`, mutable arrays, or mutable string-keyed records.
|
|
13825
13543
|
*
|
|
13826
|
-
* @category
|
|
13544
|
+
* @category models
|
|
13827
13545
|
* @since 4.0.0
|
|
13828
13546
|
*/
|
|
13829
13547
|
export type MutableJson = null | number | boolean | string | MutableJsonArray | MutableJsonObject
|
|
@@ -13831,7 +13549,7 @@ export type MutableJson = null | number | boolean | string | MutableJsonArray |
|
|
|
13831
13549
|
/**
|
|
13832
13550
|
* A mutable array of {@link MutableJson} values.
|
|
13833
13551
|
*
|
|
13834
|
-
* @category
|
|
13552
|
+
* @category models
|
|
13835
13553
|
* @since 4.0.0
|
|
13836
13554
|
*/
|
|
13837
13555
|
export interface MutableJsonArray extends Array<MutableJson> {}
|
|
@@ -13839,7 +13557,7 @@ export interface MutableJsonArray extends Array<MutableJson> {}
|
|
|
13839
13557
|
/**
|
|
13840
13558
|
* A mutable record whose values are {@link MutableJson} values.
|
|
13841
13559
|
*
|
|
13842
|
-
* @category
|
|
13560
|
+
* @category models
|
|
13843
13561
|
* @since 4.0.0
|
|
13844
13562
|
*/
|
|
13845
13563
|
export interface MutableJsonObject {
|
|
@@ -13850,7 +13568,7 @@ export interface MutableJsonObject {
|
|
|
13850
13568
|
* Schema that accepts any mutable JSON-compatible value. See {@link Json} for
|
|
13851
13569
|
* the immutable variant.
|
|
13852
13570
|
*
|
|
13853
|
-
* @category
|
|
13571
|
+
* @category schemas
|
|
13854
13572
|
* @since 4.0.0
|
|
13855
13573
|
*/
|
|
13856
13574
|
export const MutableJson: Codec<MutableJson> = make(AST.MutableJson)
|