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';
}