ember-source/types/stable/@ember/debug/container-debug-adapter.d.ts

A JavaScript framework for creating ambitious web applications

declare module '@ember/debug/container-debug-adapter' {
    import EmberObject from "@ember/object";
    import type Owner from "@ember/owner";
    import type { Resolver } from "@ember/owner";
    /**
    @module @ember/debug/container-debug-adapter
    */
    /**
      The `ContainerDebugAdapter` helps the container and resolver interface
      with tools that debug Ember such as the
      [Ember Inspector](https://github.com/emberjs/ember-inspector)
      for Chrome and Firefox.

      This class can be extended by a custom resolver implementer
      to override some of the methods with library-specific code.

      The methods likely to be overridden are:

      * `canCatalogEntriesByType`
      * `catalogEntriesByType`

      The adapter will need to be registered
      in the application's container as `container-debug-adapter:main`.

      Example:

      ```javascript
      Application.initializer({
        name: "containerDebugAdapter",

        initialize(application) {
          application.register('container-debug-adapter:main', require('app/container-debug-adapter'));
        }
      });
      ```

      @class ContainerDebugAdapter
      @extends EmberObject
      @since 1.5.0
      @public
    */
    export default class ContainerDebugAdapter extends EmberObject {
        constructor(owner: Owner);
        /**
          The resolver instance of the application
          being debugged. This property will be injected
          on creation.
      
          @property resolver
          @public
        */
        resolver: Resolver;
        /**
          Returns true if it is possible to catalog a list of available
          classes in the resolver for a given type.
      
          @method canCatalogEntriesByType
          @param {String} type The type. e.g. "model", "controller", "route".
          @return {boolean} whether a list is available for this type.
          @public
        */
        canCatalogEntriesByType(type: string): boolean;
        /**
          Returns the available classes a given type.
      
          @method catalogEntriesByType
          @param {String} type The type. e.g. "model", "controller", "route".
          @return {Array} An array of strings.
          @public
        */
        catalogEntriesByType(type: string): string[];
    }
}