@monstermann/set 0.2.0 → 0.3.0

package/dist/Set/hasAny.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/hasAny.d.ts
 /**
+ * # hasAny
+ *
  * ```ts
- * function Set.hasAny(target, values)
+ * function Set.hasAny<T>(
+ *     target: ReadonlySet<T>,
+ *     values: Iterable<NoInfer<T>>,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if the set contains at least one value from the iterable, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.hasAny(Set.create([1, 2, 3]), [3, 4]); // true
  * Set.hasAny(Set.create([1, 2, 3]), [4, 5]); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2, 3]), Set.hasAny([3, 4])); // true
  * pipe(Set.create([1, 2, 3]), Set.hasAny([4, 5])); // false
  * ```
+ *
  */
 declare const hasAny: {
   <T>(values: Iterable<NoInfer<T>>): (target: ReadonlySet<T>) => boolean;

package/dist/Set/hasAny.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/hasAny.ts
 /**
+* # hasAny
+*
 * ```ts
-* function Set.hasAny(target, values)
+* function Set.hasAny<T>(
+*     target: ReadonlySet<T>,
+*     values: Iterable<NoInfer<T>>,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if the set contains at least one value from the iterable, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.hasAny(Set.create([1, 2, 3]), [3, 4]); // true
 * Set.hasAny(Set.create([1, 2, 3]), [4, 5]); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2, 3]), Set.hasAny([3, 4])); // true
 * pipe(Set.create([1, 2, 3]), Set.hasAny([4, 5])); // false
 * ```
+*
 */
 const hasAny = dfdlT((target, values) => {
 	for (const value of values) if (target.has(value)) return true;

package/dist/Set/hasNone.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/hasNone.d.ts
 /**
+ * # hasNone
+ *
  * ```ts
- * function Set.hasNone(target, values)
+ * function Set.hasNone<T>(
+ *     target: ReadonlySet<T>,
+ *     values: Iterable<NoInfer<T>>,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if the set contains none of the values from the iterable, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.hasNone(Set.create([1, 2, 3]), [4, 5]); // true
  * Set.hasNone(Set.create([1, 2, 3]), [3, 4]); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2, 3]), Set.hasNone([4, 5])); // true
  * pipe(Set.create([1, 2, 3]), Set.hasNone([3, 4])); // false
  * ```
+ *
  */
 declare const hasNone: {
   <T>(values: Iterable<NoInfer<T>>): (target: ReadonlySet<T>) => boolean;

package/dist/Set/hasNone.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/hasNone.ts
 /**
+* # hasNone
+*
 * ```ts
-* function Set.hasNone(target, values)
+* function Set.hasNone<T>(
+*     target: ReadonlySet<T>,
+*     values: Iterable<NoInfer<T>>,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if the set contains none of the values from the iterable, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.hasNone(Set.create([1, 2, 3]), [4, 5]); // true
 * Set.hasNone(Set.create([1, 2, 3]), [3, 4]); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2, 3]), Set.hasNone([4, 5])); // true
 * pipe(Set.create([1, 2, 3]), Set.hasNone([3, 4])); // false
 * ```
+*
 */
 const hasNone = dfdlT((target, values) => {
 	for (const value of values) if (target.has(value)) return false;

package/dist/Set/index.d.mts

@@ -1,8 +1,5 @@
 import { add } from "./add.mjs";
 import { addAll } from "./addAll.mjs";
-import { addOr } from "./addOr.mjs";
-import { addOrElse } from "./addOrElse.mjs";
-import { addOrThrow } from "./addOrThrow.mjs";
 import { clone } from "./clone.mjs";
 import { compact } from "./compact.mjs";
 import { create } from "./create.mjs";
@@ -22,9 +19,6 @@ import { isSupersetOf } from "./isSupersetOf.mjs";
 import { mapEach } from "./mapEach.mjs";
 import { remove } from "./remove.mjs";
 import { removeAll } from "./removeAll.mjs";
-import { removeOr } from "./removeOr.mjs";
-import { removeOrElse } from "./removeOrElse.mjs";
-import { removeOrThrow } from "./removeOrThrow.mjs";
 import { size } from "./size.mjs";
 import { symmetricDifference } from "./symmetricDifference.mjs";
 import { toArray } from "./toArray.mjs";
@@ -33,7 +27,7 @@ import { union } from "./union.mjs";
 //#region src/Set/index.d.ts
 
 declare namespace Set {
-  export { add, addAll, addOr, addOrElse, addOrThrow, clone, compact, create, difference, forEach, has, hasAll, hasAny, hasNone, intersection, is, isDisjointFrom, isEmpty, isShallowEqual, isSubsetOf, isSupersetOf, mapEach, remove, removeAll, removeOr, removeOrElse, removeOrThrow, size, symmetricDifference, toArray, union };
+  export { add, addAll, clone, compact, create, difference, forEach, has, hasAll, hasAny, hasNone, intersection, is, isDisjointFrom, isEmpty, isShallowEqual, isSubsetOf, isSupersetOf, mapEach, remove, removeAll, size, symmetricDifference, toArray, union };
 }
 //#endregion
 export { Set };

package/dist/Set/index.mjs

@@ -1,8 +1,5 @@
 import { add } from "./add.mjs";
 import { addAll } from "./addAll.mjs";
-import { addOr } from "./addOr.mjs";
-import { addOrElse } from "./addOrElse.mjs";
-import { addOrThrow } from "./addOrThrow.mjs";
 import { clone } from "./clone.mjs";
 import { compact } from "./compact.mjs";
 import { create } from "./create.mjs";
@@ -22,9 +19,6 @@ import { isSupersetOf } from "./isSupersetOf.mjs";
 import { mapEach } from "./mapEach.mjs";
 import { remove } from "./remove.mjs";
 import { removeAll } from "./removeAll.mjs";
-import { removeOr } from "./removeOr.mjs";
-import { removeOrElse } from "./removeOrElse.mjs";
-import { removeOrThrow } from "./removeOrThrow.mjs";
 import { size } from "./size.mjs";
 import { symmetricDifference } from "./symmetricDifference.mjs";
 import { toArray } from "./toArray.mjs";
@@ -34,9 +28,6 @@ import { union } from "./union.mjs";
 const Set = {
 	add,
 	addAll,
-	addOr,
-	addOrElse,
-	addOrThrow,
 	clone,
 	compact,
 	create,
@@ -56,9 +47,6 @@ const Set = {
 	mapEach,
 	remove,
 	removeAll,
-	removeOr,
-	removeOrElse,
-	removeOrThrow,
 	size,
 	symmetricDifference,
 	toArray,

package/dist/Set/intersection.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/intersection.d.ts
 /**
+ * # intersection
+ *
  * ```ts
- * function Set.intersection(target, source)
+ * function Set.intersection<T, U>(
+ *     target: Set<T>,
+ *     source: Set<U>,
+ * ): Set<T | U>
  * ```
  *
- * Example
+ * Returns a set containing only the values that exist in both sets.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.intersection(Set.create([1, 2, 3]), Set.create([2, 3, 4])); // Set([2, 3])
  * Set.intersection(Set.create([1, 2]), Set.create([3, 4])); // Set([])
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2, 3]), Set.intersection(Set.create([2, 3, 4]))); // Set([2, 3])
  * pipe(Set.create([1, 2]), Set.intersection(Set.create([3, 4]))); // Set([])
  * ```
+ *
  */
 declare const intersection: {
   <T, U>(source: Set<U>): (target: Set<T>) => Set<T | U>;

package/dist/Set/intersection.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/intersection.ts
 /**
+* # intersection
+*
 * ```ts
-* function Set.intersection(target, source)
+* function Set.intersection<T, U>(
+*     target: Set<T>,
+*     source: Set<U>,
+* ): Set<T | U>
 * ```
 *
-* Example
+* Returns a set containing only the values that exist in both sets.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.intersection(Set.create([1, 2, 3]), Set.create([2, 3, 4])); // Set([2, 3])
 * Set.intersection(Set.create([1, 2]), Set.create([3, 4])); // Set([])
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2, 3]), Set.intersection(Set.create([2, 3, 4]))); // Set([2, 3])
 * pipe(Set.create([1, 2]), Set.intersection(Set.create([3, 4]))); // Set([])
 * ```
+*
 */
 const intersection = dfdlT((target, source) => {
 	if (target.size === 0) return target;

package/dist/Set/is.d.mts

@@ -1,12 +1,16 @@
 //#region src/Set/is.d.ts
 /**
+ * # is
+ *
  * ```ts
- * function Set.is(target)
+ * function Set.is(target: unknown): target is Set<unknown>
  * ```
  *
- * Example
+ * Returns `true` if the value is a Set, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.is(Set.create([1, 2, 3])); // true
@@ -14,13 +18,14 @@
  * Set.is({}); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2, 3]), Set.is()); // true
  * pipe([1, 2, 3], Set.is()); // false
  * pipe({}, Set.is()); // false
  * ```
+ *
  */
 declare const is: {
   (): (target: unknown) => target is Set<unknown>;

package/dist/Set/is.mjs

@@ -2,13 +2,17 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/is.ts
 /**
+* # is
+*
 * ```ts
-* function Set.is(target)
+* function Set.is(target: unknown): target is Set<unknown>
 * ```
 *
-* Example
+* Returns `true` if the value is a Set, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.is(Set.create([1, 2, 3])); // true
@@ -16,13 +20,14 @@ import { dfdlT } from "@monstermann/dfdl";
 * Set.is({}); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2, 3]), Set.is()); // true
 * pipe([1, 2, 3], Set.is()); // false
 * pipe({}, Set.is()); // false
 * ```
+*
 */
 const is = dfdlT((target) => {
 	return target instanceof Set;

package/dist/Set/isDisjointFrom.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/isDisjointFrom.d.ts
 /**
+ * # isDisjointFrom
+ *
  * ```ts
- * function Set.isDisjointFrom(target, source)
+ * function Set.isDisjointFrom<T>(
+ *     target: ReadonlySet<T>,
+ *     source: ReadonlySet<NoInfer<T>>,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if the sets have no values in common, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.isDisjointFrom(Set.create([1, 2]), Set.create([3, 4])); // true
  * Set.isDisjointFrom(Set.create([1, 2]), Set.create([2, 3])); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2]), Set.isDisjointFrom(Set.create([3, 4]))); // true
  * pipe(Set.create([1, 2]), Set.isDisjointFrom(Set.create([2, 3]))); // false
  * ```
+ *
  */
 declare const isDisjointFrom: {
   <T>(source: ReadonlySet<NoInfer<T>>): (target: ReadonlySet<T>) => boolean;

package/dist/Set/isDisjointFrom.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/isDisjointFrom.ts
 /**
+* # isDisjointFrom
+*
 * ```ts
-* function Set.isDisjointFrom(target, source)
+* function Set.isDisjointFrom<T>(
+*     target: ReadonlySet<T>,
+*     source: ReadonlySet<NoInfer<T>>,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if the sets have no values in common, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.isDisjointFrom(Set.create([1, 2]), Set.create([3, 4])); // true
 * Set.isDisjointFrom(Set.create([1, 2]), Set.create([2, 3])); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2]), Set.isDisjointFrom(Set.create([3, 4]))); // true
 * pipe(Set.create([1, 2]), Set.isDisjointFrom(Set.create([2, 3]))); // false
 * ```
+*
 */
 const isDisjointFrom = dfdlT((target, source) => {
 	for (const value of target) if (source.has(value)) return false;

package/dist/Set/isEmpty.d.mts

@@ -1,24 +1,31 @@
 //#region src/Set/isEmpty.d.ts
 /**
+ * # isEmpty
+ *
  * ```ts
- * function Set.isEmpty(target)
+ * function Set.isEmpty<T extends ReadonlySet<unknown>>(
+ *     target: T,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if the set contains no values, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.isEmpty(Set.create()); // true
  * Set.isEmpty(Set.create([1, 2, 3])); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create(), Set.isEmpty()); // true
  * pipe(Set.create([1, 2, 3]), Set.isEmpty()); // false
  * ```
+ *
  */
 declare const isEmpty: {
   (): <T extends ReadonlySet<unknown>>(target: T) => boolean;

package/dist/Set/isEmpty.mjs

@@ -2,25 +2,32 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/isEmpty.ts
 /**
+* # isEmpty
+*
 * ```ts
-* function Set.isEmpty(target)
+* function Set.isEmpty<T extends ReadonlySet<unknown>>(
+*     target: T,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if the set contains no values, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.isEmpty(Set.create()); // true
 * Set.isEmpty(Set.create([1, 2, 3])); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create(), Set.isEmpty()); // true
 * pipe(Set.create([1, 2, 3]), Set.isEmpty()); // false
 * ```
+*
 */
 const isEmpty = dfdlT((target) => {
 	return target.size === 0;

package/dist/Set/isShallowEqual.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/isShallowEqual.d.ts
 /**
+ * # isShallowEqual
+ *
  * ```ts
- * function Set.isShallowEqual(target, source)
+ * function Set.isShallowEqual<T>(
+ *     target: ReadonlySet<T>,
+ *     source: ReadonlySet<NoInfer<T>>,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if both sets contain the same values, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.isShallowEqual(Set.create([1, 2, 3]), Set.create([3, 2, 1])); // true
  * Set.isShallowEqual(Set.create([1, 2]), Set.create([1, 2, 3])); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2, 3]), Set.isShallowEqual(Set.create([3, 2, 1]))); // true
  * pipe(Set.create([1, 2]), Set.isShallowEqual(Set.create([1, 2, 3]))); // false
  * ```
+ *
  */
 declare const isShallowEqual: {
   <T>(source: ReadonlySet<NoInfer<T>>): (target: ReadonlySet<T>) => boolean;

package/dist/Set/isShallowEqual.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/isShallowEqual.ts
 /**
+* # isShallowEqual
+*
 * ```ts
-* function Set.isShallowEqual(target, source)
+* function Set.isShallowEqual<T>(
+*     target: ReadonlySet<T>,
+*     source: ReadonlySet<NoInfer<T>>,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if both sets contain the same values, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.isShallowEqual(Set.create([1, 2, 3]), Set.create([3, 2, 1])); // true
 * Set.isShallowEqual(Set.create([1, 2]), Set.create([1, 2, 3])); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2, 3]), Set.isShallowEqual(Set.create([3, 2, 1]))); // true
 * pipe(Set.create([1, 2]), Set.isShallowEqual(Set.create([1, 2, 3]))); // false
 * ```
+*
 */
 const isShallowEqual = dfdlT((target, source) => {
 	if (target.size !== source.size) return false;

package/dist/Set/isSubsetOf.d.mts

@@ -1,24 +1,32 @@
 //#region src/Set/isSubsetOf.d.ts
 /**
+ * # isSubsetOf
+ *
  * ```ts
- * function Set.isSubsetOf(target, source)
+ * function Set.isSubsetOf<T>(
+ *     target: ReadonlySet<T>,
+ *     source: ReadonlySet<NoInfer<T>>,
+ * ): boolean
  * ```
  *
- * Example
+ * Returns `true` if all values in the target set are also in the source set, `false` otherwise.
  *
- * ```ts
+ * ## Example
+ *
+ * ```ts [data-first]
  * import { Set } from "@monstermann/set";
  *
  * Set.isSubsetOf(Set.create([1, 2]), Set.create([1, 2, 3])); // true
  * Set.isSubsetOf(Set.create([1, 4]), Set.create([1, 2, 3])); // false
  * ```
  *
- * ```ts
+ * ```ts [data-last]
  * import { Set } from "@monstermann/set";
  *
  * pipe(Set.create([1, 2]), Set.isSubsetOf(Set.create([1, 2, 3]))); // true
  * pipe(Set.create([1, 4]), Set.isSubsetOf(Set.create([1, 2, 3]))); // false
  * ```
+ *
  */
 declare const isSubsetOf: {
   <T>(source: ReadonlySet<NoInfer<T>>): (target: ReadonlySet<T>) => boolean;

package/dist/Set/isSubsetOf.mjs

@@ -2,25 +2,33 @@ import { dfdlT } from "@monstermann/dfdl";
 
 //#region src/Set/isSubsetOf.ts
 /**
+* # isSubsetOf
+*
 * ```ts
-* function Set.isSubsetOf(target, source)
+* function Set.isSubsetOf<T>(
+*     target: ReadonlySet<T>,
+*     source: ReadonlySet<NoInfer<T>>,
+* ): boolean
 * ```
 *
-* Example
+* Returns `true` if all values in the target set are also in the source set, `false` otherwise.
 *
-* ```ts
+* ## Example
+*
+* ```ts [data-first]
 * import { Set } from "@monstermann/set";
 *
 * Set.isSubsetOf(Set.create([1, 2]), Set.create([1, 2, 3])); // true
 * Set.isSubsetOf(Set.create([1, 4]), Set.create([1, 2, 3])); // false
 * ```
 *
-* ```ts
+* ```ts [data-last]
 * import { Set } from "@monstermann/set";
 *
 * pipe(Set.create([1, 2]), Set.isSubsetOf(Set.create([1, 2, 3]))); // true
 * pipe(Set.create([1, 4]), Set.isSubsetOf(Set.create([1, 2, 3]))); // false
 * ```
+*
 */
 const isSubsetOf = dfdlT((target, source) => {
 	if (target.size > source.size) return false;