Skip to content

isWeakSet

Checks if a value is a WeakSet instance.

Available since v3.0.0

import { isWeakSet } from '@helpers4/guard';
// or, from the all-in-one package (same code, one install):
import { isWeakSet } from 'helpers4/guard';
isWeakSet(value: unknown): value is WeakSet<object>
ParameterTypeDescription
valueunknownThe value to check

value is WeakSet<object> — True if value is a WeakSet

Distinguishes WeakSet from the regular (iterable) Set.

isWeakSet(new WeakSet()) // => true
isWeakSet(new Set())     // => false

Only real WeakSet instances pass.

isWeakSet([1, 2, 3])
// => false

View source on GitHub