static-injector 1.0.8

package/import/typings/di/interface/provider.d.ts

@@ -0,0 +1,312 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { Type } from "../../interface/type";
+/**
+ * Configures the `Injector` to return a value for a token.
+ * Base for `ValueProvider` decorator.
+ *
+ * @publicApi
+ */
+export interface ValueSansProvider {
+    /**
+     * The value to inject.
+     */
+    useValue: any;
+}
+/**
+ * Configures the `Injector` to return a value for a token.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * ### Example
+ *
+ * {@example core/di/ts/provider_spec.ts region='ValueProvider'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface ValueProvider extends ValueSansProvider {
+    /**
+     * An injection token. Typically an instance of `Type` or `InjectionToken`, but can be `any`.
+     */
+    provide: any;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Configures the `Injector` to return an instance of `useClass` for a token.
+ * Base for `StaticClassProvider` decorator.
+ *
+ * @publicApi
+ */
+export interface StaticClassSansProvider {
+    /**
+     * An optional class to instantiate for the `token`. By default, the `provide`
+     * class is instantiated.
+     */
+    useClass: Type<any>;
+    /**
+     * A list of `token`s to be resolved by the injector. The list of values is then
+     * used as arguments to the `useClass` constructor.
+     */
+    deps: any[];
+}
+/**
+ * Configures the `Injector` to return an instance of `useClass` for a token.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='StaticClassProvider'}
+ *
+ * Note that following two providers are not equal:
+ *
+ * {@example core/di/ts/provider_spec.ts region='StaticClassProviderDifference'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface StaticClassProvider extends StaticClassSansProvider {
+    /**
+     * An injection token. Typically an instance of `Type` or `InjectionToken`, but can be `any`.
+     */
+    provide: any;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Configures the `Injector` to return an instance of a token.
+ *
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * ```ts
+ * @Injectable(SomeModule, {deps: []})
+ * class MyService {}
+ * ```
+ *
+ * @publicApi
+ */
+export interface ConstructorSansProvider {
+    /**
+     * A list of `token`s to be resolved by the injector.
+     */
+    deps?: any[];
+}
+/**
+ * Configures the `Injector` to return an instance of a token.
+ *
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='ConstructorProvider'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface ConstructorProvider extends ConstructorSansProvider {
+    /**
+     * An injection token. Typically an instance of `Type` or `InjectionToken`, but can be `any`.
+     */
+    provide: Type<any>;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Configures the `Injector` to return a value of another `useExisting` token.
+ *
+ * @see `ExistingProvider`
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @publicApi
+ */
+export interface ExistingSansProvider {
+    /**
+     * Existing `token` to return. (Equivalent to `injector.get(useExisting)`)
+     */
+    useExisting: any;
+}
+/**
+ * Configures the `Injector` to return a value of another `useExisting` token.
+ *
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='ExistingProvider'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface ExistingProvider extends ExistingSansProvider {
+    /**
+     * An injection token. Typically an instance of `Type` or `InjectionToken`, but can be `any`.
+     */
+    provide: any;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Configures the `Injector` to return a value by invoking a `useFactory` function.
+ *
+ * @see `FactoryProvider`
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @publicApi
+ */
+export interface FactorySansProvider {
+    /**
+     * A function to invoke to create a value for this `token`. The function is invoked with
+     * resolved values of `token`s in the `deps` field.
+     */
+    useFactory: Function;
+    /**
+     * A list of `token`s to be resolved by the injector. The list of values is then
+     * used as arguments to the `useFactory` function.
+     */
+    deps?: any[];
+}
+/**
+ * Configures the `Injector` to return a value by invoking a `useFactory` function.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='FactoryProvider'}
+ *
+ * Dependencies can also be marked as optional:
+ *
+ * {@example core/di/ts/provider_spec.ts region='FactoryProviderOptionalDeps'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface FactoryProvider extends FactorySansProvider {
+    /**
+     * An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
+     */
+    provide: any;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Describes how an `Injector` should be configured as static (that is, without reflection).
+ * A static provider provides tokens to an injector for various types of dependencies.
+ *
+ * @see `Injector.create()`.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection-providers).
+ *
+ * @publicApi
+ */
+export declare type StaticProvider = ValueProvider | ExistingProvider | StaticClassProvider | ConstructorProvider | FactoryProvider | any[];
+/**
+ * Configures the `Injector` to return an instance of `Type` when `Type' is used as the token.
+ *
+ * Create an instance by invoking the `new` operator and supplying additional arguments.
+ * This form is a short form of `TypeProvider`;
+ *
+ * For more details, see the ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='TypeProvider'}
+ *
+ * @publicApi
+ */
+export interface TypeProvider extends Type<any> {
+}
+/**
+ * Configures the `Injector` to return a value by invoking a `useClass` function.
+ * Base for `ClassProvider` decorator.
+ *
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @publicApi
+ */
+export interface ClassSansProvider {
+    /**
+     * Class to instantiate for the `token`.
+     */
+    useClass: Type<any>;
+}
+/**
+ * Configures the `Injector` to return an instance of `useClass` for a token.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @usageNotes
+ *
+ * {@example core/di/ts/provider_spec.ts region='ClassProvider'}
+ *
+ * Note that following two providers are not equal:
+ *
+ * {@example core/di/ts/provider_spec.ts region='ClassProviderDifference'}
+ *
+ * ### Multi-value example
+ *
+ * {@example core/di/ts/provider_spec.ts region='MultiProviderAspect'}
+ *
+ * @publicApi
+ */
+export interface ClassProvider extends ClassSansProvider {
+    /**
+     * An injection token. (Typically an instance of `Type` or `InjectionToken`, but can be `any`).
+     */
+    provide: any;
+    /**
+     * When true, injector returns an array of instances. This is useful to allow multiple
+     * providers spread across many files to provide configuration information to a common token.
+     */
+    multi?: boolean;
+}
+/**
+ * Describes how the `Injector` should be configured.
+ * @see ["Dependency Injection Guide"](guide/dependency-injection).
+ *
+ * @see `StaticProvider`
+ *
+ * @publicApi
+ */
+export declare type Provider = TypeProvider | ValueProvider | ClassProvider | ConstructorProvider | ExistingProvider | FactoryProvider | any[];
+/**
+ * Describes a function that is used to process provider lists (such as provider
+ * overrides).
+ */
+export declare type ProcessProvidersFunction = (providers: Provider[]) => Provider[];

