Interface InitializerContext

stampit.ts:40–52

The context object passed as the 2nd argument to every initializer.

/** The context object passed as the 2nd argument to every initializer. */
interface InitializerContext<I> {
  /** The object instance being produced. Returning a non-`undefined` value replaces it. */
  instance: I;
  /**
   * A reference to the Stamp producing the instance. Its statics are typed
   * loosely (`any`) on purpose: pinning them here would make `Stamp` invariant
   * in `S`, which breaks the common `let X = stampit(...); X = X.statics(...)`
   * reassignment pattern. `stamp()` still returns a precisely-typed instance.
   */
  stamp: Stamp<I, any>;
  /** All arguments passed into the Stamp, including the options argument. */
  args: any[];
}

/**
 * A function used as an `.init()` / `.initializers()` argument.