effect 4.0.0 → 4.0.2

package/src/Boolean.ts

@@ -6,6 +6,7 @@
  * logical operations, checking collections with `every` or `some`, ordering
  * booleans, and reducing boolean values.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Equ from "./Equivalence.ts"
@@ -39,6 +40,7 @@ import * as Reducer from "./Reducer.ts"
  * Boolean.Boolean(0) // => false
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -60,6 +62,7 @@ export const Boolean = globalThis.Boolean
  * Boolean.isBoolean("true") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -83,6 +86,7 @@ export const isBoolean: (input: unknown) => input is boolean = predicate.isBoole
  * }) // => "It's true!"
  * ```
  *
+ * @stability stable
  * @category pattern matching
  * @since 2.0.0
  */
@@ -105,6 +109,7 @@ export const match: {
    * }) // => "It's true!"
    * ```
    *
+   * @stability stable
    * @category pattern matching
    * @since 2.0.0
    */
@@ -132,6 +137,7 @@ export const match: {
    * }) // => "It's true!"
    * ```
    *
+   * @stability stable
    * @category pattern matching
    * @since 2.0.0
    */
@@ -166,6 +172,7 @@ export const match: {
  * Boolean.Order(true, true) // => 0
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -188,6 +195,7 @@ export const Order: order.Order<boolean> = order.Boolean
  * Boolean.Equivalence(true, false) // => false
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 2.0.0
  */
@@ -209,6 +217,7 @@ export const Equivalence: Equ.Equivalence<boolean> = Equ.Boolean
  * Boolean.not(false) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -236,6 +245,7 @@ export const not = (self: boolean): boolean => !self
  * Boolean.and(false, false) // => false
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -262,6 +272,7 @@ export const and: {
    * Boolean.and(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -288,6 +299,7 @@ export const and: {
    * Boolean.and(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -312,6 +324,7 @@ export const and: {
  * Boolean.nand(false, false) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -334,6 +347,7 @@ export const nand: {
    * Boolean.nand(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -356,6 +370,7 @@ export const nand: {
    * Boolean.nand(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -380,6 +395,7 @@ export const nand: {
  * Boolean.or(false, false) // => false
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -402,6 +418,7 @@ export const or: {
    * Boolean.or(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -424,6 +441,7 @@ export const or: {
    * Boolean.or(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -448,6 +466,7 @@ export const or: {
  * Boolean.nor(false, false) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -470,6 +489,7 @@ export const nor: {
    * Boolean.nor(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -492,6 +512,7 @@ export const nor: {
    * Boolean.nor(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -516,6 +537,7 @@ export const nor: {
  * Boolean.xor(false, false) // => false
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -538,6 +560,7 @@ export const xor: {
    * Boolean.xor(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -560,6 +583,7 @@ export const xor: {
    * Boolean.xor(false, false) // => false
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -584,6 +608,7 @@ export const xor: {
  * Boolean.eqv(false, false) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -606,6 +631,7 @@ export const eqv: {
    * Boolean.eqv(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -628,6 +654,7 @@ export const eqv: {
    * Boolean.eqv(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -652,6 +679,7 @@ export const eqv: {
  * Boolean.implies(false, false) // => true
  * ```
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -674,6 +702,7 @@ export const implies: {
    * Boolean.implies(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -696,6 +725,7 @@ export const implies: {
    * Boolean.implies(false, false) // => true
    * ```
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -721,6 +751,7 @@ export const implies: {
  * @see {@link some} for checking whether at least one value is `true`
  * @see {@link ReducerAnd} for reducing booleans with AND through a `Reducer`
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -752,6 +783,7 @@ export const every = (collection: Iterable<boolean>): boolean => {
  * @see {@link every} for checking whether all values are `true`
  * @see {@link ReducerOr} for reducing booleans with OR through a `Reducer`
  *
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -784,6 +816,7 @@ export const some = (collection: Iterable<boolean>): boolean => {
  * @see {@link ReducerOr} for reducing with OR semantics
  * @see {@link every} for checking an iterable directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */
@@ -804,6 +837,7 @@ export const ReducerAnd: Reducer.Reducer<boolean> = Reducer.make((a, b) => a &&
  * @see {@link ReducerAnd} for reducing with AND semantics
  * @see {@link some} for checking an iterable directly
  *
+ * @stability stable
  * @category math
  * @since 4.0.0
  */

package/src/Brand.ts

@@ -5,6 +5,7 @@
  * information lives in the type system unless you choose a validating
  * constructor.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Arr from "./Array.ts"
@@ -29,6 +30,7 @@ const TypeId = "~effect/Brand"
  * @see {@link Branded} for applying a brand key to a base type
  * @see {@link Constructor} for validating or constructing branded values
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -53,6 +55,7 @@ export interface Brand<in out Keys extends string> {
  * @see {@link check} for creating a constructor from schema checks
  * @see {@link all} for combining brand constructors
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -100,6 +103,7 @@ export interface Constructor<in out B extends Brand<any>> {
  * `BrandError` is an error-like model with `_tag`, `name`, `message`, and
  * `toString`; it does not extend JavaScript `Error`.
  *
+ * @stability stable
  * @category errors
  * @since 4.0.0
  */
@@ -147,6 +151,7 @@ export class BrandError {
  * Namespace containing type-level helpers for working with branded types and
  * brand constructors.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Brand {
@@ -205,6 +210,7 @@ export declare namespace Brand {
 /**
  * A type alias for creating branded types more concisely.
  *
+ * @stability stable
  * @category utility types
  * @since 2.0.0
  */
@@ -222,6 +228,7 @@ export type Branded<A, Key extends string> = A & Brand<Key>
  * @see {@link make} for constructing branded values with validation.
  * @see {@link check} for constructing branded values from schema checks.
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -243,6 +250,7 @@ export function nominal<A extends Brand<any>>(): Constructor<A> {
  *
  * @see {@link nominal} for a brand constructor that performs no validation.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -268,6 +276,7 @@ export function make<A extends Brand<any>>(
  *
  * @see {@link nominal} for a brand constructor without runtime validation
  * @see {@link all} for combining multiple brand constructors
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -302,6 +311,7 @@ export function check<A extends Brand<any>>(
  * constructor succeeds only when all checks pass. If no runtime checks are
  * present, it behaves as a nominal constructor.
  *
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */