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

package/src/String.ts

@@ -74,7 +74,7 @@ export const Order: order.Order<string> = order.String
  * ```
  *
  * @category instances
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Equivalence: Equ.Equivalence<string> = Equ.String
 
@@ -444,7 +444,7 @@ export const isNonEmpty = (self: string): boolean => self.length > 0
  * assert.deepStrictEqual(String.length("abc"), 3)
  * ```
  *
- * @category utilities
+ * @category utils
  * @since 2.0.0
  */
 export const length = (self: string): number => self.length
@@ -1691,6 +1691,7 @@ export const snakeCase: (self: string) => string = noCase({
 /**
  * A `Reducer` for concatenating `string`s.
  *
+ * @category concatenating
  * @since 4.0.0
  */
 export const ReducerConcat: Reducer.Reducer<string> = Reducer.make((a, b) => a + b, "")

package/src/Struct.ts

@@ -178,7 +178,7 @@ export type Assign<T, U> = Simplify<keyof T & keyof U extends never ? T & U : Om
  * @see {@link keys} – list all string keys of a struct
  * @see {@link pick} – extract multiple properties into a new struct
  *
- * @category Getters
+ * @category getters
  * @since 2.0.0
  */
 export const get: {
@@ -201,7 +201,7 @@ export const get: {
    * @see {@link keys} – list all string keys of a struct
    * @see {@link pick} – extract multiple properties into a new struct
    *
-   * @category Getters
+   * @category getters
    * @since 2.0.0
    */
   <S extends object, const K extends keyof S>(key: K): (self: S) => S[K]
@@ -224,7 +224,7 @@ export const get: {
    * @see {@link keys} – list all string keys of a struct
    * @see {@link pick} – extract multiple properties into a new struct
    *
-   * @category Getters
+   * @category getters
    * @since 2.0.0
    */
   <S extends object, const K extends keyof S>(self: S, key: K): S[K]
@@ -752,7 +752,7 @@ type EntryEvolved<S, E> = {
  * @see {@link evolve} – transform values only
  * @see {@link evolveKeys} – transform keys only
  *
- * @category Utilities
+ * @category utils
  * @since 4.0.0
  */
 export const evolveEntries: {
@@ -783,7 +783,7 @@ export const evolveEntries: {
    * @see {@link evolve} – transform values only
    * @see {@link evolveKeys} – transform keys only
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <S extends object, E extends EntryEvolver<S>>(e: E): (self: S) => EntryEvolved<S, E>
@@ -814,7 +814,7 @@ export const evolveEntries: {
    * @see {@link evolve} – transform values only
    * @see {@link evolveKeys} – transform keys only
    *
-   * @category Utilities
+   * @category utils
    * @since 4.0.0
    */
   <S extends object, E extends EntryEvolver<S>>(self: S, e: E): EntryEvolved<S, E>
@@ -940,7 +940,7 @@ export const renameKeys: {
  * @see {@link makeOrder} – create an `Order` for structs
  *
  * @category Equivalence
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeEquivalence = Equivalence.Struct
 
@@ -972,7 +972,7 @@ export const makeEquivalence = Equivalence.Struct
  * @see {@link makeEquivalence} – create an `Equivalence` for structs
  *
  * @category Ordering
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const makeOrder = order.Struct
 
@@ -1096,7 +1096,7 @@ export const lambda = <L extends (a: any) => any>(
  * @see {@link mapOmit} – apply a lambda to all keys except selected ones
  * @see {@link evolve} – apply different functions to different keys
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const map: {
@@ -1127,7 +1127,7 @@ export const map: {
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    * @see {@link evolve} – apply different functions to different keys
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <L extends Lambda>(lambda: L): <S extends object>(self: S) => { [K in keyof S]: Apply<L, S[K]> }
@@ -1158,7 +1158,7 @@ export const map: {
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    * @see {@link evolve} – apply different functions to different keys
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <S extends object, L extends Lambda>(self: S, lambda: L): { [K in keyof S]: Apply<L, S[K]> }
@@ -1198,7 +1198,7 @@ export const map: {
  * @see {@link map} – apply a lambda to all keys
  * @see {@link mapOmit} – apply a lambda to all keys except selected ones
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const mapPick: {
@@ -1231,7 +1231,7 @@ export const mapPick: {
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <S extends object, const Keys extends ReadonlyArray<keyof S>, L extends Lambda>(keys: Keys, lambda: L): (
@@ -1266,7 +1266,7 @@ export const mapPick: {
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapOmit} – apply a lambda to all keys except selected ones
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <S extends object, const Keys extends ReadonlyArray<keyof S>, L extends Lambda>(self: S, keys: Keys, lambda: L): { [K in keyof S]: K extends Keys[number] ? Apply<L, S[K]> : S[K] }
@@ -1309,7 +1309,7 @@ export const mapPick: {
  * @see {@link map} – apply a lambda to all keys
  * @see {@link mapPick} – apply a lambda only to selected keys
  *
- * @category Mapping
+ * @category mapping
  * @since 4.0.0
  */
 export const mapOmit: {
@@ -1341,7 +1341,7 @@ export const mapOmit: {
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapPick} – apply a lambda only to selected keys
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <S extends object, const Keys extends ReadonlyArray<keyof S>, L extends Lambda>(keys: Keys, lambda: L): (
@@ -1375,7 +1375,7 @@ export const mapOmit: {
    * @see {@link map} – apply a lambda to all keys
    * @see {@link mapPick} – apply a lambda only to selected keys
    *
-   * @category Mapping
+   * @category mapping
    * @since 4.0.0
    */
   <S extends object, const Keys extends ReadonlyArray<keyof S>, L extends Lambda>(self: S, keys: Keys, lambda: L): { [K in keyof S]: K extends Keys[number] ? S[K] : Apply<L, S[K]> }
@@ -1444,6 +1444,7 @@ function buildStruct<
  *
  * @see {@link makeReducer} – like `makeCombiner` but with an initial value
  *
+ * @category combining
  * @since 4.0.0
  */
 export function makeCombiner<A>(
@@ -1496,6 +1497,7 @@ export function makeCombiner<A>(
  *
  * @see {@link makeCombiner} – like `makeReducer` but without an initial value
  *
+ * @category folding
  * @since 4.0.0
  */
 export function makeReducer<A>(
@@ -1526,7 +1528,7 @@ export function makeReducer<A>(
  * console.log(record) // { a: "value", b: "value" }
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function Record<const Keys extends ReadonlyArray<string | symbol>, Value>(

package/src/SubscriptionRef.ts

@@ -139,7 +139,7 @@ export const make = <A>(value: A): Effect.Effect<SubscriptionRef<A>> =>
  * ```
  *
  * @category changes
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const changes = <A>(self: SubscriptionRef<A>): Stream.Stream<A> => Stream.fromPubSub(self.pubsub)
 
@@ -164,7 +164,7 @@ export const changes = <A>(self: SubscriptionRef<A>): Stream.Stream<A> => Stream
  * ```
  *
  * @category getters
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe = <A>(self: SubscriptionRef<A>): A => self.value
 

package/src/Symbol.ts

@@ -18,10 +18,10 @@ import * as predicate from "./Predicate.ts"
  * **Example** (Checking for symbols)
  *
  * ```ts
- * import { isSymbol } from "effect/Symbol"
+ * import { Symbol } from "effect"
  *
- * console.log(isSymbol(Symbol.for("a"))) // true
- * console.log(isSymbol("a")) // false
+ * console.log(Symbol.isSymbol(globalThis.Symbol.for("a"))) // true
+ * console.log(Symbol.isSymbol("a")) // false
  * ```
  *
  * @category guards

package/src/SynchronizedRef.ts

@@ -84,7 +84,7 @@ export const make = <A>(value: A): Effect.Effect<SynchronizedRef<A>> => Effect.s
  * ref's semaphore.
  *
  * @category getters
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const getUnsafe = <A>(self: SynchronizedRef<A>): A => self.backing.ref.current
 

package/src/Take.ts

@@ -29,7 +29,7 @@ import type * as Pull from "./Pull.ts"
  * Represents one pull result: either a non-empty batch of values, a failure
  * `Exit`, or a successful `Exit` that signals completion with a `Done` value.
  *
- * @category Models
+ * @category models
  * @since 2.0.0
  */
 export type Take<A, E = never, Done = void> = NonEmptyReadonlyArray<A> | Exit.Exit<Done, E>
@@ -38,7 +38,7 @@ export type Take<A, E = never, Done = void> = NonEmptyReadonlyArray<A> | Exit.Ex
  * Converts a `Take` into a `Pull`, succeeding with value batches, failing with
  * failure exits, and translating successful exits into pull completion.
  *
- * @category Conversions
+ * @category converting
  * @since 4.0.0
  */
 export const toPull = <A, E, Done>(take: Take<A, E, Done>): Pull.Pull<NonEmptyReadonlyArray<A>, E, Done> =>

package/src/Terminal.ts

@@ -33,7 +33,7 @@ const TypeId = "~effect/platform/Terminal"
  * A `Terminal` represents a command-line interface which can read input from a
  * user and display messages to a user.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Terminal {
@@ -66,7 +66,7 @@ export interface Terminal {
  * Keyboard key metadata for terminal input, including the key name and
  * modifier state.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Key {
@@ -92,7 +92,7 @@ export interface Key {
  * A terminal input event containing an optional raw character and the parsed
  * key that was pressed.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface UserInput {
@@ -137,7 +137,7 @@ export const isQuitError = (u: unknown): u is QuitError => Predicate.hasProperty
 /**
  * Context service tag for accessing a `Terminal` implementation.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export const Terminal: Context.Service<Terminal, Terminal> = Context.Service("effect/platform/Terminal")
@@ -145,7 +145,7 @@ export const Terminal: Context.Service<Terminal, Terminal> = Context.Service("ef
 /**
  * Creates a Terminal implementation
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (

package/src/Tracer.ts

@@ -95,8 +95,8 @@ export interface EffectPrimitive<X> {
  * **Example** (Creating span statuses)
  *
  * ```ts
- * import type { Tracer } from "effect"
  * import { Exit } from "effect"
+ * import type { Tracer } from "effect"
  *
  * const startTime = 1_000_000_000n
  * const endTime = 1_500_000_000n
@@ -170,7 +170,7 @@ export type AnySpan = Span | ExternalSpan
  * ```
  *
  * @category tags
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const ParentSpanKey = "effect/Tracer/ParentSpan"
 
@@ -203,8 +203,8 @@ export class ParentSpan extends Context.Service<ParentSpan, AnySpan>()(ParentSpa
  * **Example** (Creating an external span value)
  *
  * ```ts
- * import type { Tracer } from "effect"
  * import { Context } from "effect"
+ * import type { Tracer } from "effect"
  *
  * // Create an external span from another tracing system
  * const externalSpan: Tracer.ExternalSpan = {
@@ -237,8 +237,8 @@ export interface ExternalSpan {
  * **Example** (Configuring span options)
  *
  * ```ts
- * import type { Tracer } from "effect"
  * import { Effect } from "effect"
+ * import type { Tracer } from "effect"
  *
  * // Create an effect with span options
  * const options: Tracer.SpanOptions = {
@@ -264,7 +264,7 @@ export interface SpanOptions extends SpanOptionsNoTrace, TraceOptions {}
  * sampling, and the trace level used for filtering.
  *
  * @category models
- * @since 3.1.0
+ * @since 4.0.0
  */
 export interface SpanOptionsNoTrace {
   readonly attributes?: Record<string, unknown> | undefined
@@ -283,7 +283,7 @@ export interface SpanOptionsNoTrace {
  * `captureStackTrace` can disable capture or provide a lazy stack string.
  *
  * @category models
- * @since 3.1.0
+ * @since 4.0.0
  */
 export interface TraceOptions {
   readonly captureStackTrace?: boolean | LazyArg<string | undefined> | undefined
@@ -296,8 +296,8 @@ export interface TraceOptions {
  * **Example** (Configuring span kinds)
  *
  * ```ts
- * import type { Tracer } from "effect"
  * import { Effect } from "effect"
+ * import type { Tracer } from "effect"
  *
  * // Different span kinds for different operations
  * const serverSpan = Effect.withSpan("handle-request", {
@@ -328,8 +328,8 @@ export type SpanKind = "internal" | "server" | "client" | "producer" | "consumer
  * **Example** (Working with spans)
  *
  * ```ts
- * import type { Tracer } from "effect"
  * import { Context, Exit, Option } from "effect"
+ * import type { Tracer } from "effect"
  *
  * const attributes = new Map<string, unknown>()
  * const links: Array<Tracer.SpanLink> = []
@@ -560,7 +560,7 @@ export const TracerKey = "effect/Tracer"
  * ```
  *
  * @category references
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const Tracer: Context.Reference<Tracer> = Context.Reference<Tracer>(TracerKey, {
   defaultValue: () =>