Type Alias ContextBuilder<Init, Ctx>

type ContextBuilder<Init extends ContextBaseShape, Ctx extends ContextBaseShape> = {
    build(): Ctx;
    extend<Additional extends ContextBaseShape = ContextBaseShape>(
        extender: ContextExtender<Ctx, Additional>,
    ): ContextBuilder<Init, LeftJoin<Ctx, Additional>>;
}

Type Parameters

Init extends ContextBaseShape
Ctx extends ContextBaseShape

Index

Methods

Methods

build

build(): Ctx
Build and return the context.

Returns Ctx
- Defined in packages/type-plus/src/functional/context.ts:34

extend

extend<Additional extends ContextBaseShape = ContextBaseShape>(
extender: ContextExtender<Ctx, Additional>,
): ContextBuilder<Init, LeftJoin<Ctx, Additional>>
Extends the context using an extender.
Type Parameters
- Additional extends ContextBaseShape = ContextBaseShape
Parameters
- extender: ContextExtender<Ctx, Additional>
  function that add new props to the context.
  
  The extender only need to return a new object with additional properties. The builder will merge that with the current context.
  
  If the extender specify an existing property, it overrides the existing value.
Returns ContextBuilder<Init, LeftJoin<Ctx, Additional>>
- Defined in packages/type-plus/src/functional/context.ts:28