effect 2.0.0-next.37 → 2.0.0-next.38

package/dist/declarations/src/Option.d.ts

@@ -1,5 +1,5 @@
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 import type * as Data from "./Data.js";
 import type { Either } from "./Either.js";
@@ -14,22 +14,22 @@ import type * as Unify from "./Unify.js";
 import * as Gen from "./Utils.js";
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type Option<A> = None<A> | Some<A>;
 /**
  * @category symbols
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const TypeId: unique symbol;
 /**
  * @category symbols
- * @since 1.0.0
+ * @since 2.0.0
  */
 export type TypeId = typeof TypeId;
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface None<A> extends Data.Case, Pipeable, Inspectable {
     readonly _tag: "None";
@@ -43,7 +43,7 @@ export interface None<A> extends Data.Case, Pipeable, Inspectable {
 }
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface Some<A> extends Data.Case, Pipeable, Inspectable {
     readonly _tag: "Some";
@@ -58,7 +58,7 @@ export interface Some<A> extends Data.Case, Pipeable, Inspectable {
 }
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface OptionUnify<A extends {
     [Unify.typeSymbol]?: any;
@@ -67,13 +67,13 @@ export interface OptionUnify<A extends {
 }
 /**
  * @category models
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface OptionUnifyBlacklist {
 }
 /**
  * @category type lambdas
- * @since 1.0.0
+ * @since 2.0.0
  */
 export interface OptionTypeLambda extends TypeLambda {
     readonly type: Option<this["Target"]>;
@@ -82,7 +82,7 @@ export interface OptionTypeLambda extends TypeLambda {
  * Creates a new `Option` that represents the absence of a value.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const none: <A = never>() => Option<A>;
 /**
@@ -91,7 +91,7 @@ export declare const none: <A = never>() => Option<A>;
  * @param value - The value to wrap.
  *
  * @category constructors
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const some: <A>(value: A) => Option<A>;
 /**
@@ -107,7 +107,7 @@ export declare const some: <A>(value: A) => Option<A>;
  * assert.deepStrictEqual(isOption({}), false)
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isOption: (input: unknown) => input is Option<unknown>;
 /**
@@ -122,7 +122,7 @@ export declare const isOption: (input: unknown) => input is Option<unknown>;
  * assert.deepStrictEqual(isNone(none()), true)
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isNone: <A>(self: Option<A>) => self is None<A>;
 /**
@@ -137,7 +137,7 @@ export declare const isNone: <A>(self: Option<A>) => self is None<A>;
  * assert.deepStrictEqual(isSome(none()), false)
  *
  * @category guards
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
 /**
@@ -163,7 +163,7 @@ export declare const isSome: <A>(self: Option<A>) => self is Some<A>;
  * )
  *
  * @category pattern matching
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const match: {
     <B, A, C = B>(options: {
@@ -191,7 +191,7 @@ export declare const match: {
  * assert.deepStrictEqual(isPositive(-1), false)
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (a: A) => a is B;
 /**
@@ -207,7 +207,7 @@ export declare const toRefinement: <A, B extends A>(f: (a: A) => Option<B>) => (
  * assert.deepStrictEqual(fromIterable([]), none())
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
 /**
@@ -223,7 +223,7 @@ export declare const fromIterable: <A>(collection: Iterable<A>) => Option<A>;
  * assert.deepStrictEqual(O.getRight(E.left('err')), O.none())
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getRight: <E, A>(self: Either<E, A>) => Option<A>;
 /**
@@ -237,7 +237,7 @@ export declare const getRight: <E, A>(self: Either<E, A>) => Option<A>;
  * assert.deepStrictEqual(O.getLeft(E.left("a")), O.some("a"))
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getLeft: <E, A>(self: Either<E, A>) => Option<E>;
 /**
@@ -254,7 +254,7 @@ export declare const getLeft: <E, A>(self: Either<E, A>) => Option<E>;
  * assert.deepStrictEqual(pipe(none(), getOrElse(() => 0)), 0)
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrElse: {
     <B>(onNone: LazyArg<B>): <A>(self: Option<A>) => B | A;
@@ -300,7 +300,7 @@ export declare const getOrElse: {
  * )
  *
  * @category error handling
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const orElse: {
     <B>(that: LazyArg<Option<B>>): <A>(self: Option<A>) => Option<B | A>;
@@ -316,7 +316,7 @@ export declare const orElse: {
  * @param that - The second `Option` to be considered if the first `Option` is `None`.
  *
  * @category error handling
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const orElseEither: {
     <B>(that: LazyArg<Option<B>>): <A>(self: Option<A>) => Option<Either<A, B>>;
@@ -333,7 +333,7 @@ export declare const orElseEither: {
  * assert.deepStrictEqual(O.firstSomeOf([O.none(), O.some(1), O.some(2)]), O.some(1))
  *
  * @category error handling
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const firstSomeOf: <A>(collection: Iterable<Option<A>>) => Option<A>;
 /**
@@ -350,7 +350,7 @@ export declare const firstSomeOf: <A>(collection: Iterable<Option<A>>) => Option
  * assert.deepStrictEqual(O.fromNullable(1), O.some(1))
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const fromNullable: <A>(nullableValue: A) => Option<NonNullable<A>>;
 /**
@@ -370,7 +370,7 @@ export declare const fromNullable: <A>(nullableValue: A) => Option<NonNullable<A
  * assert.deepStrictEqual(parseOption('not a number'), O.none())
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftNullable: <A extends readonly unknown[], B>(f: (...a: A) => B | null | undefined) => (...a: A) => Option<NonNullable<B>>;
 /**
@@ -385,7 +385,7 @@ export declare const liftNullable: <A extends readonly unknown[], B>(f: (...a: A
  * assert.deepStrictEqual(O.getOrNull(O.none()), null)
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrNull: <A>(self: Option<A>) => A | null;
 /**
@@ -400,7 +400,7 @@ export declare const getOrNull: <A>(self: Option<A>) => A | null;
  * assert.deepStrictEqual(O.getOrUndefined(O.none()), undefined)
  *
  * @category getters
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
 /**
@@ -420,7 +420,7 @@ export declare const getOrUndefined: <A>(self: Option<A>) => A | undefined;
  * assert.deepStrictEqual(parse(""), O.none())
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftThrowable: <A extends readonly unknown[], B>(f: (...a: A) => B) => (...a: A) => Option<B>;
 /**
@@ -441,7 +441,7 @@ export declare const liftThrowable: <A extends readonly unknown[], B>(f: (...a:
  * assert.throws(() => O.getOrThrowWith(O.none(), () => new Error('Unexpected None')))
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrThrowWith: {
     (onNone: () => unknown): <A>(self: Option<A>) => A;
@@ -462,7 +462,7 @@ export declare const getOrThrowWith: {
  * assert.throws(() => O.getOrThrow(O.none()))
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrThrow: <A>(self: Option<A>) => A;
 /**
@@ -472,7 +472,7 @@ export declare const getOrThrow: <A>(self: Option<A>) => A;
  * @param f - The function to map over the value of the `Option`
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const map: {
     <A, B>(f: (a: A) => B): (self: Option<A>) => Option<B>;
@@ -482,7 +482,7 @@ export declare const map: {
  * Maps the `Some` value of this `Option` to the specified constant value.
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const as: {
     <B>(b: B): <_>(self: Option<_>) => Option<B>;
@@ -493,18 +493,18 @@ export declare const as: {
  * This is useful when the value of the `Option` is not needed, but the presence or absence of the value is important.
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const asUnit: <_>(self: Option<_>) => Option<void>;
 /**
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const unit: Option<void>;
 /**
  * Applies a function to the value of an `Option` and flattens the result, if the input is `Some`.
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatMap: {
     <A, B>(f: (a: A) => Option<B>): (self: Option<A>) => Option<B>;
@@ -548,7 +548,7 @@ export declare const flatMap: {
  * )
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatMapNullable: {
     <A, B>(f: (a: A) => B | null | undefined): (self: Option<A>) => Option<NonNullable<B>>;
@@ -556,12 +556,12 @@ export declare const flatMapNullable: {
 };
 /**
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const flatten: <A>(self: Option<Option<A>>) => Option<A>;
 /**
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipRight: {
     <B>(that: Option<B>): <_>(self: Option<_>) => Option<B>;
@@ -569,7 +569,7 @@ export declare const zipRight: {
 };
 /**
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const composeK: {
     <B, C>(bfc: (b: B) => Option<C>): <A>(afb: (a: A) => Option<B>) => (a: A) => Option<C>;
@@ -584,7 +584,7 @@ export declare const composeK: {
  * @param self - The `Option` we care about
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipLeft: {
     <_>(that: Option<_>): <A>(self: Option<A>) => Option<A>;
@@ -609,7 +609,7 @@ export declare const zipLeft: {
  * assert.deepStrictEqual(O.tap(O.some(1.14), getInteger), O.none())
  *
  * @category transforming
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const tap: {
     <A, _>(f: (a: A) => Option<_>): (self: Option<A>) => Option<A>;
@@ -617,12 +617,12 @@ export declare const tap: {
 };
 /**
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const product: <A, B>(self: Option<A>, that: Option<B>) => Option<[A, B]>;
 /**
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const productMany: <A>(self: Option<A>, collection: Iterable<Option<A>>) => Option<[A, ...A[]]>;
 /**
@@ -642,7 +642,7 @@ export declare const productMany: <A>(self: Option<A>, collection: Iterable<Opti
  * assert.deepStrictEqual(O.all({ a: O.some(1), b: O.none() }), O.none())
  *
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const all: <const I extends Iterable<Option<any>> | Record<string, Option<any>>>(input: I) => [I] extends [ReadonlyArray<Option<any>>] ? Option<{
     -readonly [K in keyof I]: [I[K]] extends [Option<infer A>] ? A : never;
@@ -671,7 +671,7 @@ export declare const all: <const I extends Iterable<Option<any>> | Record<string
  * assert.deepStrictEqual(O.zipWith(O.some(1), complex)(O.some(2)), O.some([2, 1]))
  *
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const zipWith: {
     <B, A, C>(that: Option<B>, f: (a: A, b: B) => C): (self: Option<A>) => Option<C>;
@@ -679,7 +679,7 @@ export declare const zipWith: {
 };
 /**
  * @category combining
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const ap: {
     <A>(that: Option<A>): <B>(self: Option<(a: A) => B>) => Option<B>;
@@ -700,7 +700,7 @@ export declare const ap: {
  * assert.deepStrictEqual(pipe(iterable, reduceCompact(0, (b, a) => b + a)), 3)
  *
  * @category folding
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const reduceCompact: {
     <B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<Option<A>>) => B;
@@ -720,12 +720,12 @@ export declare const reduceCompact: {
  * assert.deepStrictEqual(O.toArray(O.none()), [])
  *
  * @category conversions
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const toArray: <A>(self: Option<A>) => A[];
 /**
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const partitionMap: {
     <A, B, C>(f: (a: A) => Either<B, C>): (self: Option<A>) => [Option<B>, Option<C>];
@@ -749,7 +749,7 @@ export declare const partitionMap: {
  * assert.deepStrictEqual(O.filterMap(O.some(2), evenNumber), O.some(2))
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const filterMap: {
     <A, B>(f: (a: A) => Option<B>): (self: Option<A>) => Option<B>;
@@ -781,7 +781,7 @@ export declare const filterMap: {
  * assert.deepStrictEqual(O.filter(O.some(2), isNumber), O.some(2))
  *
  * @category filtering
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const filter: {
     <C extends A, B extends A, A = C>(refinement: (a: A) => a is B): (self: Option<C>) => Option<B>;
@@ -802,7 +802,7 @@ export declare const filter: {
  * assert.deepStrictEqual(isEquivalent(some(1), some(1)), true)
  *
  * @category equivalence
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A>) => Equivalence.Equivalence<Option<A>>;
 /**
@@ -825,7 +825,7 @@ export declare const getEquivalence: <A>(isEquivalent: Equivalence.Equivalence<A
  * assert.deepStrictEqual(O(some(1), some(1)), 0)
  *
  * @category sorting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const getOrder: <A>(O: Order<A>) => Order<Option<A>>;
 /**
@@ -834,7 +834,7 @@ export declare const getOrder: <A>(O: Order<A>) => Order<Option<A>>;
  * @param f - The function to lift.
  *
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const lift2: <A, B, C>(f: (a: A, b: B) => C) => {
     (that: Option<B>): (self: Option<A>) => Option<C>;
@@ -855,7 +855,7 @@ export declare const lift2: <A, B, C>(f: (a: A, b: B) => C) => {
  * assert.deepStrictEqual(getOption(1), O.some(1))
  *
  * @category lifting
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const liftPredicate: {
     <C extends A, B extends A, A = C>(refinement: Refinement<A, B>): (c: C) => Option<B>;
@@ -878,7 +878,7 @@ export declare const liftPredicate: {
  * assert.deepStrictEqual(pipe(none(), containsWith(Equivalence)(2)), false)
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boolean) => {
     (a: A): (self: Option<A>) => boolean;
@@ -888,7 +888,7 @@ export declare const containsWith: <A>(isEquivalent: (self: A, that: A) => boole
  * Returns a function that checks if an `Option` contains a given value using the default `Equivalence`.
  *
  * @category elements
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const contains: {
     <A>(a: A): (self: Option<A>) => boolean;
@@ -910,7 +910,7 @@ export declare const contains: {
  * assert.deepStrictEqual(pipe(some(1), exists(isEven)), false)
  * assert.deepStrictEqual(pipe(none(), exists(isEven)), false)
  *
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const exists: {
     <A>(predicate: Predicate<A>): (self: Option<A>) => boolean;
@@ -918,7 +918,7 @@ export declare const exists: {
 };
 /**
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sum: {
     (self: Option<number>, that: Option<number>): Option<number>;
@@ -926,7 +926,7 @@ export declare const sum: {
 };
 /**
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const multiply: {
     (self: Option<number>, that: Option<number>): Option<number>;
@@ -934,7 +934,7 @@ export declare const multiply: {
 };
 /**
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const subtract: {
     (self: Option<number>, that: Option<number>): Option<number>;
@@ -942,7 +942,7 @@ export declare const subtract: {
 };
 /**
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const divide: {
     (self: Option<number>, that: Option<number>): Option<number>;
@@ -960,7 +960,7 @@ export declare const divide: {
  * assert.deepStrictEqual(sumCompact(iterable), 5)
  *
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const sumCompact: (self: Iterable<Option<number>>) => number;
 /**
@@ -975,12 +975,12 @@ export declare const sumCompact: (self: Iterable<Option<number>>) => number;
  * assert.deepStrictEqual(multiplyCompact(iterable), 6)
  *
  * @category math
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const multiplyCompact: (self: Iterable<Option<number>>) => number;
 /**
  * @category do notation
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const bindTo: {
     <N extends string>(name: N): <A>(self: Option<A>) => Option<{
@@ -1001,12 +1001,12 @@ declare const let_: {
 export { 
 /**
  * @category do notation
- * @since 1.0.0
+ * @since 2.0.0
  */
 let_ as let };
 /**
  * @category do notation
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const bind: {
     <N extends string, A extends object, B>(name: Exclude<N, keyof A>, f: (a: A) => Option<B>): (self: Option<A>) => Option<{
@@ -1018,12 +1018,12 @@ export declare const bind: {
 };
 /**
  * @category do notation
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const Do: Option<{}>;
 /**
  * @category generators
- * @since 1.0.0
+ * @since 2.0.0
  */
 export declare const gen: Gen.Gen<OptionTypeLambda, Gen.Adapter<OptionTypeLambda>>;
 //# sourceMappingURL=Option.d.ts.map