effect 4.0.0 → 4.0.2

package/src/SchemaTransformation.ts

@@ -9,6 +9,7 @@
  * constructors for pure or effectful conversions, and common conversions used
  * by the Schema module.
  *
+ * @stability stable
  * @since 4.0.0
  */
 
@@ -69,6 +70,7 @@ import * as SchemaIssue from "./SchemaIssue.ts"
  *
  * @see {@link Transformation} — value-level bidirectional transformation
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -88,6 +90,7 @@ export interface Middleware<in out T, in out E, RDE, RDT, RET, REE> extends Pipe
 /**
  * Constructs schema middleware from its decode and encode functions.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -172,6 +175,7 @@ const TypeId = "~effect/SchemaTransformation/Transformation"
  * @see {@link transformEffect} — construct from effectful functions
  * @see {@link Middleware} — effect-pipeline-level alternative
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -186,6 +190,7 @@ export interface Transformation<in out T, in out E, RD = never, RE = never> exte
 /**
  * Constructs a bidirectional schema transformation from its decode and encode getters.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -239,6 +244,7 @@ export const Transformation: new<T, E, RD = never, RE = never>(
  * Schema.decodeUnknownSync(schema)("  HELLO  ") // => "hello"
  * ```
  *
+ * @stability stable
  * @category combining
  * @since 4.0.0
  */
