effect 4.0.0-beta.82 → 4.0.0-beta.84

package/dist/SchemaTransformation.d.ts

@@ -371,7 +371,7 @@ export declare function trim(): Transformation<string, string>;
  * Encoding converts values such as `"myFieldName"` back to `"my_field_name"`.
  * The transformation is round-trippable for standard snake_case and camelCase.
  *
- * **Example** (Snake to camel conversion)
+ * **Example** (Converting snake case to camel case)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -603,7 +603,7 @@ export declare function passthrough<T>(): Transformation<T, T>;
  * Both decode and encode are no-ops and return a shared singleton
  * transformation.
  *
- * **Example** (Supertype passthrough)
+ * **Example** (Passing through supertypes)
  *
  * ```ts
  * import { SchemaTransformation } from "effect"
@@ -632,7 +632,7 @@ export declare function passthroughSupertype<T extends E, E>(): Transformation<T
  * - Both decode and encode are no-ops (same as {@link passthrough}).
  * - Returns a shared singleton instance.
  *
- * **Example** (Subtype passthrough)
+ * **Example** (Passing through subtypes)
  *
  * ```ts
  * import { SchemaTransformation } from "effect"
@@ -663,7 +663,7 @@ export declare function passthroughSubtype<T, E extends T>(): Transformation<T,
  * result is finite; combine with `Schema.Finite` or `Schema.Int` for stricter
  * checks.
  *
- * **Example** (Number from string)
+ * **Example** (Converting a string to a number)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -695,7 +695,7 @@ export declare const numberFromString: Transformation<number, string, never, nev
  * the bigint to a string like `String(n)`. Decoding fails if the string is not
  * a valid bigint representation.
  *
- * **Example** (BigInt from string)
+ * **Example** (Converting a string to a BigInt)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -726,7 +726,7 @@ export declare const bigintFromString: Transformation<bigint, string, never, nev
  * converts the `Date` to an ISO string like `date.toISOString()`, returning
  * `"Invalid Date"` for invalid dates.
  *
- * **Example** (Date from string)
+ * **Example** (Converting a string to a Date)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -759,7 +759,7 @@ export declare const dateFromString: Transformation<globalThis.Date, string>;
  * producing strings such as `"2000 millis"` or `"10 nanos"` that round-trip
  * through the parser.
  *
