Skip to main content

isWeakSet()

isWeakSet(value): value is WeakSet<any>

Checks if value is a WeakSet.

DEPRECATED

Use instanceof WeakSet directly instead.


Parameters​

value: unknown​

The value to check.


Returns: value is WeakSet<any>​

true if value is a WeakSet, else false.


See Also​

WeakSet - MDN


Since​

2.0.0


Also known as​

isWeakSet (Lodash, es-toolkit) · ❌ (Remeda, Radashi, Ramda, Effect, Modern Dash, Antfu)


Example​

// ❌ Deprecated approach
isWeakSet(new WeakSet()); // => true
isWeakSet(new Set()); // => false

// βœ… Recommended approach
new WeakSet() instanceof WeakSet; // => true
new Set() instanceof WeakSet; // => false

How it works?​

Checks if value is a WeakSet. Deprecated: Use instanceof WeakSet directly.

Native Equivalent​

// ❌ isWeakSet(value)
// βœ… value instanceof WeakSet

Use Cases​

Check WeakSet πŸ“Œβ€‹

Check if value is a WeakSet.

new WeakSet() instanceof WeakSet;  // true
new Set() instanceof WeakSet; // false

Type detection​

Identify collection type for serialization.

function getCollectionType(value: unknown) {
if (value instanceof WeakSet) return 'WeakSet';
if (value instanceof Set) return 'Set';
if (Array.isArray(value)) return 'Array';
return 'unknown';
}