effect 4.0.0 → 4.0.2

package/src/Predicate.ts

@@ -7,6 +7,7 @@
  * property and tag checks, tuple and struct checks, boolean combinators, and
  * helpers for composing predicates and refinements.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import { dual } from "./Function.ts"
@@ -40,6 +41,7 @@ import type { TupleOf, TupleOfAtLeast } from "./Types.ts"
  * @see {@link Refinement}
  * @see {@link mapInput}
  * @see {@link and}
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -73,6 +75,7 @@ export interface Predicate<in A> {
  * ```
  *
  * @see {@link Predicate}
+ * @stability stable
  * @category utility types
  * @since 2.0.0
  */
@@ -110,6 +113,7 @@ export interface PredicateTypeLambda extends TypeLambda {
  * @see {@link Predicate}
  * @see {@link compose}
  * @see {@link isString}
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -143,6 +147,7 @@ export interface Refinement<in A, out B extends A> {
  *
  * @see {@link Predicate}
  * @see {@link Refinement}
+ * @stability stable
  * @since 3.6.0
  */
 export declare namespace Predicate {
@@ -233,6 +238,7 @@ export declare namespace Predicate {
  *
  * @see {@link Refinement}
  * @see {@link Predicate}
+ * @stability stable
  * @since 3.6.0
  */
 export declare namespace Refinement {
@@ -354,6 +360,7 @@ export declare namespace Refinement {
  * @see {@link Predicate}
  * @see {@link and}
  * @see {@link not}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -386,6 +393,7 @@ export const mapInput: {
    * @see {@link Predicate}
    * @see {@link and}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -418,6 +426,7 @@ export const mapInput: {
    * @see {@link Predicate}
    * @see {@link and}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -449,6 +458,7 @@ export const mapInput: {
  *
  * @see {@link isTupleOfAtLeast}
  * @see {@link Tuple}
+ * @stability stable
  * @category guards
  * @since 3.3.0
  */
@@ -478,6 +488,7 @@ export const isTupleOf: {
    *
    * @see {@link isTupleOfAtLeast}
    * @see {@link Tuple}
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -507,6 +518,7 @@ export const isTupleOf: {
    *
    * @see {@link isTupleOfAtLeast}
    * @see {@link Tuple}
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -538,6 +550,7 @@ export const isTupleOf: {
  *
  * @see {@link isTupleOf}
  * @see {@link Tuple}
+ * @stability stable
  * @category guards
  * @since 3.3.0
  */
@@ -567,6 +580,7 @@ export const isTupleOfAtLeast: {
    *
    * @see {@link isTupleOf}
    * @see {@link Tuple}
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -596,6 +610,7 @@ export const isTupleOfAtLeast: {
    *
    * @see {@link isTupleOf}
    * @see {@link Tuple}
+   * @stability stable
    * @category guards
    * @since 3.3.0
    */
@@ -626,6 +641,7 @@ export const isTupleOfAtLeast: {
  *
  * @see {@link isNullish}
  * @see {@link isNotNullish}
+ * @stability stable
  * @category predicates
  * @since 2.0.0
  */
@@ -658,6 +674,7 @@ export function isTruthy(input: unknown): boolean {
  *
  * @see {@link isMap}
  * @see {@link isIterable}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -690,6 +707,7 @@ export function isSet(input: unknown): input is Set<unknown> {
  *
  * @see {@link isSet}
  * @see {@link isIterable}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -724,6 +742,7 @@ export function isMap(input: unknown): input is Map<unknown, unknown> {
  * @see {@link isNumber}
  * @see {@link isBoolean}
  * @see {@link Refinement}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -757,6 +776,7 @@ export function isString(input: unknown): input is string {
  *
  * @see {@link isBigInt}
  * @see {@link isString}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -790,6 +810,7 @@ export function isNumber(input: unknown): input is number {
  *
  * @see {@link isString}
  * @see {@link isNumber}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -822,6 +843,7 @@ export function isBoolean(input: unknown): input is boolean {
  * ```
  *
  * @see {@link isNumber}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -854,6 +876,7 @@ export function isBigInt(input: unknown): input is bigint {
  * ```
  *
  * @see {@link isPropertyKey}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -889,6 +912,7 @@ export function isSymbol(input: unknown): input is symbol {
  * @see {@link isString}
  * @see {@link isNumber}
  * @see {@link isSymbol}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -921,6 +945,7 @@ export function isPropertyKey(u: unknown): u is PropertyKey {
  * ```
  *
  * @see {@link isObjectKeyword}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -952,6 +977,7 @@ export function isFunction(input: unknown): input is Function {
  *
  * @see {@link isNotUndefined}
  * @see {@link isNullish}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -982,6 +1008,7 @@ export function isUndefined(input: unknown): input is undefined {
  *
  * @see {@link isUndefined}
  * @see {@link isNotNullish}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1012,6 +1039,7 @@ export function isNotUndefined<A>(input: A): input is Exclude<A, undefined> {
  *
  * @see {@link isNotNull}
  * @see {@link isNullish}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1042,6 +1070,7 @@ export function isNull(input: unknown): input is null {
  *
  * @see {@link isNull}
  * @see {@link isNotNullish}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1072,6 +1101,7 @@ export function isNotNull<A>(input: A): input is Exclude<A, null> {
  * @see {@link isNotNullish}
  * @see {@link isUndefined}
  * @see {@link isNull}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1103,6 +1133,7 @@ export function isNullish<A>(input: A): input is A & (null | undefined) {
  * @see {@link isNullish}
  * @see {@link isNotNull}
  * @see {@link isNotUndefined}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1126,6 +1157,7 @@ export function isNotNullish<A>(input: A): input is NonNullable<A> {
  * ```
  *
  * @see {@link isUnknown}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1149,6 +1181,7 @@ export function isNever(_: unknown): _ is never {
  * ```
  *
  * @see {@link isNever}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1178,6 +1211,7 @@ export function isUnknown(_: unknown): _ is unknown {
  *
  * @see {@link isObject}
  * @see {@link isObjectKeyword}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1210,6 +1244,7 @@ export function isObjectOrArray(input: unknown): input is { [x: PropertyKey]: un
  *
  * @see {@link isObjectOrArray}
  * @see {@link isReadonlyObject}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1243,6 +1278,7 @@ export function isObject(input: unknown): input is { [x: PropertyKey]: unknown }
  * ```
  *
  * @see {@link isObject}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1273,6 +1309,7 @@ export function isReadonlyObject(input: unknown): input is { readonly [x: Proper
  *
  * @see {@link isObject}
  * @see {@link isObjectOrArray}
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -1308,6 +1345,7 @@ export function isObjectKeyword(input: unknown): input is object {
  *
  * @see {@link isTagged}
  * @see {@link isObjectKeyword}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1340,6 +1378,7 @@ export const hasProperty: {
    *
    * @see {@link isTagged}
    * @see {@link isObjectKeyword}
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -1372,6 +1411,7 @@ export const hasProperty: {
    *
    * @see {@link isTagged}
    * @see {@link isObjectKeyword}
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -1405,6 +1445,7 @@ export const hasProperty: {
  * ```
  *
  * @see {@link hasProperty}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1432,6 +1473,7 @@ export const isTagged: {
    * ```
    *
    * @see {@link hasProperty}
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -1459,6 +1501,7 @@ export const isTagged: {
    * ```
    *
    * @see {@link hasProperty}
+   * @stability stable
    * @category guards
    * @since 2.0.0
    */
@@ -1490,6 +1533,7 @@ export const isTagged: {
  * ```
  *
  * @see {@link isUnknown}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1520,6 +1564,7 @@ export function isError(input: unknown): input is Error {
  *
  * @see {@link isIterable}
  * @see {@link isSet}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1549,6 +1594,7 @@ export function isUint8Array(input: unknown): input is Uint8Array {
  * ```
  *
  * @see {@link isRegExp}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1579,6 +1625,7 @@ export function isDate(input: unknown): input is Date {
  *
  * @see {@link isSet}
  * @see {@link isMap}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1608,6 +1655,7 @@ export function isIterable(input: unknown): input is Iterable<unknown> {
  * ```
  *
  * @see {@link isPromiseLike}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1638,6 +1686,7 @@ export function isPromise(input: unknown): input is Promise<unknown> {
  * ```
  *
  * @see {@link isPromise}
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -1667,6 +1716,7 @@ export function isPromiseLike(input: unknown): input is PromiseLike<unknown> {
  * ```
  *
  * @see {@link isDate}
+ * @stability stable
  * @category guards
  * @since 3.9.0
  */
@@ -1702,6 +1752,7 @@ export function isRegExp(input: unknown): input is RegExp {
  *
  * @see {@link and}
  * @see {@link Refinement}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -1734,6 +1785,7 @@ export const compose: {
    *
    * @see {@link and}
    * @see {@link Refinement}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -1766,6 +1818,7 @@ export const compose: {
    *
    * @see {@link and}
    * @see {@link Refinement}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -1798,6 +1851,7 @@ export const compose: {
    *
    * @see {@link and}
    * @see {@link Refinement}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -1830,6 +1884,7 @@ export const compose: {
    *
    * @see {@link and}
    * @see {@link Refinement}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -1865,6 +1920,7 @@ export const compose: {
  *
  * @see {@link Struct}
  * @see {@link isTupleOf}
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1914,6 +1970,7 @@ export function Tuple<const T extends ReadonlyArray<Predicate.Any>>(
  *
  * @see {@link Tuple}
  * @see {@link hasProperty}
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -1960,6 +2017,7 @@ export function Struct<R extends Record<string, Predicate.Any>>(
  * @see {@link and}
  * @see {@link or}
  * @see {@link xor}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -1992,6 +2050,7 @@ export function not<A>(self: Predicate<A>): Predicate<A> {
  *
  * @see {@link and}
  * @see {@link xor}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2021,6 +2080,7 @@ export const or: {
    *
    * @see {@link and}
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2050,6 +2110,7 @@ export const or: {
    *
    * @see {@link and}
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2079,6 +2140,7 @@ export const or: {
    *
    * @see {@link and}
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2108,6 +2170,7 @@ export const or: {
    *
    * @see {@link and}
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2150,6 +2213,7 @@ export const or: {
  *
  * @see {@link or}
  * @see {@link not}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2190,6 +2254,7 @@ export const and: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2230,6 +2295,7 @@ export const and: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2270,6 +2336,7 @@ export const and: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2310,6 +2377,7 @@ export const and: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2341,6 +2409,7 @@ export const and: {
  *
  * @see {@link or}
  * @see {@link and}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2370,6 +2439,7 @@ export const xor: {
    *
    * @see {@link or}
    * @see {@link and}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2399,6 +2469,7 @@ export const xor: {
    *
    * @see {@link or}
    * @see {@link and}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2428,6 +2499,7 @@ export const xor: {
  * ```
  *
  * @see {@link xor}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2455,6 +2527,7 @@ export const eqv: {
    * ```
    *
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2482,6 +2555,7 @@ export const eqv: {
    * ```
    *
    * @see {@link xor}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2515,6 +2589,7 @@ export const eqv: {
  *
  * @see {@link and}
  * @see {@link or}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2546,6 +2621,7 @@ export const implies: {
    *
    * @see {@link and}
    * @see {@link or}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2577,6 +2653,7 @@ export const implies: {
    *
    * @see {@link and}
    * @see {@link or}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2609,6 +2686,7 @@ export const implies: {
  *
  * @see {@link or}
  * @see {@link not}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2636,6 +2714,7 @@ export const nor: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2663,6 +2742,7 @@ export const nor: {
    *
    * @see {@link or}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2695,6 +2775,7 @@ export const nor: {
  *
  * @see {@link and}
  * @see {@link not}
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -2722,6 +2803,7 @@ export const nand: {
    *
    * @see {@link and}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2749,6 +2831,7 @@ export const nand: {
    *
    * @see {@link and}
    * @see {@link not}
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -2782,6 +2865,7 @@ export const nand: {
  *
  * @see {@link some}
  * @see {@link and}
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */
@@ -2820,6 +2904,7 @@ export function every<A>(collection: Iterable<Predicate<A>>): Predicate<A> {
  *
  * @see {@link every}
  * @see {@link or}
+ * @stability stable
  * @category combining
  * @since 2.0.0
  */

package/src/PrimaryKey.ts

@@ -4,6 +4,7 @@
  * method at {@link symbol}; consumers can check unknown values with
  * {@link isPrimaryKey} and read the key with {@link value}.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -21,6 +22,7 @@ import { hasProperty } from "./Predicate.ts"
  * @see {@link value} for reading the string key from a `PrimaryKey` value
  * @see {@link isPrimaryKey} for checking whether an unknown value carries this method
  *
+ * @stability stable
  * @category symbols
  * @since 2.0.0
  */
@@ -56,6 +58,7 @@ export const symbol = "~effect/PrimaryKey"
  * PrimaryKey.value(productId) // => "electronics-42"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -81,6 +84,7 @@ export interface PrimaryKey {
  * @see {@link PrimaryKey} for the protocol being checked
  * @see {@link value} for extracting the string value after narrowing
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -117,6 +121,7 @@ export const isPrimaryKey = (u: unknown): u is PrimaryKey => hasProperty(u, symb
  * PrimaryKey.value(simpleKey) // => "simple-key-123"
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */