Function property

Creates a predicate function Predicate for use in the dimension function to create a Dimension matching properties.

Example

The following code creates a Dimension that will be used to evaluate Player objects during a pivot operation based on the value of their position property:

const positions: string[] = ['Goalkeeper', 'Defender', 'Midfielder', 'Forward'];
const x = dimension(positions, property<Player>('position'));

See GitHub for a complete example.

property<TValue>(
key: keyof TValue,
): Function<TValue[keyof TValue], Predicate<TValue>>
Type Parameters
- TValue
  The type of the source data that will be evaluated by the generated predicate.
Parameters
- key: keyof TValue
  The property in the source data to base this Predicate on.
Returns Function<TValue[keyof TValue], Predicate<TValue>>
- Defined in index.ts:86

Function property

Example

Type Parameters

Parameters

Returns Function<TValue[keyof TValue], Predicate<TValue>>

Settings