Function propEquals

propEquals<
    T extends Record<PropertyKey, any>,
    K extends string | number | symbol,
>(
    key: K,
    value: T[K],
): (obj: T) => boolean
Creates a predicate function that checks whether a given object's property equals the specified value.

Supports both strictly typed object structures and looser records with optional properties.

Useful for filtering arrays of objects based on property values.
Type Parameters
- T extends Record<PropertyKey, any>
  The object type with known keys (strict overload).
- K extends string | number | symbol
  The key of the property to compare.
Parameters
- key: K
  The property name to compare.
- value: T[K]
  The value to match against.
Returns (obj: T) => boolean
A predicate for use with arrays of type T.
Example
```
// Strict object structure
const isAdmin = propEquals<User, 'role'>('role', 'admin');
const admins = users.filter(isAdmin);
```
Example
```
// Loosely typed object
const isPublished = propEquals('status', 'published');
const publishedPosts = posts.filter(isPublished);
```
Since
v0.4.2
- Defined in src/lib/propUtils.mts:50
propEquals<V, K extends PropertyKey>(
key: K,
value: V,
): (obj: Partial<Record<K, V>>) => boolean
Creates a predicate function that checks whether a given object's property equals the specified value.

Supports both strictly typed object structures and looser records with optional properties.

Useful for filtering arrays of objects based on property values.
Type Parameters
- V
  The value type of the property (loose overload).
- K extends PropertyKey
  The key of the property to compare.
Parameters
- key: K
  The property name to compare.
- value: V
  The value to match against.
Returns (obj: Partial<Record<K, V>>) => boolean
A predicate for use with arrays of type T.
Example
```
// Strict object structure
const isAdmin = propEquals<User, 'role'>('role', 'admin');
const admins = users.filter(isAdmin);
```
Example
```
// Loosely typed object
const isPublished = propEquals('status', 'published');
const publishedPosts = posts.filter(isPublished);
```
Since
v0.4.2
- Defined in src/lib/propUtils.mts:51

Function propEquals

Type Parameters

Parameters

Returns (obj: T) => boolean

Example

Example

Since

Type Parameters

Parameters

Returns (obj: Partial<Record<K, V>>) => boolean

Example

Example

Since

Settings