Function optionalShape

optionalShape<T, const AlsoUndefined extends boolean = false>(
    shape: T,
    options?: PartialWithUndefined<{ alsoUndefined: AlsoUndefined }>,
): Shape<
    TAddOptional<
        AlsoUndefined extends true
            ? TUnion<[TUndefined, ShapeInitSchema<T>]>
            : ShapeInitSchema<T>,
    >,
>
Creates a shape that allows an object property to be missing.
Type Parameters
- T
- const AlsoUndefined extends boolean = false
Parameters
- shape: T
- options: PartialWithUndefined<{ alsoUndefined: AlsoUndefined }> = {}
Returns Shape<
    TAddOptional<
        AlsoUndefined extends true
            ? TUnion<[TUndefined, ShapeInitSchema<T>]>
            : ShapeInitSchema<T>,
    >,
>
Example
```
import {optionalShape, checkValidShape, defineShape} from 'object-shape-tester';

const myShape = defineShape({
    a: '',
    b: optionalShape(-1),
});

checkValidShape({a: 'hi', b: 0}, myShape); // `true`
checkValidShape({a: 'hi'}, myShape); // `true`
checkValidShape({b: 0}, myShape); // `false`
```
- Defined in custom-shapes/optional.shape.ts:31