effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/SchemaGetter.ts

@@ -132,7 +132,7 @@ import * as Str from "./String.ts"
  * - {@link passthrough} — identity getter
  * - {@link transformOrFail} — fallible transformation
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Getter<out T, in E, R = never> extends Pipeable.Class {
@@ -188,7 +188,7 @@ export class Getter<out T, in E, R = never> extends Pipeable.Class {
  * - {@link transform} — when you need to use the input value
  * - {@link passthrough} — when you want to keep the input as-is
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function succeed<const T, E>(t: T): Getter<T, E> {
@@ -209,7 +209,7 @@ export function succeed<const T, E>(t: T): Getter<T, E> {
  * **Example** (Always-failing getter)
  *
  * ```ts
- * import { SchemaGetter, SchemaIssue, Option } from "effect"
+ * import { Option, SchemaGetter, SchemaIssue } from "effect"
  *
  * const rejectAll = SchemaGetter.fail<string, string>(
  *   (oe) => new SchemaIssue.InvalidValue(oe, { message: "not allowed" })
@@ -220,7 +220,7 @@ export function succeed<const T, E>(t: T): Getter<T, E> {
  * - {@link forbidden} — convenience for `Forbidden` issues
  * - {@link checkEffect} — fail conditionally based on input value
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function fail<T, E>(f: (oe: Option.Option<E>) => Issue.Issue): Getter<T, E> {
@@ -251,7 +251,7 @@ export function fail<T, E>(f: (oe: Option.Option<E>) => Issue.Issue): Getter<T,
  * See also:
  * - {@link fail} — fail with a custom issue type
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function forbidden<T, E>(message: (oe: Option.Option<E>) => string): Getter<T, E> {
@@ -296,7 +296,7 @@ function isPassthrough<T, E, R>(getter: Getter<T, E, R>): getter is typeof passt
  * - {@link passthroughSubtype} — when `E extends T`
  * - {@link transform} — when you need to change the value
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function passthrough<T, E>(options: { readonly strict: false }): Getter<T, E>
@@ -328,7 +328,7 @@ export function passthrough<T>(): Getter<T, T> {
  * - {@link passthrough} — when types are identical
  * - {@link passthroughSubtype} — when `E extends T`
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function passthroughSupertype<T extends E, E>(): Getter<T, E>
@@ -359,7 +359,7 @@ export function passthroughSupertype<T>(): Getter<T, T> {
  * - {@link passthrough} — when types are identical
  * - {@link passthroughSupertype} — when `T extends E`
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function passthroughSubtype<T, E extends T>(): Getter<T, E>
@@ -382,7 +382,7 @@ export function passthroughSubtype<T>(): Getter<T, T> {
  * **Example** (Default timestamp for missing field)
  *
  * ```ts
- * import { SchemaGetter, Effect, Option } from "effect"
+ * import { Effect, Option, SchemaGetter } from "effect"
  *
  * const withTimestamp = SchemaGetter.onNone<number>(() =>
  *   Effect.succeed(Option.some(Date.now()))
@@ -394,7 +394,7 @@ export function passthroughSubtype<T>(): Getter<T, T> {
  * - {@link withDefault} — simpler default value for undefined inputs
  * - {@link onSome} — handle only present values
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function onNone<T, E extends T = T, R = never>(
@@ -427,7 +427,7 @@ export function onNone<T, E extends T = T, R = never>(
  * - {@link onNone} — provide a fallback instead of failing
  * - {@link withDefault} — substitute a default for undefined values
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function required<T, E extends T = T>(annotations?: Schema.Annotations.Key<T>): Getter<T, E> {
@@ -449,7 +449,7 @@ export function required<T, E extends T = T>(annotations?: Schema.Annotations.Ke
  * **Example** (Transform only present values)
  *
  * ```ts
- * import { SchemaGetter, Effect, Option } from "effect"
+ * import { Effect, Option, SchemaGetter } from "effect"
  *
  * const parseIfPresent = SchemaGetter.onSome<number, string>(
  *   (s) => Effect.succeed(Option.some(Number(s)))
@@ -461,7 +461,7 @@ export function required<T, E extends T = T>(annotations?: Schema.Annotations.Ke
  * - {@link transform} — simpler pure transformation of present values
  * - {@link transformOrFail} — fallible transformation of present values
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function onSome<T, E, R = never>(
@@ -490,7 +490,7 @@ export function onSome<T, E, R = never>(
  * **Example** (Effectful validation)
  *
  * ```ts
- * import { SchemaGetter, Effect } from "effect"
+ * import { Effect, SchemaGetter } from "effect"
  *
  * const nonNegative = SchemaGetter.checkEffect<number>((n) =>
  *   Effect.succeed(n >= 0 ? undefined : "must be non-negative")
@@ -501,7 +501,7 @@ export function onSome<T, E, R = never>(
  * - {@link transform} — when you need to change the value, not just validate
  * - {@link fail} — unconditional failure
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function checkEffect<T, R = never>(
@@ -554,7 +554,7 @@ export function checkEffect<T, R = never>(
  * - {@link transformOptional} — when you need to handle `None` inputs
  * - {@link passthrough} — when no transformation is needed
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function transform<T, E>(f: (e: E) => T): Getter<T, E> {
@@ -576,7 +576,7 @@ export function transform<T, E>(f: (e: E) => T): Getter<T, E> {
  * **Example** (Parsing with failure)
  *
  * ```ts
- * import { SchemaGetter, SchemaIssue, Effect, Option } from "effect"
+ * import { Effect, Option, SchemaGetter, SchemaIssue } from "effect"
  *
  * const safeParseInt = SchemaGetter.transformOrFail<number, string>(
  *   (s) => {
@@ -592,7 +592,7 @@ export function transform<T, E>(f: (e: E) => T): Getter<T, E> {
  * - {@link transform} — when transformation cannot fail
  * - {@link onSome} — when you need full `Option` control over the output
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function transformOrFail<T, E, R = never>(
@@ -615,7 +615,7 @@ export function transformOrFail<T, E, R = never>(
  * **Example** (Filter out empty strings)
  *
  * ```ts
- * import { SchemaGetter, Option } from "effect"
+ * import { Option, SchemaGetter } from "effect"
  *
  * const skipEmpty = SchemaGetter.transformOptional<string, string>((o) =>
  *   Option.filter(o, (s) => s.length > 0)
@@ -626,7 +626,7 @@ export function transformOrFail<T, E, R = never>(
  * - {@link transform} — simpler, only handles present values
  * - {@link omit} — always returns `None`
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function transformOptional<T, E>(f: (oe: Option.Option<E>) => Option.Option<T>): Getter<T, E> {
@@ -655,7 +655,7 @@ export function transformOptional<T, E>(f: (oe: Option.Option<E>) => Option.Opti
  * - {@link transformOptional} — when you want conditional omission
  * - {@link forbidden} — when you want to fail instead of silently omit
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function omit<T>(): Getter<never, T> {
@@ -686,7 +686,7 @@ export function omit<T>(): Getter<never, T> {
  * - {@link onNone} — handle only absent keys (not `undefined` values)
  * - {@link required} — fail instead of providing a default
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function withDefault<T, R = never>(
@@ -1840,7 +1840,7 @@ export function makeTreeRecord<A>(
  * **Example** (Flatten object to bracket paths)
  *
  * ```ts
- * import { SchemaGetter, Predicate } from "effect"
+ * import { Predicate, SchemaGetter } from "effect"
  *
  * const collectStrings = SchemaGetter.collectBracketPathEntries(Predicate.isString)
  * const entries = collectStrings({ user: { name: "Alice", tags: ["admin", "editor"] } })

package/src/SchemaIssue.ts

@@ -117,6 +117,7 @@ const TypeId = "~effect/SchemaIssue/Issue"
  *
  * @see {@link Issue}
  *
+ * @category guards
  * @since 4.0.0
  */
 export function isIssue(u: unknown): u is Issue {
@@ -137,7 +138,7 @@ export function isIssue(u: unknown): u is Issue {
  * @see {@link Issue} — the full union including composite nodes
  * @see {@link LeafHook} — formatter hook that operates on `Leaf` values
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type Leaf =
@@ -169,7 +170,7 @@ export type Leaf =
  * @see {@link isIssue} — type guard
  * @see {@link getActual} — extract the actual value from any issue
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export type Issue =
@@ -219,7 +220,7 @@ class Base {
  * @see {@link Leaf} — terminal issue types that commonly appear as the inner `issue`
  * @see {@link CheckHook} — formatter hook for `Filter` issues
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Filter extends Base {
@@ -277,7 +278,7 @@ export class Filter extends Base {
  * @see {@link Filter} — failure from a refinement check (not a transformation)
  * @see {@link Composite} — multiple issues from a single schema node
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class Encoding extends Base {
@@ -335,8 +336,8 @@ export class Encoding extends Base {
  * @see {@link getActual} — returns `Option.none()` for `Pointer`
  * @see {@link Composite} — groups multiple issues under one schema node
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Pointer extends Base {
   readonly _tag = "Pointer"
@@ -382,7 +383,7 @@ export class Pointer extends Base {
  * @see {@link Pointer} — wraps this issue with the missing key's path
  * @see {@link UnexpectedKey} — the opposite case (extra key present)
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class MissingKey extends Base {
@@ -422,7 +423,7 @@ export class MissingKey extends Base {
  * @see {@link MissingKey} — the opposite case (required key absent)
  * @see {@link Pointer} — wraps this issue with the unexpected key's path
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class UnexpectedKey extends Base {
@@ -471,8 +472,8 @@ export class UnexpectedKey extends Base {
  * @see {@link AnyOf} — used for union no-match errors (similar but different semantics)
  * @see {@link Pointer} — adds path context to individual issues
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Composite extends Base {
   readonly _tag = "Composite"
@@ -544,7 +545,7 @@ export class Composite extends Base {
  *
  * @see {@link InvalidValue} — the input has the right type but fails a value constraint
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class InvalidType extends Base {
@@ -608,7 +609,7 @@ export class InvalidType extends Base {
  * @see {@link InvalidType} — the input has the wrong type entirely
  * @see {@link Filter} — composite wrapper when a schema filter produces this issue
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class InvalidValue extends Base {
@@ -669,8 +670,8 @@ export class InvalidValue extends Base {
  *
  * @see {@link InvalidValue} — for value-constraint failures (not operation failures)
  *
- * @category model
- * @since 4.0.0
+ * @category models
+ * @since 3.10.0
  */
 export class Forbidden extends Base {
   readonly _tag = "Forbidden"
@@ -718,7 +719,7 @@ export class Forbidden extends Base {
  * @see {@link OneOf} — the opposite: *too many* members matched
  * @see {@link Composite} — groups multiple issues under a non-union schema
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class AnyOf extends Base {
@@ -776,7 +777,7 @@ export class AnyOf extends Base {
  *
  * @see {@link AnyOf} — the opposite: *no* members matched
  *
- * @category model
+ * @category models
  * @since 4.0.0
  */
 export class OneOf extends Base {
@@ -847,6 +848,7 @@ export class OneOf extends Base {
  * @see {@link Issue}
  * @see {@link isIssue}
  *
+ * @category getters
  * @since 4.0.0
  */
 export function getActual(issue: Issue): Option.Option<unknown> {

package/src/SchemaParser.ts

@@ -129,7 +129,7 @@ export function make<S extends Schema.Top>(schema: S) {
  * exposing issue details.
  *
  * @category Asserting
- * @since 4.0.0
+ * @since 3.10.0
  */
 export function is<T>(schema: Schema.Schema<T>): <I>(input: I) => input is I & T {
   return _is<T>(schema.ast)
@@ -155,8 +155,7 @@ export function _issue<T>(ast: AST.AST) {
 }
 
 /**
- * Creates an assertion function that narrows an input to the schema's decoded type
- * side.
+ * Asserts that an input satisfies the schema's decoded type side.
  *
  * The assertion returns normally when validation succeeds and throws when the
  * input does not satisfy the schema.
@@ -164,17 +163,15 @@ export function _issue<T>(ast: AST.AST) {
  * @category Asserting
  * @since 4.0.0
  */
-export function asserts<T>(schema: Schema.Schema<T>) {
-  const parser = asExit(run<T, never>(AST.toType(schema.ast)))
-  return <I>(input: I): asserts input is I & T => {
-    const exit = parser(input, AST.defaultParseOptions)
-    if (Exit.isFailure(exit)) {
-      const issue = Cause.findError(exit.cause)
-      if (Result.isFailure(issue)) {
-        throw Cause.squash(issue.failure)
-      }
-      throw new Error(issue.success.toString(), { cause: issue.success })
+export function asserts<S extends Schema.Top, I>(schema: S, input: I): asserts input is I & S["Type"] {
+  const parser = asExit(run<S["Type"], never>(AST.toType(schema.ast)))
+  const exit = parser(input, AST.defaultParseOptions)
+  if (Exit.isFailure(exit)) {
+    const issue = Cause.findError(exit.cause)
+    if (Result.isFailure(issue)) {
+      throw Cause.squash(issue.failure)
     }
+    throw new Error(issue.success.toString(), { cause: issue.success })
   }
 }
 
@@ -186,7 +183,7 @@ export function asserts<T>(schema: Schema.Schema<T>) {
  * `Effect`. Parse options may be provided when creating the decoder and overridden
  * when applying it.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export function decodeUnknownEffect<S extends Schema.Top>(
@@ -207,7 +204,7 @@ export function decodeUnknownEffect<S extends Schema.Top>(
  * `SchemaIssue.Issue`, preserving any decoding service requirements in the
  * returned `Effect`.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export const decodeEffect: <S extends Schema.Top>(
@@ -222,8 +219,8 @@ export const decodeEffect: <S extends Schema.Top>(
  * The returned function resolves with the decoded `Type` on success and rejects
  * with a `SchemaIssue.Issue` on decoding failure.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export function decodeUnknownPromise<S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -239,8 +236,8 @@ export function decodeUnknownPromise<S extends Schema.Decoder<unknown>>(
  * The returned function resolves with the decoded `Type` on success and rejects
  * with a `SchemaIssue.Issue` on decoding failure.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export function decodePromise<S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -255,7 +252,7 @@ export function decodePromise<S extends Schema.Decoder<unknown>>(
  * The returned function produces `Exit.Success` with the decoded `Type` or
  * `Exit.Failure` with a `SchemaIssue.Issue`.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export function decodeUnknownExit<S extends Schema.Decoder<unknown>>(
@@ -272,7 +269,7 @@ export function decodeUnknownExit<S extends Schema.Decoder<unknown>>(
  * The returned function produces `Exit.Success` with the decoded `Type` or
  * `Exit.Failure` with a `SchemaIssue.Issue`.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export const decodeExit: <S extends Schema.Decoder<unknown>>(
@@ -286,8 +283,8 @@ export const decodeExit: <S extends Schema.Decoder<unknown>>(
  * The returned function produces `Option.some` with the decoded `Type` on success
  * or `Option.none` on failure, discarding issue details.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export function decodeUnknownOption<S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -303,8 +300,8 @@ export function decodeUnknownOption<S extends Schema.Decoder<unknown>>(
  * The returned function produces `Option.some` with the decoded `Type` on success
  * or `Option.none` on failure, discarding issue details.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export const decodeOption: <S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -317,7 +314,7 @@ export const decodeOption: <S extends Schema.Decoder<unknown>>(
  * The returned function produces `Result.succeed` with the decoded `Type` on
  * success or `Result.fail` with a `SchemaIssue.Issue` on decoding failure.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export function decodeUnknownResult<S extends Schema.Decoder<unknown>>(
@@ -334,7 +331,7 @@ export function decodeUnknownResult<S extends Schema.Decoder<unknown>>(
  * The returned function produces `Result.succeed` with the decoded `Type` on
  * success or `Result.fail` with a `SchemaIssue.Issue` on decoding failure.
  *
- * @category Decoding
+ * @category decoding
  * @since 4.0.0
  */
 export const decodeResult: <S extends Schema.Decoder<unknown>>(
@@ -348,8 +345,8 @@ export const decodeResult: <S extends Schema.Decoder<unknown>>(
  * The returned function returns the decoded `Type` on success and throws an
  * `Error` with the `SchemaIssue.Issue` in its `cause` on decoding failure.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export function decodeUnknownSync<S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -365,8 +362,8 @@ export function decodeUnknownSync<S extends Schema.Decoder<unknown>>(
  * The returned function returns the decoded `Type` on success and throws an
  * `Error` with the `SchemaIssue.Issue` in its `cause` on decoding failure.
  *
- * @category Decoding
- * @since 4.0.0
+ * @category decoding
+ * @since 3.10.0
  */
 export const decodeSync: <S extends Schema.Decoder<unknown>>(
   schema: S,
@@ -381,7 +378,7 @@ export const decodeSync: <S extends Schema.Decoder<unknown>>(
  * `Effect`. Parse options may be provided when creating the encoder and overridden
  * when applying it.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function encodeUnknownEffect<S extends Schema.Top>(
@@ -402,7 +399,7 @@ export function encodeUnknownEffect<S extends Schema.Top>(
  * `SchemaIssue.Issue`, preserving any encoding service requirements in the
  * returned `Effect`.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export const encodeEffect: <S extends Schema.Top>(
@@ -417,8 +414,8 @@ export const encodeEffect: <S extends Schema.Top>(
  * The returned function resolves with the schema's `Encoded` value on success and
  * rejects with a `SchemaIssue.Issue` on encoding failure.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export const encodeUnknownPromise = <S extends Schema.Encoder<unknown>>(
   schema: S,
@@ -433,8 +430,8 @@ export const encodeUnknownPromise = <S extends Schema.Encoder<unknown>>(
  * The returned function resolves with the schema's `Encoded` value on success and
  * rejects with a `SchemaIssue.Issue` on encoding failure.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export const encodePromise: <S extends Schema.Encoder<unknown>>(
   schema: S,
@@ -447,7 +444,7 @@ export const encodePromise: <S extends Schema.Encoder<unknown>>(
  * The returned function produces `Exit.Success` with the schema's `Encoded` value
  * or `Exit.Failure` with a `SchemaIssue.Issue`.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function encodeUnknownExit<S extends Schema.Encoder<unknown>>(
@@ -464,7 +461,7 @@ export function encodeUnknownExit<S extends Schema.Encoder<unknown>>(
  * The returned function produces `Exit.Success` with the schema's `Encoded` value
  * or `Exit.Failure` with a `SchemaIssue.Issue`.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export const encodeExit: <S extends Schema.Encoder<unknown>>(
@@ -478,8 +475,8 @@ export const encodeExit: <S extends Schema.Encoder<unknown>>(
  * The returned function produces `Option.some` with the schema's `Encoded` value
  * on success or `Option.none` on failure, discarding issue details.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export function encodeUnknownOption<S extends Schema.Encoder<unknown>>(
   schema: S,
@@ -495,8 +492,8 @@ export function encodeUnknownOption<S extends Schema.Encoder<unknown>>(
  * The returned function produces `Option.some` with the schema's `Encoded` value
  * on success or `Option.none` on failure, discarding issue details.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export const encodeOption: <S extends Schema.Encoder<unknown>>(
   schema: S,
@@ -510,7 +507,7 @@ export const encodeOption: <S extends Schema.Encoder<unknown>>(
  * value on success or `Result.fail` with a `SchemaIssue.Issue` on encoding
  * failure.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export function encodeUnknownResult<S extends Schema.Encoder<unknown>>(
@@ -528,7 +525,7 @@ export function encodeUnknownResult<S extends Schema.Encoder<unknown>>(
  * value on success or `Result.fail` with a `SchemaIssue.Issue` on encoding
  * failure.
  *
- * @category Encoding
+ * @category encoding
  * @since 4.0.0
  */
 export const encodeResult: <S extends Schema.Encoder<unknown>>(
@@ -542,8 +539,8 @@ export const encodeResult: <S extends Schema.Encoder<unknown>>(
  * The returned function returns the schema's `Encoded` value on success and throws
  * an `Error` with the `SchemaIssue.Issue` in its `cause` on encoding failure.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export function encodeUnknownSync<S extends Schema.Encoder<unknown>>(
   schema: S,
@@ -559,8 +556,8 @@ export function encodeUnknownSync<S extends Schema.Encoder<unknown>>(
  * The returned function returns the schema's `Encoded` value on success and throws
  * an `Error` with the `SchemaIssue.Issue` in its `cause` on encoding failure.
  *
- * @category Encoding
- * @since 4.0.0
+ * @category encoding
+ * @since 3.10.0
  */
 export const encodeSync: <S extends Schema.Encoder<unknown>>(
   schema: S,