@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250825015921 → 13.346.0-beta.20250825021358

package/src/foundry/common/primitives/set.d.mts

@@ -2,20 +2,13 @@ export {};
 
 declare global {
   interface Set<T> {
-    /**
-     * Return the difference of two sets.
-     * @param other - Some other set to compare against
-     * @returns The difference defined as objects in this which are not present in other
-     */
-    difference(other: Set<T>): Set<T>;
-
     /**
      * Test whether this set is equal to some other set.
      * Sets are equal if they share the same members, independent of order
      * @param other - Some other set to compare against
      * @returns Are the sets equal?
      */
-    equals(other: Set<T>): boolean;
+    equals(other: ReadonlySetLike<unknown>): boolean;
 
     /**
      * Return the first value from the set.
@@ -23,27 +16,22 @@ declare global {
      */
     first(): T | undefined;
 
-    /**
-     * Return the intersection of two sets.
-     * @param other - Some other set to compare against
-     * @returns The intersection of both sets
-     */
-    intersection(other: Set<T>): Set<T>;
-
     /**
      * Test whether this set has an intersection with another set.
      * @param other - Another set to compare against
      * @returns Do the sets intersect?
+     * @remarks Just returns {@linkcode Set.isDisjointFrom | !this.isDisjointFrom(other)}
      */
-    intersects(other: Set<T>): boolean;
+    intersects(other: ReadonlySetLike<unknown>): boolean;
 
     /**
      * Test whether this set is a subset of some other set.
      * A set is a subset if all its members are also present in the other set.
      * @param other - Some other set that may be a subset of this one
      * @returns Is the other set a subset of this one?
+     * @deprecated "`Set#isSubset` is deprecated in favor of the native {@linkcode Set.isSubsetOf | Set#isSubsetOf}." (since v13, until v15)
      */
-    isSubset(other: Set<T>): boolean;
+    isSubset(other: ReadonlySetLike<unknown>): boolean;
 
     /**
      * Convert a set to a JSON object by mapping its contents to an array
@@ -53,15 +41,16 @@ declare global {
 
     /**
      * Test whether every element in this Set satisfies a certain test criterion.
-     * @see {@link Array.every | `Array#every`}
+     * @see {@linkcode Array.every | Array#every}
      * @param test - The test criterion to apply. Positional arguments are the value, the index of iteration, and the set being tested.
      * @returns Does every element in the set satisfy the test criterion?
      */
+    every<S extends T>(/** @immediate */ test: (value: T, index: number, set: Set<T>) => value is S): this is Set<S>;
     every(/** @immediate */ test: (value: T, index: number, set: Set<T>) => boolean): boolean;
 
     /**
      * Filter this set to create a subset of elements which satisfy a certain test criterion.
-     * @see {@link Array.filter | `Array#filter`}
+     * @see {@linkcode Array.filter | Array#filter}
      * @param test - The test criterion to apply. Positional arguments are the value, the index of iteration, and the set being filtered.
      * @returns A new Set containing only elements which satisfy the test criterion.
      */
@@ -70,7 +59,7 @@ declare global {
 
     /**
      * Find the first element in this set which satisfies a certain test criterion.
-     * @see {@link Array.find | `Array#find`}
+     * @see {@linkcode Array.find | Array#find}
      * @param test - The test criterion to apply. Positional arguments are the value, the index of iteration, and the set being searched.
      * @returns The first element in the set which satisfies the test criterion, or undefined.
      */
@@ -79,7 +68,7 @@ declare global {
 
     /**
      * Create a new Set where every element is modified by a provided transformation function.
-     * @see {@link Array.map | `Array#map`}
+     * @see {@linkcode Array.map | Array#map}
      * @param transform - The transformation function to apply.Positional arguments are the value, the index of iteration, and the set being transformed.
      * @returns A new Set of equal size containing transformed elements.
      */
@@ -87,19 +76,16 @@ declare global {
 
     /**
      * Create a new Set with elements that are filtered and transformed by a provided reducer function.
-     * @see {@link Array.reduce | `Array#reduce`}
+     * @see {@linkcode Array.reduce | Array#reduce}
      * @param reducer - A reducer function applied to each value. Positional arguments are the accumulator, the value, the index of iteration, and the set being reduced.
-     * @param accumulator - The initial value of the returned accumulator.
+     * @param initial - The initial value of the returned accumulator.
      * @returns The final value of the accumulator.
      */
-    reduce<V>(
-      /** @immediate */ reducer: (accumulator: V, value: T, index: number, set: Set<T>) => V,
-      accumulator: V,
-    ): V;
+    reduce<V>(/** @immediate */ reducer: (accumulator: V, value: T, index: number, set: Set<T>) => V, initial: V): V;
 
     /**
      * Test whether any element in this Set satisfies a certain test criterion.
-     * @see {@link Array.some | `Array#some`}
+     * @see {@linkcode Array.some | Array#some}
      * @param test - The test criterion to apply. Positional arguments are the value, the index of iteration, and the set being tested.
      * @returns Does any element in the set satisfy the test criterion?
      */

package/src/foundry/common/primitives/string.d.mts

@@ -9,12 +9,13 @@ declare global {
 
     /**
      * Compare this string (x) with the other string (y) by comparing each character's Unicode code point value.
+     * Returns a negative Number if x \< y, a positive Number if x\> y, or a zero otherwise.
      * This is the same comparison function that used by Array#sort if the compare function argument is omitted.
      * The result is host/locale-independent.
      * @param other - The other string to compare this string to.
      * @returns A negative Number if x \< y, a positive Number if x \> y, or a zero otherwise.
      */
-    compare<S extends string>(this: S, other: string): number;
+    compare<S extends string>(this: S, other: string): -1 | 0 | 1;
 
     /**
      * Convert a string to Title Case where the first letter of each word is capitalized

package/src/foundry/common/primitives/url.d.mts

@@ -3,11 +3,15 @@ export {};
 declare global {
   // Non-functional due to upstream
   // https://github.com/microsoft/TypeScript-DOM-lib-generator/pull/1379
-  // declare const URL: {
+  // Foundry's override is redundant in 2025, as the native `URL.parse` (https://developer.mozilla.org/en-US/docs/Web/API/URL/parse_static)
+  // is a drop-in replacement
+  // const URL: {
   //   prototype: URL;
   //   new (url: string | URL, base?: string | URL): URL;
   //   createObjectURL(obj: Blob | MediaSource): string;
   //   revokeObjectURL(url: string): void;
+  //   canParse(url: string | URL, base?: string | URL): boolean;
+  //   parse(url: string | URL, base?: string | URL): URL | null;
   //   /**
   //    * Attempt to parse a URL without throwing an error.
   //    * @param url - The string to parse.

package/src/utils/index.d.mts

@@ -82,7 +82,7 @@ export type IntentionalPartial<T extends object> = Partial<T>;
  *
  * @example
  * ```ts
- * // The `const T` allows inference to be a bit more specific. This is useful for a utility type like this.`
+ * // The `const T` allows inference to be a bit more specific. This is useful for a utility type like this.
  * function takesNumber<const T>(input: OverlapsWith<T, number>): void {
  *   // This function body is an example of a method this might be useful for.
  *   // If the input isn't an number it simply returns in this case.