- * **Example** (Duration from string)
+ * **Example** (Converting a string to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -791,7 +791,7 @@ export declare const durationFromString: Transformation<Duration.Duration, strin
  * fails with `InvalidValue` if the `Duration` cannot be represented as a
  * `bigint`, such as `Duration.infinity`.
  *
- * **Example** (Duration from nanoseconds)
+ * **Example** (Converting nanoseconds to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -821,7 +821,7 @@ export declare const durationFromNanos: Transformation<Duration.Duration, bigint
  * Decode creates a duration from the number, and encode returns the duration
  * length in milliseconds.
  *
- * **Example** (Duration from milliseconds)
+ * **Example** (Converting milliseconds to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -852,7 +852,7 @@ export declare const durationFromMillis: Transformation<Duration.Duration, numbe
  * `Option.some(value)`. Encoding maps `Option.none()` to `null` and
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from nullable)
+ * **Example** (Converting nullable values to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -886,7 +886,7 @@ export declare function optionFromNullOr<T>(): Transformation<Option.Option<T>,
  * `Option.some(value)`. Encoding maps `Option.none()` to `undefined` and
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from undefined-or)
+ * **Example** (Converting undefined-or values to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -923,7 +923,7 @@ export declare function optionFromUndefinedOr<T>(): Transformation<Option.Option
  * `undefined` according to `options.onNoneEncoding`, and maps
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from nullish, encoding None as null)
+ * **Example** (Converting nullish values to an Option and encoding None as null)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -961,7 +961,7 @@ export declare function optionFromNullishOr<T>(options?: {
  * the key, and maps `Some(Some(v))` to `Some(v)`. This uses
  * `transformOptional` under the hood.
  *
- * **Example** (Optional key to Option)
+ * **Example** (Converting an optional key to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1000,7 +1000,7 @@ export declare function optionFromOptionalKey<T>(): Transformation<Option.Option
  * value, and maps `Some(Some(v))` to `Some(v)`. This uses
  * `transformOptional` under the hood and filters out `undefined` on decode.
  *
- * **Example** (Optional value to Option)
+ * **Example** (Converting an optional value to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1037,7 +1037,7 @@ export declare function optionFromOptional<T>(): Transformation<Option.Option<T>
  * Decoding calls `new URL(s)` and fails with `InvalidValue` if the string is
  * not a valid URL. Encoding returns `url.href`.
  *
- * **Example** (URL from string)
+ * **Example** (Converting a string to a URL)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1087,7 +1087,7 @@ export declare const bigDecimalFromString: Transformation<BigDecimal.BigDecimal,
  * Decoding parses the Base64 string into bytes. Encoding writes the byte array
  * as a Base64 string.
  *
- * **Example** (Uint8Array from Base64)
+ * **Example** (Converting Base64 to a Uint8Array)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1118,7 +1118,7 @@ export declare const uint8ArrayFromBase64String: Transformation<Uint8Array<Array
  * Decoding parses the Base64 string into a UTF-8 string. Encoding writes the
  * string as a Base64 string.
  *
- * **Example** (String from Base64)
+ * **Example** (Converting Base64 to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1148,7 +1148,7 @@ export declare const stringFromBase64String: Transformation<string, string>;
  * Decoding parses the Base64 URL string into a UTF-8 string. Encoding writes
  * the string as a Base64 URL string.
  *
- * **Example** (String from Base64Url)
+ * **Example** (Converting Base64Url to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1178,7 +1178,7 @@ export declare const stringFromBase64UrlString: Transformation<string, string>;
  * Decoding parses the hex string into a UTF-8 string. Encoding writes the
  * string as a hex string.
  *
- * **Example** (String from Hex)
+ * **Example** (Converting hex to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1210,7 +1210,7 @@ export declare const stringFromHexString: Transformation<string, string>;
  * Decoding calls `decodeURIComponent` and fails if the input contains malformed
  * percent-encoding sequences. Encoding calls `encodeURIComponent`.
  *
- * **Example** (URI component schema)
+ * **Example** (Defining a URI component schema)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"

package/dist/SchemaTransformation.js

@@ -387,7 +387,7 @@ export function trim() {
  * Encoding converts values such as `"myFieldName"` back to `"my_field_name"`.
  * The transformation is round-trippable for standard snake_case and camelCase.
  *
- * **Example** (Snake to camel conversion)
+ * **Example** (Converting snake case to camel case)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -603,7 +603,7 @@ export function passthroughSubtype() {
  * result is finite; combine with `Schema.Finite` or `Schema.Int` for stricter
  * checks.
  *
- * **Example** (Number from string)
+ * **Example** (Converting a string to a number)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -635,7 +635,7 @@ export const numberFromString = /*#__PURE__*/new Transformation(/*#__PURE__*/Sch
  * the bigint to a string like `String(n)`. Decoding fails if the string is not
  * a valid bigint representation.
  *
- * **Example** (BigInt from string)
+ * **Example** (Converting a string to a BigInt)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -666,7 +666,7 @@ export const bigintFromString = /*#__PURE__*/new Transformation(/*#__PURE__*/Sch
  * converts the `Date` to an ISO string like `date.toISOString()`, returning
  * `"Invalid Date"` for invalid dates.
  *
- * **Example** (Date from string)
+ * **Example** (Converting a string to a Date)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -699,7 +699,7 @@ export const dateFromString = /*#__PURE__*/new Transformation(/*#__PURE__*/Schem
  * producing strings such as `"2000 millis"` or `"10 nanos"` that round-trip
  * through the parser.
  *
- * **Example** (Duration from string)
+ * **Example** (Converting a string to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -739,7 +739,7 @@ export const durationFromString = /*#__PURE__*/transformOrFail({
  * fails with `InvalidValue` if the `Duration` cannot be represented as a
  * `bigint`, such as `Duration.infinity`.
  *
- * **Example** (Duration from nanoseconds)
+ * **Example** (Converting nanoseconds to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -777,7 +777,7 @@ export const durationFromNanos = /*#__PURE__*/transformOrFail({
  * Decode creates a duration from the number, and encode returns the duration
  * length in milliseconds.
  *
- * **Example** (Duration from milliseconds)
+ * **Example** (Converting milliseconds to a Duration)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -869,7 +869,7 @@ export const defectFromJson = options => transform({
  * `Option.some(value)`. Encoding maps `Option.none()` to `null` and
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from nullable)
+ * **Example** (Converting nullable values to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -908,7 +908,7 @@ export function optionFromNullOr() {
  * `Option.some(value)`. Encoding maps `Option.none()` to `undefined` and
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from undefined-or)
+ * **Example** (Converting undefined-or values to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -950,7 +950,7 @@ export function optionFromUndefinedOr() {
  * `undefined` according to `options.onNoneEncoding`, and maps
  * `Option.some(value)` to `value`. The transformation is pure and synchronous.
  *
- * **Example** (Option from nullish, encoding None as null)
+ * **Example** (Converting nullish values to an Option and encoding None as null)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -991,7 +991,7 @@ export function optionFromNullishOr(options) {
  * the key, and maps `Some(Some(v))` to `Some(v)`. This uses
  * `transformOptional` under the hood.
  *
- * **Example** (Optional key to Option)
+ * **Example** (Converting an optional key to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1035,7 +1035,7 @@ export function optionFromOptionalKey() {
  * value, and maps `Some(Some(v))` to `Some(v)`. This uses
  * `transformOptional` under the hood and filters out `undefined` on decode.
  *
- * **Example** (Optional value to Option)
+ * **Example** (Converting an optional value to an Option)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1077,7 +1077,7 @@ export function optionFromOptional() {
  * Decoding calls `new URL(s)` and fails with `InvalidValue` if the string is
  * not a valid URL. Encoding returns `url.href`.
  *
- * **Example** (URL from string)
+ * **Example** (Converting a string to a URL)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1143,7 +1143,7 @@ export const bigDecimalFromString = /*#__PURE__*/transformOrFail({
  * Decoding parses the Base64 string into bytes. Encoding writes the byte array
  * as a Base64 string.
  *
- * **Example** (Uint8Array from Base64)
+ * **Example** (Converting Base64 to a Uint8Array)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1174,7 +1174,7 @@ export const uint8ArrayFromBase64String = /*#__PURE__*/new Transformation(/*#__P
  * Decoding parses the Base64 string into a UTF-8 string. Encoding writes the
  * string as a Base64 string.
  *
- * **Example** (String from Base64)
+ * **Example** (Converting Base64 to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1204,7 +1204,7 @@ export const stringFromBase64String = /*#__PURE__*/new Transformation(/*#__PURE_
  * Decoding parses the Base64 URL string into a UTF-8 string. Encoding writes
  * the string as a Base64 URL string.
  *
- * **Example** (String from Base64Url)
+ * **Example** (Converting Base64Url to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1234,7 +1234,7 @@ export const stringFromBase64UrlString = /*#__PURE__*/new Transformation(/*#__PU
  * Decoding parses the hex string into a UTF-8 string. Encoding writes the
  * string as a hex string.
  *
- * **Example** (String from Hex)
+ * **Example** (Converting hex to a string)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"
@@ -1266,7 +1266,7 @@ export const stringFromHexString = /*#__PURE__*/new Transformation(/*#__PURE__*/
  * Decoding calls `decodeURIComponent` and fails if the input contains malformed
  * percent-encoding sequences. Encoding calls `encodeURIComponent`.
  *
- * **Example** (URI component schema)
+ * **Example** (Defining a URI component schema)
  *
  * ```ts
  * import { Schema, SchemaTransformation } from "effect"

package/dist/Stream.d.ts

@@ -2440,7 +2440,7 @@ export declare const tapSink: {
  * multiple inner streams may run at the same time and their outputs are merged
  * as they arrive.
  *
- * **Example** (FlatMapping stream values)
+ * **Example** (Flat mapping stream values)
  *
  * ```ts
  * import { Console, Effect, Stream } from "effect"
@@ -2471,7 +2471,7 @@ export declare const flatMap: {
      * multiple inner streams may run at the same time and their outputs are merged
      * as they arrive.
      *
-     * **Example** (FlatMapping stream values)
+     * **Example** (Flat mapping stream values)
      *
      * ```ts
      * import { Console, Effect, Stream } from "effect"
@@ -2505,7 +2505,7 @@ export declare const flatMap: {
      * multiple inner streams may run at the same time and their outputs are merged
      * as they arrive.
      *
-     * **Example** (FlatMapping stream values)
+     * **Example** (Flat mapping stream values)
      *
      * ```ts
      * import { Console, Effect, Stream } from "effect"

package/dist/Stream.js

@@ -1817,7 +1817,7 @@ export const tapSink = /*#__PURE__*/dual(2, (self, sink) => transformPullBracket
  * multiple inner streams may run at the same time and their outputs are merged
  * as they arrive.
  *
- * **Example** (FlatMapping stream values)
+ * **Example** (Flat mapping stream values)
  *
  * ```ts
  * import { Console, Effect, Stream } from "effect"
@@ -7383,7 +7383,7 @@ export const runForEachWhile = /*#__PURE__*/dual(2, (self, f) => Channel.runForE
       i++;
       if (!b) done = true;
     }
-  }), () => done);
+  }), () => !done);
 }));
 /**
  * Consumes the stream in chunks, passing each non-empty array to the callback.