effect 4.0.1 → 4.0.2

package/src/Match.ts

@@ -8,6 +8,7 @@
  * patterns, and common checks such as strings, numbers, records, and class
  * instances.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as internal from "./internal/matcher.ts"
@@ -39,6 +40,7 @@ type ValueTagHandlers<I> = {
 /**
  * Marker used by `Matcher` to distinguish matchers created with `Match.value`.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -77,6 +79,7 @@ export type ValueFlavor = "value"
  * result // => "string: some input"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -118,6 +121,7 @@ export type Matcher<
  * matcher(42) // => "Number: 42"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -170,6 +174,7 @@ export interface TypeMatcher<
  * result // => "User: Alice"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -212,6 +217,7 @@ export interface ValueMatcher<
  * @see {@link When} for positive cases
  * @see {@link Not} for negative cases
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -242,6 +248,7 @@ export type Case = When | Not
  * stringMatcher(42) // => "Got number: 42"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -276,6 +283,7 @@ export interface When {
  * matcher("forbidden") // => "This string is forbidden"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -324,6 +332,7 @@ export interface Not {
  *
  * @see {@link value} for creating a matcher from a specific value.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -351,6 +360,7 @@ export const type: <I>() => Matcher<I, Types.Without<never>, I, never, never> =
  * format("status", "a") // => "status: A"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -398,6 +408,7 @@ export const fn: <Args extends Array<any>, I>(
  *
  * @see {@link type} for creating a matcher from a specific type.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -431,6 +442,7 @@ export const value: <const I>(
  * message // => "Success: Hello"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -461,6 +473,7 @@ export const valueTags: {
    * message // => "Success: Hello"
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 4.0.0
    */
@@ -496,6 +509,7 @@ export const valueTags: {
    * message // => "Success: Hello"
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 4.0.0
    */
@@ -547,6 +561,7 @@ export const valueTags: {
  * processResult({ _tag: "Loading" }) // => { type: "pending" }
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -591,6 +606,7 @@ export const typeTags: {
    * processResult({ _tag: "Loading" }) // => { type: "pending" }
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 4.0.0
    */
@@ -643,6 +659,7 @@ export const typeTags: {
    * processResult({ _tag: "Loading" }) // => { type: "pending" }
    * ```
    *
+   * @stability stable
    * @category constructors
    * @since 4.0.0
    */
@@ -686,6 +703,7 @@ export const typeTags: {
  * )
  * ```
  *
+ * @stability stable
  * @category utility types
  * @since 4.0.0
  */
@@ -739,6 +757,7 @@ export const withReturnType: <Ret>() => <I, F, R, A, Pr, _, Args extends Array<a
  * @see {@link not} for handling inputs that do not match a pattern
  * @see {@link orElse} for providing a fallback when no pattern case matches
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -801,6 +820,7 @@ export const when: <
  * handleError({ _tag: "ValidationError", field: "email" }) // => "Invalid field: email"
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -859,6 +879,7 @@ export const whenOr: <
  * checkUser({ age: 20, role: "user" }) // => "Access denied"
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -920,6 +941,7 @@ export const whenAnd: <
  * @see {@link discriminators} for defining several discriminator handlers at once
  * @see {@link discriminatorStartsWith} for matching string discriminator values by prefix
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -971,6 +993,7 @@ export const discriminator: <D extends string>(
  *
  * @see {@link discriminator} for matching exact discriminator values
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1034,6 +1057,7 @@ export const discriminatorStartsWith: <D extends string>(
  * @see {@link discriminator} for adding one discriminator case to a matcher pipeline
  * @see {@link discriminatorsExhaustive} for handling every discriminator value and finalizing the matcher
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1097,6 +1121,7 @@ export const discriminators: <D extends string>(
  *
  * @see {@link discriminators} for defining discriminator handlers without finalizing the matcher
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1154,6 +1179,7 @@ export const discriminatorsExhaustive: <D extends string>(
  * match({ _tag: "error", error: new Error("Oops!") }) // => "Error: Oops!"
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1204,6 +1230,7 @@ export const tag: <
  * match({ _tag: "A.A" }) // => 1
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1259,6 +1286,7 @@ export const tagStartsWith: <
  * match({ _tag: "A", a: "ok" }) // => "ok"
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1314,6 +1342,7 @@ export const tags: <
  * match({ _tag: "B", b: 42 }) // => 42
  * ```
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1363,6 +1392,7 @@ export const tagsExhaustive: <
  *
  * @see {@link when} for adding a positive pattern case
  *
+ * @stability stable
  * @category defining patterns
  * @since 4.0.0
  */
@@ -1419,6 +1449,7 @@ export const not: <
  *
  * @see {@link string} for matching any string
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1460,6 +1491,7 @@ export const nonEmptyString: SafeRefinement<string, never> = internal.nonEmptySt
  * handleStatus("pending") // => "Unknown status: pending"
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1492,6 +1524,7 @@ export const is: <
  * processValue(true) // => "Boolean: yes"
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1533,6 +1566,7 @@ export const string: Predicate.Refinement<unknown, string> = Predicate.isString
  *
  * @see {@link bigint} for matching primitive bigint values
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1582,6 +1616,7 @@ export const number: Predicate.Refinement<unknown, number> = Predicate.isNumber
  * @see {@link defined} for matching only non-nullish values
  * @see {@link orElse} for providing a fallback after earlier cases
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1625,6 +1660,7 @@ export const any: SafeRefinement<unknown, any> = internal.any
  *
  * @see {@link any} for matching every value without excluding nullish inputs
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1666,6 +1702,7 @@ export const defined: <A>(u: A) => u is A & {} = internal.defined
  *
  * @see {@link is} for matching specific literal boolean values
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1688,6 +1725,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
+   * @stability stable
    * @category guards
    * @since 4.0.0
    */
@@ -1711,6 +1749,7 @@ export {
    * @see {@link defined} for matching non-nullish values
    * @see {@link is} for matching literal values
    *
+   * @stability stable
    * @category guards
    * @since 4.0.0
    */
@@ -1753,6 +1792,7 @@ export {
  *
  * @see {@link number} for matching primitive number values
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1791,6 +1831,7 @@ export const bigint: Predicate.Refinement<unknown, bigint> = Predicate.isBigInt
  * handleSymbol("string") // => "Not a symbol"
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1833,6 +1874,7 @@ export const symbol: Predicate.Refinement<unknown, symbol> = Predicate.isSymbol
  *
  * @see {@link instanceOf} for matching instances of any constructor
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1878,6 +1920,7 @@ export const date: Predicate.Refinement<unknown, Date> = Predicate.isDate
  *
  * @see {@link instanceOf} for matching a specific constructor
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1937,6 +1980,7 @@ export const record: Predicate.Refinement<unknown, { [x: PropertyKey]: unknown }
  * @see {@link instanceOfUnsafe} for constructor matching without the same type-safety guarantee
  * @see {@link record} for matching broad non-null, non-array objects
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1982,6 +2026,7 @@ export const instanceOf: <A extends abstract new(...args: any) => any>(
  *
  * @see {@link instanceOf} for type-safe constructor matching
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -2025,6 +2070,7 @@ export const instanceOfUnsafe: <A extends abstract new(...args: any) => any>(
  * @see {@link result} for returning unmatched input as a `Result` failure
  * @see {@link orElseAbsurd} for finalizing when unmatched input should be impossible
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2077,6 +2123,7 @@ export const orElse: <RA, Ret, Args extends Array<any>, F extends (_: RA, ...arg
  * @see {@link exhaustive} for compile-time exhaustive matcher finalization
  * @see {@link orElse} for providing a fallback for unmatched input
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2119,6 +2166,7 @@ export const orElseAbsurd: <I, R, RA, A, Pr, Ret, Args extends Array<any>>(
  * getRole({ role: "viewer" })._tag // => "Failure"
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2168,6 +2216,7 @@ export const result: <I, F, R, A, Pr, Ret, Args extends Array<any>>(
  * @see {@link result} for preserving unmatched input as a `Result` failure
  * @see {@link orElse} for replacing unmatched input with a fallback value
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2206,6 +2255,7 @@ export const option: <I, F, R, A, Pr, Ret, Args extends Array<any>>(
  * )
  * ```
  *
+ * @stability stable
  * @category completion
  * @since 4.0.0
  */
@@ -2244,6 +2294,7 @@ const SafeRefinementId = "~effect/Match/SafeRefinement"
  * processValue(null) // => "Undefined or null"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -2264,6 +2315,7 @@ type Fail = typeof Fail
  * application. These types enable the sophisticated type inference that makes
  * pattern matching both type-safe and ergonomic.
  *
+ * @stability stable
  * @since 4.0.0
  */
 export declare namespace Types {