Function record

record<
    input,
    const pvalue extends

            | readonly []
            | readonly [unknown, unknown]
            | readonly [unknown, unknown]
            | UnknownProperties
            | Primitives
            | UnknownMatcher
            | readonly UnknownValuePattern[]
            | readonly [UnknownValuePattern, UnknownValuePattern]
            | readonly [UnknownValuePattern, UnknownValuePattern]
            | PatternMatcher<UnwrapRecordValue<input>>
            | {
                readonly [k in string | number | symbol]?: Pattern.Pattern<
                    Readonly<
                        MergeUnion<
                            Exclude<
                                UnwrapRecordValue<input>,
                                (readonly any[] | Primitives | Map<any, any> | Set<any>),
                            >,
                        >,
                    >[k],
                >
            },
>(
    patternValue: pvalue,
): Chainable<RecordP<input, StringPattern, pvalue>>
P.record(keyPattern, valuePattern) takes a subpattern to match against the key, a subpattern to match against the value and returns a pattern that matches on objects where all entries match those two subpatterns.

Read P.record documentation on GitHub
Type Parameters
- input
- const pvalue extends
      | readonly []
      | readonly [unknown, unknown]
      | readonly [unknown, unknown]
      | UnknownProperties
      | Primitives
      | UnknownMatcher
      | readonly UnknownValuePattern[]
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | PatternMatcher<UnwrapRecordValue<input>>
      | {
          readonly [k in string | number | symbol]?: Pattern.Pattern<
              Readonly<
                  MergeUnion<
                      Exclude<
                          UnwrapRecordValue<input>,
                          (readonly any[] | Primitives | Map<any, any> | Set<any>),
                      >,
                  >,
              >[k],
          >
      }
Parameters
- patternValue: pvalue
Returns Chainable<RecordP<input, StringPattern, pvalue>>
Example
```
match(value)
  .with({ users: P.record(P.string, P.number) }, (obj) => `object's type is Record<string, number>`)
```
- Defined in node_modules/ts-pattern/dist/patterns.d.ts:150
record<
    input,
    const pkey extends

            | string
            | number
            | bigint
            | boolean
            | symbol
            | readonly []
            | readonly [unknown, unknown]
            | readonly [unknown, unknown]
            | UnknownProperties
            | UnknownMatcher
            | readonly [UnknownValuePattern, UnknownValuePattern]
            | readonly [UnknownValuePattern, UnknownValuePattern]
            | PatternMatcher<WithDefault<UnwrapRecordKey<input>, PropertyKey>>
            | {
                readonly [k in string | number | symbol]?: Pattern.Pattern<
                    Readonly<
                        MergeUnion<
                            Exclude<
                                WithDefault<UnwrapRecordKey<input>, PropertyKey>,
                                readonly any[] | Primitives | Map<any, any> | Set<any>,
                            >,
                        >,
                    >[k],
                >
            }
            | null
            | undefined,
    const pvalue extends
        | readonly []
        | readonly [unknown, unknown]
        | readonly [unknown, unknown]
        | UnknownProperties
        | Primitives
        | UnknownMatcher
        | readonly UnknownValuePattern[]
        | readonly [UnknownValuePattern, UnknownValuePattern]
        | readonly [UnknownValuePattern, UnknownValuePattern]
        | PatternMatcher<WithDefault<UnwrapRecordValue<input>, unknown>>
        | {
            readonly [k in string | number | symbol]?: Pattern.Pattern<
                Readonly<
                    MergeUnion<
                        Exclude<
                            WithDefault<UnwrapRecordValue<input>, unknown>,
                            (readonly any[] | Primitives | Map<any, any> | Set<any>),
                        >,
                    >,
                >[k],
            >
        },
>(
    patternKey: pkey,
    patternValue?: pvalue,
): Chainable<RecordP<input, pkey, pvalue>>
P.record(keyPattern, valuePattern) takes a subpattern to match against the key, a subpattern to match against the value and returns a pattern that matches on objects where all entries match those two subpatterns.

Read P.record documentation on GitHub
Type Parameters
- input
- const pkey extends
      | string
      | number
      | bigint
      | boolean
      | symbol
      | readonly []
      | readonly [unknown, unknown]
      | readonly [unknown, unknown]
      | UnknownProperties
      | UnknownMatcher
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | PatternMatcher<WithDefault<UnwrapRecordKey<input>, PropertyKey>>
      | {
          readonly [k in string | number | symbol]?: Pattern.Pattern<
              Readonly<
                  MergeUnion<
                      Exclude<
                          WithDefault<UnwrapRecordKey<input>, PropertyKey>,
                          readonly any[] | Primitives | Map<any, any> | Set<any>,
                      >,
                  >,
              >[k],
          >
      }
      | null
      | undefined
- const pvalue extends
      | readonly []
      | readonly [unknown, unknown]
      | readonly [unknown, unknown]
      | UnknownProperties
      | Primitives
      | UnknownMatcher
      | readonly UnknownValuePattern[]
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | readonly [UnknownValuePattern, UnknownValuePattern]
      | PatternMatcher<WithDefault<UnwrapRecordValue<input>, unknown>>
      | {
          readonly [k in string | number | symbol]?: Pattern.Pattern<
              Readonly<
                  MergeUnion<
                      Exclude<
                          WithDefault<UnwrapRecordValue<input>, unknown>,
                          (readonly any[] | Primitives | Map<any, any> | Set<any>),
                      >,
                  >,
              >[k],
          >
      }
Parameters
- patternKey: pkey
- OptionalpatternValue: pvalue
Returns Chainable<RecordP<input, pkey, pvalue>>
Example
```
match(value)
  .with({ users: P.record(P.string, P.number) }, (obj) => `object's type is Record<string, number>`)
```
- Defined in node_modules/ts-pattern/dist/patterns.d.ts:151

Function record

Type Parameters

Parameters

Returns Chainable<RecordP<input, StringPattern, pvalue>>

Example

Type Parameters

Parameters

Returns Chainable<RecordP<input, pkey, pvalue>>

Example

Settings