Type alias InitializeOptions

InitializeOptions: {
    network: Omit<Resources.Input<"networks">, "networkId" | "historicBlock">;
    settings?: IncludeSettings;
} & ({
    db: Db;
    provider: Provider;
} | ReturnType<ReturnType<typeof forDb>["forProvider"]>)

Options for constructing a [[Network]] abstraction, required by [[initialize | initialize()]].

These options must include either:

  • db, a [[Db]] instance and provider, JSON-RPC provider (for normal use), or
  • run, a provider-enabled [[Process.ProcessorRunner]] function, e.g. one instantiated via [[Process.Run.forDb]] (for internal/special-case use).

In addition, these options must contain network with name information, as per the [[DataModel.NetworkInput | Network input]] specification.

Optionally this may include settings to specify [[IncludeSettings]].

Type declaration

Generated using TypeDoc