@ideal-postcodes/address-finder
    Preparing search index...

    Variable AddressFinderConst

    AddressFinder: {
        Controller: typeof Controller;
        controllers: Controller[];
        defaults: Omit<StoredOptions, "document" | "scope">;
        go: (config: ControllerOptions, d?: Document) => Promise<Controller | null>;
        setup: (config: ControllerOptions) => Controller;
        watch: Watch;
    } = ...

    Namespace that exports Address Finder methods and classes

    Type Declaration

    • Controller: typeof Controller
    • controllers: Controller[]

      Cache of Address Finder controllers

    • defaults: Omit<StoredOptions, "document" | "scope">

      Default options assigned to controller instances

    • go: (config: ControllerOptions, d?: Document) => Promise<Controller | null>

      Configure and launch an instance of the Address Finder

      This is equivalent to invoking setup except inside a DOMContentLoaded event callback

    • setup: (config: ControllerOptions) => Controller

      Configure and launch an instance of the Address Finder

      This method will create and return a new AddressFinder instance. It will also add a global reference to the controller at AddressFinder.controllers

    • watch: Watch

      Dynamically apply AddressFinder when relevant fields appear

      • Exits if page test is fails
      • Check if key usable
      • Creates a bind method
      • Retrives parent scope
      • Marks anchor if completed
      • Creates timer tools