MAINHACK

Viewing / Editing File: TSet.d.ts

/**
 * @since 2.0.0
 */
import type * as Chunk from "./Chunk.js";
import type * as HashSet from "./HashSet.js";
import type * as Option from "./Option.js";
import type { Predicate } from "./Predicate.js";
import type * as STM from "./STM.js";
import type * as Types from "./Types.js";
/**
 * @since 2.0.0
 * @category symbols
 */
export declare const TSetTypeId: unique symbol;
/**
 * @since 2.0.0
 * @category symbols
 */
export type TSetTypeId = typeof TSetTypeId;
/**
 * Transactional set implemented on top of `TMap`.
 *
 * @since 2.0.0
 * @category models
 */
export interface TSet<in out A> extends TSet.Variance<A> {
}
/**
 * @since 2.0.0
 */
export declare namespace TSet {
 /**
 * @since 2.0.0
 * @category models
 */
 interface Variance<in out A> {
 readonly [TSetTypeId]: {
 readonly _A: Types.Invariant<A>;
 };
 }
}
/**
 * Stores new element in the set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const add: {
 /**
 * Stores new element in the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(value: A): (self: TSet<A>) => STM.STM<void>;
 /**
 * Stores new element in the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, value: A): STM.STM<void>;
};
/**
 * Atomically transforms the set into the difference of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const difference: {
 /**
 * Atomically transforms the set into the difference of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>;
 /**
 * Atomically transforms the set into the difference of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>;
};
/**
 * Makes an empty `TSet`.
 *
 * @since 2.0.0
 * @category constructors
 */
export declare const empty: <A>() => STM.STM<TSet<A>>;
/**
 * Atomically performs transactional-effect for each element in set.
 *
 * @since 2.0.0
 * @category elements
 */
export declare const forEach: {
 /**
 * Atomically performs transactional-effect for each element in set.
 *
 * @since 2.0.0
 * @category elements
 */
 <A, R, E>(f: (value: A) => STM.STM<void, E, R>): (self: TSet<A>) => STM.STM<void, E, R>;
 /**
 * Atomically performs transactional-effect for each element in set.
 *
 * @since 2.0.0
 * @category elements
 */
 <A, R, E>(self: TSet<A>, f: (value: A) => STM.STM<void, E, R>): STM.STM<void, E, R>;
};
/**
 * Creates a new `TSet` from an iterable collection of values.
 *
 * @since 2.0.0
 * @category constructors
 */
export declare const fromIterable: <A>(iterable: Iterable<A>) => STM.STM<TSet<A>>;
/**
 * Tests whether or not set contains an element.
 *
 * @since 2.0.0
 * @category elements
 */
export declare const has: {
 /**
 * Tests whether or not set contains an element.
 *
 * @since 2.0.0
 * @category elements
 */
 <A>(value: A): (self: TSet<A>) => STM.STM<boolean>;
 /**
 * Tests whether or not set contains an element.
 *
 * @since 2.0.0
 * @category elements
 */
 <A>(self: TSet<A>, value: A): STM.STM<boolean>;
};
/**
 * Atomically transforms the set into the intersection of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const intersection: {
 /**
 * Atomically transforms the set into the intersection of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>;
 /**
 * Atomically transforms the set into the intersection of itself and the
 * provided set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>;
};
/**
 * Tests if the set is empty or not
 *
 * @since 2.0.0
 * @category getters
 */
export declare const isEmpty: <A>(self: TSet<A>) => STM.STM<boolean>;
/**
 * Makes a new `TSet` that is initialized with specified values.
 *
 * @since 2.0.0
 * @category constructors
 */
export declare const make: <Elements extends Array<any>>(...elements: Elements) => STM.STM<TSet<Elements[number]>>;
/**
 * Atomically folds using a pure function.
 *
 * @since 2.0.0
 * @category folding
 */
export declare const reduce: {
 /**
 * Atomically folds using a pure function.
 *
 * @since 2.0.0
 * @category folding
 */
 <Z, A>(zero: Z, f: (accumulator: Z, value: A) => Z): (self: TSet<A>) => STM.STM<Z>;
 /**
 * Atomically folds using a pure function.
 *
 * @since 2.0.0
 * @category folding
 */
 <Z, A>(self: TSet<A>, zero: Z, f: (accumulator: Z, value: A) => Z): STM.STM<Z>;
};
/**
 * Atomically folds using a transactional function.
 *
 * @since 2.0.0
 * @category folding
 */