package/import/typings/di/metadata.d.ts

@@ -0,0 +1,176 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+/**
+ * Type of the Inject decorator / constructor function.
+ *
+ * @publicApi
+ */
+export interface InjectDecorator {
+    /**
+     * Parameter decorator on a dependency parameter of a class constructor
+     * that specifies a custom provider of the dependency.
+     *
+     * @usageNotes
+     * The following example shows a class constructor that specifies a
+     * custom provider of a dependency using the parameter decorator.
+     *
+     * When `@Inject()` is not present, the injector uses the type annotation of the
+     * parameter as the provider.
+     *
+     * <code-example path="core/di/ts/metadata_spec.ts" region="InjectWithoutDecorator">
+     * </code-example>
+     *
+     * @see ["Dependency Injection Guide"](guide/dependency-injection)
+     *
+     */
+    (token: any): any;
+    new (token: any): Inject;
+}
+/**
+ * Type of the Inject metadata.
+ *
+ * @publicApi
+ */
+export interface Inject {
+    /**
+     * A [DI token](guide/glossary#di-token) that maps to the dependency to be injected.
+     */
+    token: any;
+}
+/**
+ * Inject decorator and metadata.
+ *
+ * @Annotation
+ * @publicApi
+ */
+export declare const Inject: InjectDecorator;
+/**
+ * Type of the Optional decorator / constructor function.
+ *
+ * @publicApi
+ */
+export interface OptionalDecorator {
+    /**
+     * Parameter decorator to be used on constructor parameters,
+     * which marks the parameter as being an optional dependency.
+     * The DI framework provides `null` if the dependency is not found.
+     *
+     * Can be used together with other parameter decorators
+     * that modify how dependency injection operates.
+     *
+     * @usageNotes
+     *
+     * The following code allows the possibility of a `null` result:
+     *
+     * <code-example path="core/di/ts/metadata_spec.ts" region="Optional">
+     * </code-example>
+     *
+     * @see ["Dependency Injection Guide"](guide/dependency-injection).
+     */
+    (): any;
+    new (): Optional;
+}
+/**
+ * Type of the Optional metadata.
+ *
+ * @publicApi
+ */
+export interface Optional {
+}
+/**
+ * Optional decorator and metadata.
+ *
+ * @Annotation
+ * @publicApi
+ */
+export declare const Optional: OptionalDecorator;
+/**
+ * Type of the Self decorator / constructor function.
+ *
+ * @publicApi
+ */
+export interface SelfDecorator {
+    /**
+     * Parameter decorator to be used on constructor parameters,
+     * which tells the DI framework to start dependency resolution from the local injector.
+     *
+     * Resolution works upward through the injector hierarchy, so the children
+     * of this class must configure their own providers or be prepared for a `null` result.
+     *
+     * @usageNotes
+     *
+     * In the following example, the dependency can be resolved
+     * by the local injector when instantiating the class itself, but not
+     * when instantiating a child.
+     *
+     * <code-example path="core/di/ts/metadata_spec.ts" region="Self">
+     * </code-example>
+     *
+     * @see `SkipSelf`
+     * @see `Optional`
+     *
+     */
+    (): any;
+    new (): Self;
+}
+/**
+ * Type of the Self metadata.
+ *
+ * @publicApi
+ */
+export interface Self {
+}
+/**
+ * Self decorator and metadata.
+ *
+ * @Annotation
+ * @publicApi
+ */
+export declare const Self: SelfDecorator;
+/**
+ * Type of the `SkipSelf` decorator / constructor function.
+ *
+ * @publicApi
+ */
+export interface SkipSelfDecorator {
+    /**
+     * Parameter decorator to be used on constructor parameters,
+     * which tells the DI framework to start dependency resolution from the parent injector.
+     * Resolution works upward through the injector hierarchy, so the local injector
+     * is not checked for a provider.
+     *
+     * @usageNotes
+     *
+     * In the following example, the dependency can be resolved when
+     * instantiating a child, but not when instantiating the class itself.
+     *
+     * <code-example path="core/di/ts/metadata_spec.ts" region="SkipSelf">
+     * </code-example>
+     *
+     * @see [Dependency Injection guide](guide/dependency-injection-in-action#skip).
+     * @see `Self`
+     * @see `Optional`
+     *
+     */
+    (): any;
+    new (): SkipSelf;
+}
+/**
+ * Type of the `SkipSelf` metadata.
+ *
+ * @publicApi
+ */
+export interface SkipSelf {
+}
+/**
+ * `SkipSelf` decorator and metadata.
+ *
+ * @Annotation
+ * @publicApi
+ */
+export declare const SkipSelf: SkipSelfDecorator;