Function pickShape

pickShape<
    const OriginalShape extends object,
    const Selection extends
        Readonly<Partial<Record<keyof ShapeInitType<OriginalShape>, boolean>>>,
>(
    originalShape: OriginalShape,
    selection: Selection & Readonly<
        {
            [Key in string
            | number
            | symbol]: Key extends NoInfer<keyof ShapeInitType<OriginalShape>>
                ? NoInfer<Selection>[Key<Key>]
                : never
        },
    >,
): Shape<
    TPick<
        ShapeInitSchema<OriginalShape>,
        (
            keyof {
                [Key in string
                | number
                | symbol as Selection[Key] extends true
                    ? Key
                    : true extends Selection[Key] ? Key : never]: Key
            }
        )[],
    >,
>
Creates a shape by picking specific keys off of another object shape.
Type Parameters
- const OriginalShape extends object
- const Selection extends Readonly<Partial<Record<keyof ShapeInitType<OriginalShape>, boolean>>>
Parameters
- originalShape: OriginalShape
- selection: Selection & Readonly<
      {
          [Key in string
          | number
          | symbol]: Key extends NoInfer<keyof ShapeInitType<OriginalShape>>
              ? NoInfer<Selection>[Key<Key>]
              : never
      },
  >
Returns Shape<
    TPick<
        ShapeInitSchema<OriginalShape>,
        (
            keyof {
                [Key in string
                | number
                | symbol as Selection[Key] extends true
                    ? Key
                    : true extends Selection[Key] ? Key : never]: Key
            }
        )[],
    >,
>
Example
```
import {pickShape, checkValidShape} from 'object-shape-tester';

const myShape = pickShape(
    {
        hi: '',
        bye: -1,
    },
    {
        hi: true,
    },
);

checkValidShape(
    {
        hi: 'some value',
    },
    myShape,
); // `true`
checkValidShape(
    {
        hi: 'some value',
        bye: 100,
    },
    myShape,
); // `false`
```
- Defined in custom-shapes/pick.shape.ts:60

Function pickShape

Type Parameters

Parameters

Returns Shape< TPick< ShapeInitSchema<OriginalShape>, ( keyof { [Key in string | number | symbol as Selection[Key] extends true ? Key : true extends Selection[Key] ? Key : never]: Key } )[], >,>

Example

Settings

Returns Shape<
TPick<
ShapeInitSchema<OriginalShape>,
(
keyof {
[Key in string
| number
| symbol as Selection[Key] extends true
? Key
: true extends Selection[Key] ? Key : never]: Key
}
)[],
>,
>