@@ -271,6 +277,7 @@ export const composeTransformation: {
    * Schema.decodeUnknownSync(schema)("  HELLO  ") // => "hello"
    * ```
    *
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -303,6 +310,7 @@ export const composeTransformation: {
    * Schema.decodeUnknownSync(schema)("  HELLO  ") // => "hello"
    * ```
    *
+   * @stability stable
    * @category combining
    * @since 4.0.0
    */
@@ -341,6 +349,7 @@ export const composeTransformation: {
  * @see {@link Transformation}
  * @see {@link makeTransformation}
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -378,6 +387,7 @@ export function isTransformation(u: unknown): u is Transformation<any, any, unkn
  * @see {@link transformEffect} — constructor from effectful functions
  * @see {@link Transformation}
  *
+ * @stability stable
  * @category constructors
  * @since 3.10.0
  */
@@ -431,6 +441,7 @@ export const makeTransformation = <T, E, RD = never, RE = never>(options: {
  * @see {@link transformOptional} — for transformations that handle missing keys
  * @see {@link makeTransformation} — for transformations from existing Getters
  *
+ * @stability stable
  * @category transforming
  * @since 3.10.0
  */
@@ -480,6 +491,7 @@ export function transformEffect<T, E, RD = never, RE = never>(options: {
  * @see {@link transformOptional} — for transformations that handle missing keys
  * @see {@link passthrough} — when no conversion is needed
  *
+ * @stability stable
  * @category transforming
  * @since 3.10.0
  */
@@ -533,6 +545,7 @@ export function transform<T, E>(options: {
  * @see {@link optionFromOptionalKey} — built-in for the common optional-key-to-Option pattern
  * @see {@link optionFromOptional} — built-in for optional (undefined) to Option
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -576,6 +589,7 @@ export function transformOptional<T, E>(options: {
  * @see {@link toUpperCase}
  * @see {@link snakeToCamel}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -615,6 +629,7 @@ export function trim(): Transformation<string, string> {
  * @see {@link trim}
  * @see {@link toLowerCase}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -653,6 +668,7 @@ export function snakeToCamel(): Transformation<string, string> {
  * @see {@link toUpperCase}
  * @see {@link trim}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -691,6 +707,7 @@ export function toLowerCase(): Transformation<string, string> {
  * @see {@link toLowerCase}
  * @see {@link trim}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -729,6 +746,7 @@ export function toUpperCase(): Transformation<string, string> {
  * @see {@link uncapitalize}
  * @see {@link toUpperCase}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -767,6 +785,7 @@ export function capitalize(): Transformation<string, string> {
  * @see {@link capitalize}
  * @see {@link toLowerCase}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -810,6 +829,7 @@ export function uncapitalize(): Transformation<string, string> {
  * @see {@link trim}
  * @see {@link snakeToCamel}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -859,6 +879,7 @@ const passthrough_ = new Transformation(
  * @see {@link passthroughSubtype}
  * @see {@link transform}
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -894,6 +915,7 @@ export function passthrough<T>(): Transformation<T, T> {
  * @see {@link passthrough}
  * @see {@link passthroughSubtype}
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -928,6 +950,7 @@ export function passthroughSupertype<T>(): Transformation<T, T> {
  * @see {@link passthrough}
  * @see {@link passthroughSupertype}
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -966,6 +989,7 @@ export function passthroughSubtype<T>(): Transformation<T, T> {
  * @see {@link bigintFromString}
  * @see {@link transform}
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1003,6 +1027,7 @@ export const numberFromString = new Transformation(
  * @see {@link numberFromString}
  * @see {@link transform}
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1039,6 +1064,7 @@ export const bigintFromString = new Transformation(
  * @see {@link dateFromMillis}
  * @see {@link dateTimeUtcFromString}
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1080,6 +1106,7 @@ export const dateFromString: Transformation<globalThis.Date, string> = new Trans
  * @see {@link dateFromString}
  * @see {@link SchemaGetter.dateTimeUtcFromInput}
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1118,6 +1145,7 @@ export const dateFromMillis: Transformation<globalThis.Date, number> = new Trans
  * @see {@link durationFromNanos}
  * @see {@link durationFromMillis}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1168,6 +1196,7 @@ export const durationFromString: Transformation<Duration.Duration, string> = tra
  *
  * @see {@link durationFromMillis}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1214,6 +1243,7 @@ export const durationFromNanos: Transformation<Duration.Duration, bigint> = tran
  *
  * @see {@link durationFromNanos}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1225,6 +1255,7 @@ export const durationFromMillis: Transformation<Duration.Duration, number> = tra
 /**
  * Decodes a string into a `ByteSize` and encodes it as an exact string.
  *
+ * @stability unstable
  * @category transforming
  * @since 4.0.0
  */
@@ -1247,6 +1278,7 @@ export const byteSizeFromString: Transformation<ByteSize.ByteSize, string> = tra
 /**
  * Decodes a non-negative bigint byte count into a `ByteSize`.
  *
+ * @stability unstable
  * @category transforming
  * @since 4.0.0
  */
@@ -1269,6 +1301,7 @@ export const byteSizeFromBigInt: Transformation<ByteSize.ByteSize, bigint> = tra
 /**
  * Decodes a non-negative safe-integer byte count into a `ByteSize`.
  *
+ * @stability unstable
  * @category transforming
  * @since 4.0.0
  */
@@ -1410,6 +1443,7 @@ export const defectFromJson = (options?: ErrorOptions) =>
  *
  * @see {@link optionFromNullishOr}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1452,6 +1486,7 @@ export function optionFromNullOr<T>(): Transformation<Option.Option<T>, T | null
  * @see {@link optionFromOptionalKey}
  * @see {@link optionFromOptional}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1496,6 +1531,7 @@ export function optionFromUndefinedOr<T>(): Transformation<Option.Option<T>, T |
  * @see {@link optionFromNullOr}
  * @see {@link optionFromUndefinedOr}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1546,6 +1582,7 @@ export function optionFromNullishOr<T>(
  * @see {@link optionFromUndefinedOr}
  * @see {@link transformOptional}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1592,6 +1629,7 @@ export function optionFromOptionalKey<T>(): Transformation<Option.Option<T>, T>
  * @see {@link optionFromUndefinedOr}
  * @see {@link transformOptional}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1630,6 +1668,7 @@ export function optionFromOptional<T>(): Transformation<Option.Option<T>, T | un
  * @see {@link numberFromString}
  * @see {@link transformEffect}
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1662,6 +1701,7 @@ export const urlFromString: Transformation<URL, string> = transformEffect<URL, s
  * the string is not a valid `BigDecimal` representation. Encoding returns
  * `BigDecimal.format(bd)`.
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -1712,6 +1752,7 @@ export const bigDecimalFromString: Transformation<BigDecimal.BigDecimal, string>
  * @see {@link fromJsonString}
  * @see `Schema.Uint8ArrayFromBase64` - a ready-made schema wrapping this transformation.
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -1748,6 +1789,7 @@ export const uint8ArrayFromBase64String: Transformation<Uint8Array<ArrayBufferLi
  * @see {@link uint8ArrayFromBase64String}
  * @see `Schema.StringFromBase64` - a ready-made schema wrapping this transformation.
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -1783,6 +1825,7 @@ export const stringFromBase64String: Transformation<string, string> = new Transf
  * @see {@link stringFromBase64String}
  * @see `Schema.StringFromBase64Url` - a ready-made schema wrapping this transformation.
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -1818,6 +1861,7 @@ export const stringFromBase64UrlString: Transformation<string, string> = new Tra
  * @see {@link stringFromBase64String}
  * @see `Schema.StringFromHex` - a ready-made schema wrapping this transformation.
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -1855,6 +1899,7 @@ export const stringFromHexString: Transformation<string, string> = new Transform
  * @see {@link stringFromBase64String}
  * @see `Schema.StringFromUriComponent` - a ready-made schema wrapping this transformation.
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -1894,6 +1939,7 @@ export const stringFromUriComponent: Transformation<string, string> = new Transf
  * @see {@link uint8ArrayFromBase64String}
  * @see {@link fromFormData}
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -1939,6 +1985,7 @@ export function fromJsonString(options?: {
  * @see {@link fromURLSearchParams}
  * @see {@link fromJsonString}
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -1976,6 +2023,7 @@ export const fromFormData = new Transformation<unknown, FormData>(
  * @see {@link fromFormData}
  * @see {@link fromJsonString}
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -2001,6 +2049,7 @@ export const fromURLSearchParams = new Transformation<unknown, URLSearchParams>(
  * @see {@link timeZoneFromString} for IANA or offset string encodings
  * @see {@link timeZoneNamedFromString} for IANA named-zone strings
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -2028,6 +2077,7 @@ export const timeZoneOffsetFromNumber: Transformation<DateTime.TimeZone.Offset,
  *
  * @see {@link timeZoneFromString} for time-zone strings that may be either IANA identifiers or offset strings
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -2069,6 +2119,7 @@ export const timeZoneNamedFromString: Transformation<DateTime.TimeZone.Named, st
  * @see {@link timeZoneNamedFromString} for IANA named-zone strings only
  * @see {@link timeZoneOffsetFromNumber} for fixed-offset zones encoded as numbers
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -2110,6 +2161,7 @@ export const timeZoneFromString: Transformation<DateTime.TimeZone, string> = tra
  * @see {@link dateFromString} for decoding into JavaScript `Date`
  * @see {@link dateTimeZonedFromString} for ISO strings that should preserve zoned date-time information
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -2150,6 +2202,7 @@ export const dateTimeUtcFromString: Transformation<DateTime.Utc, string> = trans
  *
  * @see {@link dateTimeUtcFromString} for date-time strings that should decode to `DateTime.Utc` and encode as UTC ISO strings
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */

package/src/Scope.ts

@@ -7,6 +7,7 @@
  * and `Layer`, while this module is useful when code needs to create, provide,
  * fork, close, or inspect scopes directly.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -39,6 +40,7 @@ const CloseableTypeId = effect.ScopeCloseableTypeId
  * Effect.runSync(program) // => [["sequential", "Empty"], "Closed"]
  * ```
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -68,6 +70,7 @@ export interface Scope {
  * cleanups // => ["Cleanup!"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -94,6 +97,7 @@ export interface Closeable extends Scope {
  * Effect.runSync(program) // => ["Empty", "Closed"]
  * ```
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace State {
@@ -208,6 +212,7 @@ export declare namespace State {
  * cleanups // => ["Cleanup"]
  * ```
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -233,6 +238,7 @@ export const Scope: Context.Service<Scope, Scope> = effect.scopeTag
  * cleanups // => ["Cleanup 2", "Cleanup 1"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -264,6 +270,7 @@ export const make: (finalizerStrategy?: "sequential" | "parallel") => Effect<Clo
  * cleanups // => ["Cleanup"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -303,6 +310,7 @@ export const makeUnsafe: (finalizerStrategy?: "sequential" | "parallel") => Clos
  * events // => ["working", "cleanup"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -341,6 +349,7 @@ export const provide: {
    * events // => ["working", "cleanup"]
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -379,6 +388,7 @@ export const provide: {
    * events // => ["working", "cleanup"]
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -415,6 +425,7 @@ export const provide: {
  * exits // => [Exit.void]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -449,6 +460,7 @@ export const addFinalizerExit: (scope: Scope, finalizer: (exit: Exit<any, any>)
  * events // => ["work", "cleanup 3", "cleanup 2", "cleanup 1"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -482,6 +494,7 @@ export const addFinalizer: (scope: Scope, finalizer: Effect<unknown>) => Effect<
  * cleanups // => ["child", "parent"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -523,6 +536,7 @@ export const fork: (
  * cleanups // => ["child", "parent"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -562,6 +576,7 @@ export const forkUnsafe: (scope: Scope, finalizerStrategy?: "sequential" | "para
  * events // => ["work", "memory", "file", "database"]
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -589,6 +604,7 @@ export const close: <A, E>(self: Closeable, exit: Exit<A, E>) => Effect<void> =
  *
  * @see {@link close} for the usual effectful close operation that always returns an `Effect`
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -613,6 +629,7 @@ export const closeUnsafe: <A, E>(self: Closeable, exit_: Exit<A, E>) => Effect<v
  * @see `provide` for providing a scope without closing it automatically
  * @see `Effect.scoped` for creating and closing a fresh scope around a workflow
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -635,6 +652,7 @@ export const use: {
    * @see `provide` for providing a scope without closing it automatically
    * @see `Effect.scoped` for creating and closing a fresh scope around a workflow
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -657,6 +675,7 @@ export const use: {
    * @see `provide` for providing a scope without closing it automatically
    * @see `Effect.scoped` for creating and closing a fresh scope around a workflow
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */