Function withOuterOption

withOuterOption<
    K extends
        | "Of"
        | "Invariant"
        | "Covariant"
        | "Applicative"
        | "Foldable"
        | "Traversable",
    Class extends TypeLambda,
    F extends TypeLambda,
    A,
    B = A,
    C = A,
    R = never,
    O = unknown,
    E = unknown,
>(
    key: K,
    given: ParameterizedGiven<Class, F, A, B, C, R, O, E>,
    optionInstance: Kind<Class, R, O, E, OptionTypeLambda>,
): readonly [
    `${K}Composition.${string}`,
    ParameterizedGiven<
        Class,
        ComposeTypeLambda<OptionTypeLambda, F, R, O, E, R, O, E>,
        A,
        B,
        C,
        R,
        O,
        E,
    >,
]
Return the given options transformed into options for a composed typeclass test, where the outer composed datatype is an Option.

For example if we are testing Covariant laws on MyTuple, and the underlying types are all number, then the correct given type required for these tests, is ParameterizedGiven<CovariantTypeLambda, MyTupleLambda, number>.

If we wanted to run the same law test but on a composed instance of MyTuple inside an Option, then we could use this function to convert the options to the required type. Then we can run these new options to test typeclass laws on the composed instance.
Type Parameters
- K extends "Of" | "Invariant" | "Covariant" | "Applicative" | "Foldable" | "Traversable"
- Class extends TypeLambda
- F extends TypeLambda
- A
- B = A
- C = A
- R = never
- O = unknown
- E = unknown
Parameters
- key: K
  Type of composition requested: Of, Invariant, Covariant, Applicative, or Traversable. The Option datatype can do all of them.
- given: ParameterizedGiven<Class, F, A, B, C, R, O, E>
  The original ParameterizedGiven for the typeclass under test as it is before composition.
- optionInstance: Kind<Class, R, O, E, OptionTypeLambda>
  The instance of Option for the typeclass under test.
Returns readonly [
    `${K}Composition.${string}`,
    ParameterizedGiven<
        Class,
        ComposeTypeLambda<OptionTypeLambda, F, R, O, E, R, O, E>,
        A,
        B,
        C,
        R,
        O,
        E,
    >,
]
Typeclass test options for the F datatype when it is wrapped in an Option.
- Defined in src/laws/typeclass/parameterized/compose.ts:75

Function withOuterOption

Type Parameters

Parameters

Returns readonly [ `${K}Composition.${string}`, ParameterizedGiven< Class, ComposeTypeLambda<OptionTypeLambda, F, R, O, E, R, O, E>, A, B, C, R, O, E, >,]

Settings

Returns readonly [
`${K}Composition.${string}`,
ParameterizedGiven<
Class,
ComposeTypeLambda<OptionTypeLambda, F, R, O, E, R, O, E>,
A,
B,
C,
R,
O,
E,
>,
]