All files / set/src isSet.ts

100% Statements 3/3
100% Branches 0/0
100% Functions 2/2
100% Lines 2/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25                                          11x 11x    
/**
 * Checks if a `value` is a {@link Set}.
 *
 * @example
 * Returns `true` if the value if a {@link Set}
 * ```ts
 * const result = isSet(new Set());
 * console.log(result); // true
 * ```
 *
 * @example
 * Returns `false` if the value is not as {@link Set}
 * ```ts
 * const result = isSet([]);
 * console.log(result); // false
 * ```
 *
 * @typeParam T - the {@link Set} element type
 * @param value - the value to check
 * @returns `true` if `value` is a {@link Set}, otherwise `false`
 */
export const isSet = <T>(value: unknown): value is Set<T> => {
  return value instanceof Set;
};