mirror of
https://github.com/toss/es-toolkit.git
synced 2024-11-28 03:34:26 +03:00
35 lines
823 B
Markdown
35 lines
823 B
Markdown
# isWeakSet
|
|
|
|
Checks if the given value is a `WeakSet`.
|
|
|
|
This function tests whether the provided value is an instance of `WeakSet`.
|
|
It returns `true` if the value is a `WeakSet`, and `false` otherwise.
|
|
|
|
This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `WeakSet`.
|
|
|
|
## Signature
|
|
|
|
```typescript
|
|
function isWeakSet(value: unknown): value is WeakSet<WeakKey>;
|
|
```
|
|
|
|
### Parameters
|
|
|
|
`value` (`unknown`): The value to test if it is a `WeakSet`.
|
|
|
|
### Returns
|
|
|
|
(`value is WeakSet<WeakKey>`): true if the value is a `WeakSet`, false otherwise.
|
|
|
|
## Examples
|
|
|
|
```typescript
|
|
const value1 = new WeakSet();
|
|
const value2 = new Map();
|
|
const value3 = new Set();
|
|
|
|
console.log(isWeakSet(value1)); // true
|
|
console.log(isWeakSet(value2)); // false
|
|
console.log(isWeakSet(value3)); // false
|
|
```
|