Function when

when<input, predicate extends (value: input) => unknown>(
    predicate: predicate,
): GuardP<
    input,
    predicate extends (value: any) => value is narrowed ? narrowed : never,
>
P.when((value) => boolean) returns a pattern which matches if the predicate returns true for the current input.

Read the documentation for P.when on GitHub
Type Parameters
- input
- predicate extends (value: input) => unknown
Parameters
- predicate: predicate
Returns GuardP<
input,
predicate extends (value: any) => value is narrowed ? narrowed : never,
>
Example
```
match<{ age: number }>(value)
  .with({ age: P.when(age => age > 21) }, (x) => 'will match if value.age > 21'
  )
```
- Defined in node_modules/ts-pattern/dist/patterns.d.ts:193
when<input, narrowed, excluded>(
predicate: (input: input) => input is narrowed,
): GuardExcludeP<input, narrowed, excluded>
P.when((value) => boolean) returns a pattern which matches if the predicate returns true for the current input.

Read the documentation for P.when on GitHub
Type Parameters
- input
- narrowed
- excluded
Parameters
- predicate: (input: input) => input is narrowed
Returns GuardExcludeP<input, narrowed, excluded>
Example
```
match<{ age: number }>(value)
  .with({ age: P.when(age => age > 21) }, (x) => 'will match if value.age > 21'
  )
```
- Defined in node_modules/ts-pattern/dist/patterns.d.ts:194