export declare const reduceSTM: {
 /**
 * Atomically folds using a transactional function.
 *
 * @since 2.0.0
 * @category folding
 */
 <Z, A, R, E>(zero: Z, f: (accumulator: Z, value: A) => STM.STM<Z, E, R>): (self: TSet<A>) => STM.STM<Z, E, R>;
 /**
 * Atomically folds using a transactional function.
 *
 * @since 2.0.0
 * @category folding
 */
 <Z, A, R, E>(self: TSet<A>, zero: Z, f: (accumulator: Z, value: A) => STM.STM<Z, E, R>): STM.STM<Z, E, R>;
};
/**
 * Removes a single element from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const remove: {
 /**
 * Removes a single element from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(value: A): (self: TSet<A>) => STM.STM<void>;
 /**
 * Removes a single element from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, value: A): STM.STM<void>;
};
/**
 * Removes elements from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const removeAll: {
 /**
 * Removes elements from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(iterable: Iterable<A>): (self: TSet<A>) => STM.STM<void>;
 /**
 * Removes elements from the set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, iterable: Iterable<A>): STM.STM<void>;
};
/**
 * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const removeIf: {
 /**
 * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(predicate: Predicate<A>, options: {
 readonly discard: true;
 }): (self: TSet<A>) => STM.STM<void>;
 /**
 * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(predicate: Predicate<A>, options?: {
 readonly discard: false;
 }): (self: TSet<A>) => STM.STM<Array<A>>;
 /**
 * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, predicate: Predicate<A>, options: {
 readonly discard: true;
 }): STM.STM<void>;
 /**
 * Removes entries from a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, predicate: Predicate<A>, options?: {
 readonly discard: false;
 }): STM.STM<Array<A>>;
};
/**
 * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const retainIf: {
 /**
 * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(predicate: Predicate<A>, options: {
 readonly discard: true;
 }): (self: TSet<A>) => STM.STM<void>;
 /**
 * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(predicate: Predicate<A>, options?: {
 readonly discard: false;
 }): (self: TSet<A>) => STM.STM<Array<A>>;
 /**
 * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, predicate: Predicate<A>, options: {
 readonly discard: true;
 }): STM.STM<void>;
 /**
 * Retains entries in a `TSet` that satisfy the specified predicate and returns the removed entries
 * (or `void` if `discard = true`).
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, predicate: Predicate<A>, options?: {
 readonly discard: false;
 }): STM.STM<Array<A>>;
};
/**
 * Returns the set's cardinality.
 *
 * @since 2.0.0
 * @category getters
 */
export declare const size: <A>(self: TSet<A>) => STM.STM<number>;
/**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const takeFirst: {
 /**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B>(pf: (a: A) => Option.Option): (self: TSet<A>) => STM.STM;
 /**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B>(self: TSet<A>, pf: (a: A) => Option.Option): STM.STM;
};
/**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const takeFirstSTM: {
 /**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B, E, R>(pf: (a: A) => STM.STM<B, Option.Option<E>, R>): (self: TSet<A>) => STM.STM<B, E, R>;
 /**
 * Takes the first matching value, or retries until there is one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B, E, R>(self: TSet<A>, pf: (a: A) => STM.STM<B, Option.Option<E>, R>): STM.STM<B, E, R>;
};
/**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const takeSome: {
 /**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B>(pf: (a: A) => Option.Option): (self: TSet<A>) => STM.STM<[B, ...Array]>;
 /**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B>(self: TSet<A>, pf: (a: A) => Option.Option): STM.STM<[B, ...Array]>;
};
/**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const takeSomeSTM: {
 /**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B, E, R>(pf: (a: A) => STM.STM<B, Option.Option<E>, R>): (self: TSet<A>) => STM.STM<[B, ...Array], E, R>;
 /**
 * Takes all matching values, or retries until there is at least one.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, B, E, R>(self: TSet<A>, pf: (a: A) => STM.STM<B, Option.Option<E>, R>): STM.STM<[B, ...Array], E, R>;
};
/**
 * Collects all elements into a `Chunk`.
 *
 * @since 2.0.0
 * @category destructors
 */
export declare const toChunk: <A>(self: TSet<A>) => STM.STM<Chunk.Chunk<A>>;
/**
 * Collects all elements into a `HashSet`.
 *
 * @since 2.0.0
 * @category destructors
 */
export declare const toHashSet: <A>(self: TSet<A>) => STM.STM<HashSet.HashSet<A>>;
/**
 * Collects all elements into a `Array`.
 *
 * @since 2.0.0
 * @category destructors
 */
export declare const toArray: <A>(self: TSet<A>) => STM.STM<Array<A>>;
/**
 * Collects all elements into a `ReadonlySet`.
 *
 * @since 2.0.0
 * @category destructors
 */
export declare const toReadonlySet: <A>(self: TSet<A>) => STM.STM<ReadonlySet<A>>;
/**
 * Atomically updates all elements using a pure function.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const transform: {
 /**
 * Atomically updates all elements using a pure function.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(f: (a: A) => A): (self: TSet<A>) => STM.STM<void>;
 /**
 * Atomically updates all elements using a pure function.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, f: (a: A) => A): STM.STM<void>;
};
/**
 * Atomically updates all elements using a transactional function.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const transformSTM: {
 /**
 * Atomically updates all elements using a transactional function.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, R, E>(f: (a: A) => STM.STM<A, E, R>): (self: TSet<A>) => STM.STM<void, E, R>;
 /**
 * Atomically updates all elements using a transactional function.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A, R, E>(self: TSet<A>, f: (a: A) => STM.STM<A, E, R>): STM.STM<void, E, R>;
};
/**
 * Atomically transforms the set into the union of itself and the provided
 * set.
 *
 * @since 2.0.0
 * @category mutations
 */
export declare const union: {
 /**
 * Atomically transforms the set into the union of itself and the provided
 * set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(other: TSet<A>): (self: TSet<A>) => STM.STM<void>;
 /**
 * Atomically transforms the set into the union of itself and the provided
 * set.
 *
 * @since 2.0.0
 * @category mutations
 */
 <A>(self: TSet<A>, other: TSet<A>): STM.STM<void>;
};
//# sourceMappingURL=TSet.d.ts.map

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: TSet.d.ts

Server Info

System Features

User Info