ember-source/types/stable/@ember/service/index.d.ts

A JavaScript framework for creating ambitious web applications

declare module '@ember/service' {
  import { FrameworkObject } from '@ember/object/-internals';
  import type { DecoratorPropertyDescriptor, ElementDescriptor } from '@ember/-internals/metal';
  /**
     @module @ember/service
     @public
     */
  /**
      @method inject
      @static
      @since 1.10.0
      @for @ember/service
      @param {String} name (optional) name of the service to inject, defaults to
             the property's name
      @return {ComputedDecorator} injection decorator instance
      @public
    */
  export function inject(name: string): PropertyDecorator;
  export function inject(...args: [ElementDescriptor[0], ElementDescriptor[1]]): void;
  export function inject(...args: ElementDescriptor): DecoratorPropertyDescriptor;
  export function inject(): PropertyDecorator;
  /**
      Creates a property that lazily looks up a service in the container. There are
      no restrictions as to what objects a service can be injected into.

      Example:

      ```app/routes/application.js
      import Route from '@ember/routing/route';
      import { service } from '@ember/service';

      export default class ApplicationRoute extends Route {
        @service('auth') authManager;

        model() {
          return this.authManager.findCurrentUser();
        }
      }
      ```

      Classic Class Example:

      ```app/routes/application.js
      import Route from '@ember/routing/route';
      import { service } from '@ember/service';

      export default Route.extend({
        authManager: service('auth'),

        model() {
          return this.get('authManager').findCurrentUser();
        }
      });
      ```

      This example will create an `authManager` property on the application route
      that looks up the `auth` service in the container, making it easily accessible
      in the `model` hook.

      @method service
      @static
      @since 4.1.0
      @for @ember/service
      @param {String} name (optional) name of the service to inject, defaults to
             the property's name
      @return {ComputedDecorator} injection decorator instance
      @public
    */
  export function service(name: string): PropertyDecorator;
  export function service(...args: [ElementDescriptor[0], ElementDescriptor[1]]): void;
  export function service(...args: ElementDescriptor): DecoratorPropertyDescriptor;
  export function service(): PropertyDecorator;
  /**
      @class Service
      @extends EmberObject
      @since 1.10.0
      @public
    */
  export default class Service extends FrameworkObject {
    static isServiceFactory: boolean;
  }
  /**
      A type registry for Ember `Service`s. Meant to be declaration-merged so string
      lookups resolve to the correct type.

      Blueprints should include such a declaration merge for TypeScript:

      ```ts
      import Service from '@ember/service';

      export default class ExampleService extends Service {
        // ...
      }

      declare module '@ember/service' {
        export interface Registry {
          example: ExampleService;
        }
      }
      ```

      Then `@service` can check that the service is registered correctly, and APIs
      like `owner.lookup('service:example')` can return `ExampleService`.
     */
  export interface Registry extends Record<string, object | undefined> {}
}