effect 4.0.0-beta.73 → 4.0.0-beta.74

package/dist/SchemaAST.d.ts

@@ -434,7 +434,7 @@ export type Encoding = readonly [Link, ...Array<Link>];
  * - `concurrency` — maximum number of async parse effects to run concurrently;
  *   defaults to `1`, or use `"unbounded"`.
  *
- * @category models
+ * @category options
  * @since 3.10.0
  */
 export interface ParseOptions {

package/dist/SchemaGetter.d.ts

@@ -907,7 +907,7 @@ type ParseJsonOptions = {
  *
  * @see {@link stringifyJson} for the inverse operation
  *
- * @category Json
+ * @category JSON getters
  * @since 4.0.0
  */
 export declare function parseJson<E extends string>(): Getter<Schema.MutableJson, E>;
@@ -945,7 +945,7 @@ type StringifyJsonOptions = {
  *
  * @see {@link parseJson} for the inverse operation
  *
- * @category Json
+ * @category JSON getters
  * @since 4.0.0
  */
 export declare function stringifyJson(options?: StringifyJsonOptions): Getter<string, unknown>;
@@ -1061,7 +1061,7 @@ export declare function split<E extends string>(options?: {
  * @see {@link decodeBase64String} for the inverse operation to `string`
  * @see {@link encodeBase64Url} for the URL-safe variant
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function encodeBase64<E extends Uint8Array | string>(): Getter<string, E>;
@@ -1084,7 +1084,7 @@ export declare function encodeBase64<E extends Uint8Array | string>(): Getter<st
  * @see {@link decodeBase64UrlString} for the inverse operation to `string`
  * @see {@link encodeBase64} for the standard Base64 variant
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function encodeBase64Url<E extends Uint8Array | string>(): Getter<string, E>;
@@ -1106,7 +1106,7 @@ export declare function encodeBase64Url<E extends Uint8Array | string>(): Getter
  * @see {@link decodeHex} for the inverse operation to `Uint8Array`
  * @see {@link decodeHexString} for the inverse operation to `string`
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export declare function encodeHex<E extends Uint8Array | string>(): Getter<string, E>;
@@ -1129,7 +1129,7 @@ export declare function encodeHex<E extends Uint8Array | string>(): Getter<strin
  * @see {@link decodeBase64String} to decode to `string` instead
  * @see {@link encodeBase64} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function decodeBase64<E extends string>(): Getter<Uint8Array, E>;
@@ -1152,7 +1152,7 @@ export declare function decodeBase64<E extends string>(): Getter<Uint8Array, E>;
  * @see {@link decodeBase64} to decode to `Uint8Array` instead
  * @see {@link encodeBase64} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function decodeBase64String<E extends string>(): Getter<string, E>;
@@ -1175,7 +1175,7 @@ export declare function decodeBase64String<E extends string>(): Getter<string, E
  * @see {@link decodeBase64UrlString} to decode to `string` instead
  * @see {@link encodeBase64Url} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function decodeBase64Url<E extends string>(): Getter<Uint8Array, E>;
@@ -1198,7 +1198,7 @@ export declare function decodeBase64Url<E extends string>(): Getter<Uint8Array,
  * @see {@link decodeBase64Url} to decode to `Uint8Array` instead
  * @see {@link encodeBase64Url} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export declare function decodeBase64UrlString<E extends string>(): Getter<string, E>;
@@ -1221,7 +1221,7 @@ export declare function decodeBase64UrlString<E extends string>(): Getter<string
  * @see {@link decodeHexString} to decode to `string` instead
  * @see {@link encodeHex} for the inverse operation
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export declare function decodeHex<E extends string>(): Getter<Uint8Array, E>;
@@ -1244,7 +1244,7 @@ export declare function decodeHex<E extends string>(): Getter<Uint8Array, E>;
  * @see {@link decodeHex} to decode to `Uint8Array` instead
  * @see {@link encodeHex} for the inverse operation
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export declare function decodeHexString<E extends string>(): Getter<string, E>;
@@ -1410,7 +1410,7 @@ export declare function encodeFormData(): Getter<FormData, unknown>;
  * @see {@link makeTreeRecord} for the underlying bracket-path parser
  * @see {@link decodeFormData} for the FormData variant
  *
- * @category URLSearchParams
+ * @category search params
  * @since 4.0.0
  */
 export declare function decodeURLSearchParams(): Getter<Schema.TreeRecord<string>, URLSearchParams>;
@@ -1440,7 +1440,7 @@ export declare function decodeURLSearchParams(): Getter<Schema.TreeRecord<string
  * @see {@link collectBracketPathEntries} for the underlying flattener
  * @see {@link encodeFormData} for the FormData variant
  *
- * @category URLSearchParams
+ * @category search params
  * @since 4.0.0
  */
 export declare function encodeURLSearchParams(): Getter<URLSearchParams, unknown>;

package/dist/SchemaGetter.js

@@ -905,7 +905,7 @@ export function parseJson(options) {
  *
  * @see {@link parseJson} for the inverse operation
  *
- * @category Json
+ * @category JSON getters
  * @since 4.0.0
  */
 export function stringifyJson(options) {
@@ -1037,7 +1037,7 @@ export function split(options) {
  * @see {@link decodeBase64String} for the inverse operation to `string`
  * @see {@link encodeBase64Url} for the URL-safe variant
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function encodeBase64() {
@@ -1062,7 +1062,7 @@ export function encodeBase64() {
  * @see {@link decodeBase64UrlString} for the inverse operation to `string`
  * @see {@link encodeBase64} for the standard Base64 variant
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function encodeBase64Url() {
@@ -1086,7 +1086,7 @@ export function encodeBase64Url() {
  * @see {@link decodeHex} for the inverse operation to `Uint8Array`
  * @see {@link decodeHexString} for the inverse operation to `string`
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export function encodeHex() {
@@ -1111,7 +1111,7 @@ export function encodeHex() {
  * @see {@link decodeBase64String} to decode to `string` instead
  * @see {@link encodeBase64} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function decodeBase64() {
@@ -1138,7 +1138,7 @@ export function decodeBase64() {
  * @see {@link decodeBase64} to decode to `Uint8Array` instead
  * @see {@link encodeBase64} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function decodeBase64String() {
@@ -1168,7 +1168,7 @@ export function decodeBase64String() {
  * @see {@link decodeBase64UrlString} to decode to `string` instead
  * @see {@link encodeBase64Url} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function decodeBase64Url() {
@@ -1198,7 +1198,7 @@ export function decodeBase64Url() {
  * @see {@link decodeBase64Url} to decode to `Uint8Array` instead
  * @see {@link encodeBase64Url} for the inverse operation
  *
- * @category Base64
+ * @category Base64 getters
  * @since 4.0.0
  */
 export function decodeBase64UrlString() {
@@ -1228,7 +1228,7 @@ export function decodeBase64UrlString() {
  * @see {@link decodeHexString} to decode to `string` instead
  * @see {@link encodeHex} for the inverse operation
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export function decodeHex() {
@@ -1258,7 +1258,7 @@ export function decodeHex() {
  * @see {@link decodeHex} to decode to `Uint8Array` instead
  * @see {@link encodeHex} for the inverse operation
  *
- * @category Hex
+ * @category Hex getters
  * @since 4.0.0
  */
 export function decodeHexString() {
@@ -1466,7 +1466,7 @@ export function encodeFormData() {
  * @see {@link makeTreeRecord} for the underlying bracket-path parser
  * @see {@link decodeFormData} for the FormData variant
  *
- * @category URLSearchParams
+ * @category search params
  * @since 4.0.0
  */
 export function decodeURLSearchParams() {
@@ -1499,7 +1499,7 @@ const collectURLSearchParamsEntries = /*#__PURE__*/collectBracketPathEntries(Pre
  * @see {@link collectBracketPathEntries} for the underlying flattener
  * @see {@link encodeFormData} for the FormData variant
  *
- * @category URLSearchParams
+ * @category search params
  * @since 4.0.0
  */
 export function encodeURLSearchParams() {

package/dist/SchemaParser.d.ts

@@ -19,7 +19,7 @@ import * as Issue from "./SchemaIssue.ts";
  * runs type-side validation unless checks are disabled, and fails with a
  * `SchemaIssue.Issue` when construction fails.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export declare function makeEffect<S extends Schema.Top>(schema: S): (input: S["~type.make.in"], options?: Schema.MakeOptions) => Effect.Effect<S["Type"], Issue.Issue>;
@@ -32,7 +32,7 @@ export declare function makeEffect<S extends Schema.Top>(schema: S): (input: S["
  * Use when you only need to know whether constructor input is valid and do
  * not need error details.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export declare function makeOption<S extends Schema.Top>(schema: S): (input: S["~type.make.in"], options?: Schema.MakeOptions) => Option.Option<S["Type"]>;
@@ -49,7 +49,7 @@ export declare function makeOption<S extends Schema.Top>(schema: S): (input: S["
  * The returned function constructs a value from constructor input and throws an
  * `Error` with the `SchemaIssue.Issue` in its `cause` when construction fails.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export declare function make<S extends Schema.Top>(schema: S): (input: S["~type.make.in"], options?: Schema.MakeOptions) => S["Type"];

package/dist/SchemaParser.js

@@ -95,7 +95,7 @@ const recurDefaults = /*#__PURE__*/memoize(ast => {
  * runs type-side validation unless checks are disabled, and fails with a
  * `SchemaIssue.Issue` when construction fails.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export function makeEffect(schema) {
@@ -119,7 +119,7 @@ export function makeEffect(schema) {
  * Use when you only need to know whether constructor input is valid and do
  * not need error details.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export function makeOption(schema) {
@@ -141,7 +141,7 @@ export function makeOption(schema) {
  * The returned function constructs a value from constructor input and throws an
  * `Error` with the `SchemaIssue.Issue` in its `cause` when construction fails.
  *
- * @category Constructing
+ * @category constructors
  * @since 4.0.0
  */
 export function make(schema) {

package/dist/Scope.d.ts

@@ -247,7 +247,7 @@ export declare namespace State {
  * const scoped = Effect.scoped(program)
  * ```
  *
- * @category tags
+ * @category services
  * @since 2.0.0
  */
 export declare const Scope: Context.Service<Scope, Scope>;

package/dist/Scope.js

@@ -72,7 +72,7 @@ const CloseableTypeId = effect.ScopeCloseableTypeId;
  * const scoped = Effect.scoped(program)
  * ```
  *
- * @category tags
+ * @category services
  * @since 2.0.0
  */
 export const Scope = effect.scopeTag;

package/dist/Sink.d.ts

@@ -494,7 +494,7 @@ export declare const never: Sink<unknown>;
  * instead of being returned to downstream sink composition. This does not
  * continue pulling additional elements from the upstream stream.
  *
- * @category utils
+ * @category filtering
  * @since 2.0.0
  */
 export declare const ignoreLeftover: <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, never, E, R>;
@@ -1493,21 +1493,21 @@ export declare const unwrap: <A, In, L, E, R, R2>(effect: Effect.Effect<Sink<A,
 /**
  * Runs a summary effect when the sink starts and again when it completes.
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export declare const summarized: {
     /**
      * Runs a summary effect when the sink starts and again when it completes.
      *
-     * @category utils
+     * @category mapping
      * @since 2.0.0
      */
     <A2, E2, R2, A3>(summary: Effect.Effect<A2, E2, R2>, f: (start: A2, end: A2) => A3): <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<[A, A3], In, L, E2 | E, R2 | R>;
     /**
      * Runs a summary effect when the sink starts and again when it completes.
      *
-     * @category utils
+     * @category mapping
      * @since 2.0.0
      */
     <A, In, L, E, R, A2, E2, R2, A3>(self: Sink<A, In, L, E, R>, summary: Effect.Effect<A2, E2, R2>, f: (start: A2, end: A2) => A3): Sink<[A, A3], In, L, E | E2, R | R2>;
@@ -1515,7 +1515,7 @@ export declare const summarized: {
 /**
  * Returns the sink that executes this one and times its execution.
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export declare const withDuration: <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<[A, Duration.Duration], In, L, E, R>;

package/dist/Sink.js

@@ -332,7 +332,7 @@ export const never = /*#__PURE__*/fromEffectEnd(Effect.never);
  * instead of being returned to downstream sink composition. This does not
  * continue pulling additional elements from the upstream stream.
  *
- * @category utils
+ * @category filtering
  * @since 2.0.0
  */
 export const ignoreLeftover = self => mapEnd(self, ([a]) => [a]);
@@ -1217,7 +1217,7 @@ export const unwrap = effect => fromChannel(Channel.unwrap(Effect.map(effect, to
 /**
  * Runs a summary effect when the sink starts and again when it completes.
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const summarized = /*#__PURE__*/dual(3, (self, summary, f) => fromTransform(Effect.fnUntraced(function* (upstream, scope) {
@@ -1229,7 +1229,7 @@ export const summarized = /*#__PURE__*/dual(3, (self, summary, f) => fromTransfo
 /**
  * Returns the sink that executes this one and times its execution.
  *
- * @category utils
+ * @category mapping
  * @since 2.0.0
  */
 export const withDuration = self => summarized(self, Clock.currentTimeNanos, (start, end) => Duration.nanos(end - start));