Method load

src/plugin.ts:179–227

()

  }

  public async load(): Promise<void> {
    const context = this.loadContext!
    assert(context, 'Reached illegal state. Plugin state is undefined!')
    this.loadContext = undefined // free up memory

    // pluck out the Homebridge version requirement
    if (!context.engines || !context.engines.homebridge) {
      throw new Error(`Plugin ${this.pluginPath} does not contain the 'homebridge' package in 'engines'.`)
    }

    const versionRequired = context.engines.homebridge
    const nodeVersionRequired = context.engines.node

    // make sure the version is satisfied by the currently running version of Homebridge
    if (!satisfies(getVersion(), versionRequired, { includePrerelease: true })) {
      // TODO - change this back to an error
      log.warn(`The plugin "${this.pluginName}" requires a Homebridge version of ${versionRequired} which does \
not satisfy the current Homebridge version of v${getVersion()}. You may need to update this plugin (or Homebridge) to a newer version. \
You may face unexpected issues or stability problems running this plugin.`)
    }

    // make sure the version is satisfied by the currently running version of Node
    if (nodeVersionRequired && !satisfies(process.version, nodeVersionRequired)) {
      log.warn(`The plugin "${this.pluginName}" requires a Node.js version of ${nodeVersionRequired} which does \
not satisfy the current Node.js version of ${process.version}. You may need to upgrade your installation of Node.js - see https://homebridge.io/w/JTKEF`)
    }

    const dependencies = context.dependencies || {}
    if (dependencies.homebridge || dependencies['hap-nodejs'] || dependencies['@homebridge/hap-nodejs']) {
      log.error(`The plugin "${this.pluginName}" defines 'homebridge' and/or 'hap-nodejs' in their 'dependencies' section, \
meaning they carry an additional copy of homebridge and hap-nodejs. This not only wastes disk space, but also can cause \
major incompatibility issues and thus is considered bad practice. Please inform the developer to update their plugin!`)
    }

    const mainPath = join(this.pluginPath, this.main)

    // try to import it and grab the exported initialization hook
    // pathToFileURL(specifier).href to turn a path into a "file url"
    // see https://github.com/nodejs/node/issues/31710
    const pluginModules = (await import(pathToFileURL(mainPath).href)).default

    if (typeof pluginModules === 'function') {
      this.pluginInitializer = pluginModules
    } else if (pluginModules && typeof pluginModules.default === 'function') {
      this.pluginInitializer = pluginModules.default
    } else {
      throw new Error(`Plugin ${this.pluginPath} does not export a initializer function from main.`)
    }
  }

  public initialize(api: API): void | Promise<void> {
    if (!this.pluginInitializer) {