@angular/core

@angular/core

Version 17.0.5
Published 3 days ago
23.7 MB
1 dependency
MIT license

Install

npm i @angular/core

yarn add @angular/core

pnpm add @angular/core

Overview

Angular - the core framework

Index

Namespaces

Variables

variable ANIMATION_MODULE_TYPE

const ANIMATION_MODULE_TYPE: InjectionToken<'NoopAnimations' | 'BrowserAnimations'>;

A [DI token](guide/glossary#di-token "DI token definition") that indicates which animations module has been loaded.

variable APP_BOOTSTRAP_LISTENER

const APP_BOOTSTRAP_LISTENER: InjectionToken<
    readonly ((compRef: ComponentRef<any>) => void)[]
>;

A [DI token](guide/glossary#di-token "DI token definition") that provides a set of callbacks to be called for every component that is bootstrapped.
Each callback must take a ComponentRef instance and return nothing.
(componentRef: ComponentRef) => void

variable APP_ID

const APP_ID: InjectionToken<string>;

A [DI token](guide/glossary#di-token "DI token definition") representing a string ID, used primarily for prefixing application attributes and CSS styles when ViewEncapsulation#Emulated is being used.
The token is needed in cases when multiple applications are bootstrapped on a page (for example, using bootstrapApplication calls). In this case, ensure that those applications have different APP_ID value setup. For example:
bootstrapApplication(ComponentA, { providers: [ { provide: APP_ID, useValue: 'app-a' }, // ... other providers ... ] }); bootstrapApplication(ComponentB, { providers: [ { provide: APP_ID, useValue: 'app-b' }, // ... other providers ... ] });
By default, when there is only one application bootstrapped, you don't need to provide the APP_ID token (the ng will be used as an app ID).

variable APP_INITIALIZER

const APP_INITIALIZER: InjectionToken<
    readonly (() => Observable<unknown> | Promise<unknown> | void)[]
>;

A [DI token](guide/glossary#di-token "DI token definition") that you can use to provide one or more initialization functions.

The provided functions are injected at application startup and executed during app initialization. If any of these functions returns a Promise or an Observable, initialization does not complete until the Promise is resolved or the Observable is completed.

You can, for example, create a factory function that loads language data or an external configuration, and provide that function to the APP_INITIALIZER token. The function is executed during the application bootstrap process, and the needed data is available on startup.

variable Attribute

const Attribute: AttributeDecorator;

Attribute decorator and metadata.

variable CHILD_HEAD

const CHILD_HEAD: number;

variable CHILD_TAIL

const CHILD_TAIL: number;

variable CLEANUP

const CLEANUP: number;

variable COMPILER_OPTIONS

const COMPILER_OPTIONS: InjectionToken<CompilerOptions[]>;

Token to provide CompilerOptions in the platform injector.

variable Component

const Component: ComponentDecorator;

Component decorator and metadata.

variable CONTAINERS

const CONTAINERS: string;

variable ContentChild

const ContentChild: ContentChildDecorator;

ContentChild decorator and metadata.

variable ContentChildren

const ContentChildren: ContentChildrenDecorator;

ContentChildren decorator and metadata.

variable CONTEXT

const CONTEXT: number;

variable createNgModuleRef

const createNgModuleRef: <T>(
    ngModule: Type<T>,
    parentInjector?: Injector
) => NgModuleRef<T>;

The createNgModule function alias for backwards-compatibility. Please avoid using it directly and use createNgModule instead.
Deprecated
Use createNgModule instead.

variable CSP_NONCE

const CSP_NONCE: InjectionToken<string>;

Token used to configure the [Content Security Policy](https://web.dev/strict-csp/) nonce that Angular will apply when inserting inline styles. If not provided, Angular will look up its value from the ngCspNonce attribute of the application root node.

variable CUSTOM_ELEMENTS_SCHEMA

const CUSTOM_ELEMENTS_SCHEMA: SchemaMetadata;

Defines a schema that allows an NgModule to contain the following: - Non-Angular elements named with dash case (-). - Element properties named with dash case (-). Dash case is the naming convention for custom elements.

variable DECLARATION_COMPONENT_VIEW

const DECLARATION_COMPONENT_VIEW: number;

variable DECLARATION_LCONTAINER

const DECLARATION_LCONTAINER: number;

variable DECLARATION_VIEW

const DECLARATION_VIEW: number;

variable DEFAULT_CURRENCY_CODE

const DEFAULT_CURRENCY_CODE: InjectionToken<string>;

Provide this token to set the default currency code your application uses for CurrencyPipe when there is no currency code passed into it. This is only used by CurrencyPipe and has no relation to locale currency. Defaults to USD if not configured.
See the [i18n guide](guide/i18n-common-locale-id) for more information.
**Deprecation notice:**
The default currency code is currently always USD but this is deprecated from v9.
**In v10 the default currency code will be taken from the current locale.**
If you need the previous behavior then set it by creating a DEFAULT_CURRENCY_CODE provider in your application NgModule:
{provide: DEFAULT_CURRENCY_CODE, useValue: 'USD'}
### Example
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { AppModule } from './app/app.module'; platformBrowserDynamic().bootstrapModule(AppModule, { providers: [{provide: DEFAULT_CURRENCY_CODE, useValue: 'EUR' }] });

variable defineInjectable

const defineInjectable: <T>(opts: {
    token: unknown;
    providedIn?: Type<any> | 'root' | 'platform' | 'any' | 'environment';
    factory: () => T;
}) => unknown;

Deprecated
in v8, delete after v10. This API should be used only by generated code, and that code should now use ɵɵdefineInjectable instead.

variable DEHYDRATED_VIEWS

const DEHYDRATED_VIEWS: number;

Below are constants for LContainer indices to help us look up LContainer members without having to remember the specific indices. Uglify will inline these when minifying so there shouldn't be a cost.

variable Directive

const Directive: DirectiveDecorator;

Type of the Directive metadata.

variable DISCONNECTED_NODES

const DISCONNECTED_NODES: string;

variable EFFECTS_TO_SCHEDULE

const EFFECTS_TO_SCHEDULE: number;

variable ELEMENT_CONTAINERS

const ELEMENT_CONTAINERS: string;

Keys within serialized view data structure to represent various parts. See the SerializedView interface below for additional information.

variable ELEMENT_MARKER

const ELEMENT_MARKER: ELEMENT_MARKER;

Marks that the next string is an element name.
See I18nMutateOpCodes documentation.

variable EMBEDDED_VIEW_INJECTOR

const EMBEDDED_VIEW_INJECTOR: number;

variable ENVIRONMENT

const ENVIRONMENT: number;

variable ENVIRONMENT_INITIALIZER

const ENVIRONMENT_INITIALIZER: InjectionToken<readonly (() => void)[]>;

A multi-provider token for initialization functions that will run upon construction of an environment injector.

variable EventEmitter

const EventEmitter: {
    new (isAsync?: boolean): EventEmitter<any>;
    new <T>(isAsync?: boolean): EventEmitter<T>;
    readonly prototype: EventEmitter<any>;
};

variable FLAGS

const FLAGS: number;

variable Host

const Host: HostDecorator;

Host decorator and metadata.

variable HOST

const HOST: number;

variable HostBinding

const HostBinding: HostBindingDecorator;

variable HostListener

const HostListener: HostListenerDecorator;

Decorator that binds a DOM event to a host listener and supplies configuration metadata. Angular invokes the supplied handler method when the host element emits the specified event, and updates the bound element with the result.

If the handler method returns false, applies preventDefault on the bound element.

The following example declares a directive that attaches a click listener to a button and counts clicks.

@Directive({selector: 'button[counting]'})
class CountClicks {
  numberOfClicks = 0;

  @HostListener('click', ['$event.target'])
  onClick(btn) {
    console.log('button', btn, 'number of clicks:', this.numberOfClicks++);
  }
}

@Component({
  selector: 'app',
  template: '<button counting>Increment</button>',
})
class App {}

The following example registers another DOM event handler that listens for Enter key-press events on the global window.

import { HostListener, Component } from "@angular/core";

@Component({
  selector: 'app',
  template: `<h1>Hello, you have pressed enter {{counter}} number of times!</h1> Press enter key
to increment the counter.
  <button (click)="resetCounter()">Reset Counter</button>`
})
class AppComponent {
  counter = 0;
  @HostListener('window:keydown.enter', ['$event'])
  handleKeyDown(event: KeyboardEvent) {
    this.counter++;
  }
  resetCounter() {
    this.counter = 0;
  }
}

The list of valid key names for keydown and keyup events can be found here: https://www.w3.org/TR/DOM-Level-3-Events-key/#named-key-attribute-values

Note that keys can also be combined, e.g. @HostListener('keydown.shift.a').

The global target names that can be used to prefix an event name are document:, window: and body:.

variable HYDRATION

const HYDRATION: number;

variable ICU_MARKER

const ICU_MARKER: ICU_MARKER;

Marks that the next string is comment text need for ICU.
See I18nMutateOpCodes documentation.

variable ID

const ID: number;

variable Inject

const Inject: InjectDecorator;

Inject decorator and metadata.

variable Injectable

const Injectable: InjectableDecorator;

Injectable decorator and metadata.

variable INJECTOR

const INJECTOR: InjectionToken<Injector>;

An InjectionToken that gets the current Injector for createInjector()-style injectors.
Requesting this token instead of Injector allows StaticInjector to be tree-shaken from a project.

variable INJECTOR_2

const INJECTOR_2: number;

variable Input

const Input: InputDecorator;

variable ITS_JUST_ANGULAR

const ITS_JUST_ANGULAR: boolean;

The existence of this constant (in this particular file) informs the Angular compiler that the current program is actually @angular/core, which needs to be compiled specially.

variable LOCALE_ID

const LOCALE_ID: InjectionToken<string>;

Provide this token to set the locale of your application. It is used for i18n extraction, by i18n pipes (DatePipe, I18nPluralPipe, CurrencyPipe, DecimalPipe and PercentPipe) and by ICU expressions.

See the [i18n guide](guide/i18n-common-locale-id) for more information.

### Example

import { LOCALE_ID } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

platformBrowserDynamic().bootstrapModule(AppModule, {
  providers: [{provide: LOCALE_ID, useValue: 'en-US' }]
});

variable MOVED_VIEWS

const MOVED_VIEWS: number;

variable MULTIPLIER

const MULTIPLIER: string;

variable NATIVE

const NATIVE: number;

variable NEXT

const NEXT: number;

variable NgModule

const NgModule: NgModuleDecorator;

variable NO_ERRORS_SCHEMA

const NO_ERRORS_SCHEMA: SchemaMetadata;

Defines a schema that allows any property on any element.
This schema allows you to ignore the errors related to any unknown elements or properties in a template. The usage of this schema is generally discouraged because it prevents useful validation and may hide real errors in your template. Consider using the CUSTOM_ELEMENTS_SCHEMA instead.

variable NODES

const NODES: string;

variable NUM_ROOT_NODES

const NUM_ROOT_NODES: string;

variable ON_DESTROY_HOOKS

const ON_DESTROY_HOOKS: number;

variable Optional

const Optional: OptionalDecorator;

Optional decorator and metadata.

variable Output

const Output: OutputDecorator;

variable ɵALLOW_MULTIPLE_PLATFORMS

const ɵALLOW_MULTIPLE_PLATFORMS: InjectionToken<boolean>;

Internal token to indicate whether having multiple bootstrapped platform should be allowed (only one bootstrapped platform is allowed by default). This token helps to support SSR scenarios.

variable ɵCONTAINER_HEADER_OFFSET

const ɵCONTAINER_HEADER_OFFSET: number;

Size of LContainer's header. Represents the index after which all views in the container will be inserted. We need to keep a record of current views so we know which views are already in the DOM (and don't need to be re-added) and so we can remove views from the DOM when they are no longer required.

variable ɵDEFAULT_LOCALE_ID

const ɵDEFAULT_LOCALE_ID: string;

The locale id that the application is using by default (for translations and ICU expressions).

variable ɵdefaultIterableDiffers

const ɵdefaultIterableDiffers: IterableDiffers;

variable ɵdefaultKeyValueDiffers

const ɵdefaultKeyValueDiffers: KeyValueDiffers;

variable ɵDEFER_BLOCK_CONFIG

const ɵDEFER_BLOCK_CONFIG: InjectionToken<ɵDeferBlockConfig>;

**INTERNAL**, token used for configuring defer block behavior.

variable ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR

const ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR: InjectionToken<ɵDeferBlockDependencyInterceptor>;

**INTERNAL**, avoid referencing it in application code.
Injector token that allows to provide DeferBlockDependencyInterceptor class implementation.

variable ɵdepsTracker

const ɵdepsTracker: DepsTracker;

The deps tracker to be used in the current Angular app in dev mode.

variable ɵglobal

const ɵglobal: any;

variable ɵIMAGE_CONFIG

const ɵIMAGE_CONFIG: InjectionToken<ɵImageConfig>;

Injection token that configures the image optimized image functionality. See ImageConfig for additional information about parameters that can be used.
See Also
- NgOptimizedImage
- ImageConfig

variable ɵIMAGE_CONFIG_DEFAULTS

const ɵIMAGE_CONFIG_DEFAULTS: ɵImageConfig;

variable ɵINJECTOR_SCOPE

const ɵINJECTOR_SCOPE: InjectionToken<InjectorScope>;

An internal token whose presence in an injector indicates that the injector should treat itself as a root scoped injector when processing requests for unknown tokens which may indicate they are provided in the root scope.

variable ɵIS_HYDRATION_DOM_REUSE_ENABLED

const ɵIS_HYDRATION_DOM_REUSE_ENABLED: InjectionToken<boolean>;

Internal token that specifies whether DOM reuse logic during hydration is enabled.

variable ɵNG_COMP_DEF

const ɵNG_COMP_DEF: string;

variable ɵNG_DIR_DEF

const ɵNG_DIR_DEF: string;

variable ɵNG_ELEMENT_ID

const ɵNG_ELEMENT_ID: string;

If a directive is diPublic, bloomAdd sets a property on the type with this constant as the key and the directive's unique ID as the value. This allows us to map directives to their bloom filter bit for DI.

variable ɵNG_INJ_DEF

const ɵNG_INJ_DEF: string;

variable ɵNG_MOD_DEF

const ɵNG_MOD_DEF: string;

variable ɵNG_PIPE_DEF

const ɵNG_PIPE_DEF: string;

variable ɵNG_PROV_DEF

const ɵNG_PROV_DEF: string;

variable ɵNO_CHANGE

const ɵNO_CHANGE: ɵNO_CHANGE;

A special value which designates that a value has not changed.

variable ɵNOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR

const ɵNOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR: {};

variable ɵSSR_CONTENT_INTEGRITY_MARKER

const ɵSSR_CONTENT_INTEGRITY_MARKER: string;

Marker used in a comment node to ensure hydration content integrity

variable ɵTESTABILITY

const ɵTESTABILITY: InjectionToken<Testability>;

Internal injection token that can used to access an instance of a Testability class.
This token acts as a bridge between the core bootstrap code and the Testability class. This is needed to ensure that there are no direct references to the Testability class, so it can be tree-shaken away (if not referenced). For the environments/setups when the Testability class should be available, this token is used to add a provider that references the Testability class. Otherwise, only this token is retained in a bundle, but the Testability class is not.

variable ɵTESTABILITY_GETTER

const ɵTESTABILITY_GETTER: InjectionToken<GetTestability>;

Internal injection token to retrieve Testability getter class instance.

variable ɵUSE_RUNTIME_DEPS_TRACKER_FOR_JIT

const ɵUSE_RUNTIME_DEPS_TRACKER_FOR_JIT: boolean;

Indicates whether to use the runtime dependency tracker for scope calculation in JIT compilation. The value "false" means the old code path based on patching scope info into the types will be used.
Deprecated
For migration purposes only, to be removed soon.

variable ɵXSS_SECURITY_URL

const ɵXSS_SECURITY_URL: string;

URL for the XSS security documentation.

variable PACKAGE_ROOT_URL

const PACKAGE_ROOT_URL: InjectionToken<string>;

A [DI token](guide/glossary#di-token "DI token definition") that indicates the root directory of the application
Deprecated

variable PARENT

const PARENT: number;

variable Pipe

const Pipe: PipeDecorator;

variable PLATFORM_ID

const PLATFORM_ID: InjectionToken<Object>;

A token that indicates an opaque platform ID.

variable PLATFORM_INITIALIZER

const PLATFORM_INITIALIZER: InjectionToken<readonly (() => void)[]>;

A function that is executed when a platform is initialized.

variable PREORDER_HOOK_FLAGS

const PREORDER_HOOK_FLAGS: number;

variable QUERIES

const QUERIES: number;

variable REACTIVE_TEMPLATE_CONSUMER

const REACTIVE_TEMPLATE_CONSUMER: number;

variable RENDERER

const RENDERER: number;

variable Self

const Self: SelfDecorator;

Self decorator and metadata.

variable SkipSelf

const SkipSelf: SkipSelfDecorator;

SkipSelf decorator and metadata.

variable T_HOST

const T_HOST: number;

variable TEMPLATE_ID

const TEMPLATE_ID: string;

variable TEMPLATES

const TEMPLATES: string;

variable TRANSLATIONS

const TRANSLATIONS: InjectionToken<string>;

Use this token at bootstrap to provide the content of your translation file (xtb, xlf or xlf2) when you want to translate your application in another language.

See the [i18n guide](guide/i18n-common-merge) for more information.

### Example

import { TRANSLATIONS } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

// content of your translation file
const translations = '....';

platformBrowserDynamic().bootstrapModule(AppModule, {
  providers: [{provide: TRANSLATIONS, useValue: translations }]
});

variable TRANSLATIONS_FORMAT

const TRANSLATIONS_FORMAT: InjectionToken<string>;

Provide this token at bootstrap to set the format of your TRANSLATIONS: xtb, xlf or xlf2.

See the [i18n guide](guide/i18n-common-merge) for more information.

### Example

import { TRANSLATIONS_FORMAT } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

platformBrowserDynamic().bootstrapModule(AppModule, {
  providers: [{provide: TRANSLATIONS_FORMAT, useValue: 'xlf' }]
});

variable TVIEW

const TVIEW: number;

variable Type

const Type: FunctionConstructor;

Represents a type that a Component or other object is instances of.
An example of a Type is MyCustomComponent class, which in JavaScript is represented by the MyCustomComponent constructor function.

variable TYPE

const TYPE: number;

Special location which allows easy identification of type. If we have an array which was retrieved from the LView and that array has true at TYPE location, we know it is LContainer.

variable VERSION

const VERSION: Version;

variable VIEW_REFS

const VIEW_REFS: number;

variable ViewChild

const ViewChild: ViewChildDecorator;

ViewChild decorator and metadata.

variable ViewChildren

const ViewChildren: ViewChildrenDecorator;

ViewChildren decorator and metadata.

Functions

function afterNextRender

afterNextRender: (
    callback: VoidFunction,
    options?: AfterRenderOptions
) => AfterRenderRef;

Register a callback to be invoked the next time the application finishes rendering.
You should always explicitly specify a non-default [phase](api/core/AfterRenderPhase), or you risk significant performance degradation.
Note that the callback will run - in the order it was registered - on browser platforms only
Components are not guaranteed to be [hydrated](guide/hydration) before the callback runs. You must use caution when directly reading or writing the DOM and layout.
Parameter callback
A callback function to register
Use afterNextRender to read or write the DOM once, for example to initialize a non-Angular library.
### Example
@Component({ selector: 'my-chart-cmp', template: `<div #chart>{{ ... }}</div>`, }) export class MyChartCmp { @ViewChild('chart') chartRef: ElementRef; chart: MyChart|null; constructor() { afterNextRender(() => { this.chart = new MyChart(this.chartRef.nativeElement); }, {phase: AfterRenderPhase.Write}); } }

function afterRender

afterRender: (
    callback: VoidFunction,
    options?: AfterRenderOptions
) => AfterRenderRef;

Register a callback to be invoked each time the application finishes rendering.
You should always explicitly specify a non-default [phase](api/core/AfterRenderPhase), or you risk significant performance degradation.
Note that the callback will run - in the order it was registered - once per render - on browser platforms only
Components are not guaranteed to be [hydrated](guide/hydration) before the callback runs. You must use caution when directly reading or writing the DOM and layout.
Parameter callback
A callback function to register
Use afterRender to read or write the DOM after each render.
### Example
@Component({ selector: 'my-cmp', template: `<span #content>{{ ... }}</span>`, }) export class MyComponent { @ViewChild('content') contentRef: ElementRef; constructor() { afterRender(() => { console.log('content height: ' + this.contentRef.nativeElement.scrollHeight); }, {phase: AfterRenderPhase.Read}); } }

function asNativeElements

asNativeElements: (debugEls: DebugElement[]) => any;

function assertInInjectionContext

assertInInjectionContext: (debugFn: Function) => void;

Asserts that the current stack frame is within an [injection context](guide/dependency-injection-context) and has access to inject.
Parameter debugFn
a reference to the function making the assertion (used for the error message).

function assertNotInReactiveContext

assertNotInReactiveContext: (debugFn: Function, extraContext?: string) => void;

Asserts that the current stack frame is not within a reactive context. Useful to disallow certain code from running inside a reactive context (see toSignal).
Parameter debugFn
a reference to the function making the assertion (used for the error message).

function assertPlatform

assertPlatform: (requiredToken: any) => PlatformRef;

Checks that there is currently a platform that contains the given token as a provider.

function booleanAttribute

booleanAttribute: (value: unknown) => boolean;

Transforms a value (typically a string) to a boolean. Intended to be used as a transform function of an input.
```typescript @Input({ transform: booleanAttribute }) status!: boolean; ```
Parameter value
Value to be transformed.

function computed

computed: <T>(
    computation: () => T,
    options?: CreateComputedOptions<T>
) => Signal<T>;

Create a computed Signal which derives a reactive value from an expression.

function createComponent

createComponent: <C>(
    component: Type<C>,
    options: {
        environmentInjector: EnvironmentInjector;
        hostElement?: Element;
        elementInjector?: Injector;
        projectableNodes?: Node[][];
    }
) => ComponentRef<C>;

Creates a ComponentRef instance based on provided component type and a set of options.
The example below demonstrates how the createComponent function can be used to create an instance of a ComponentRef dynamically and attach it to an ApplicationRef, so that it gets included into change detection cycles.
Note: the example uses standalone components, but the function can also be used for non-standalone components (declared in an NgModule) as well.
@Component({ standalone: true, template: `Hello {{ name }}!` }) class HelloComponent { name = 'Angular'; } @Component({ standalone: true, template: `<div id="hello-component-host"></div>` }) class RootComponent {} // Bootstrap an application. const applicationRef = await bootstrapApplication(RootComponent); // Locate a DOM node that would be used as a host. const hostElement = document.getElementById('hello-component-host'); // Get an `EnvironmentInjector` instance from the `ApplicationRef`. const environmentInjector = applicationRef.injector; // We can now create a `ComponentRef` instance. const componentRef = createComponent(HelloComponent, {hostElement, environmentInjector}); // Last step is to register the newly created ref using the `ApplicationRef` instance // to include the component view into change detection cycles. applicationRef.attachView(componentRef.hostView); componentRef.changeDetectorRef.detectChanges();
Parameter component
Component class reference.
Parameter options
Set of options to use: * environmentInjector: An EnvironmentInjector instance to be used for the component, see additional info about it [here](/guide/standalone-components#environment-injectors). * hostElement (optional): A DOM node that should act as a host node for the component. If not provided, Angular creates one based on the tag name used in the component selector (and falls back to using div if selector doesn't have tag name info). * elementInjector (optional): An ElementInjector instance, see additional info about it [here](/guide/hierarchical-dependency-injection#elementinjector). * projectableNodes (optional): A list of DOM nodes that should be projected through [<ng-content>](api/core/ng-content) of the new component instance.
Returns
ComponentRef instance that represents a given Component.

function createEnvironmentInjector

createEnvironmentInjector: (
    providers: Array<Provider | EnvironmentProviders>,
    parent: EnvironmentInjector,
    debugName?: string | null
) => EnvironmentInjector;

Create a new environment injector.
Learn more about environment injectors in [this guide](guide/standalone-components#environment-injectors).
Parameter providers
An array of providers.
Parameter parent
A parent environment injector.
Parameter debugName
An optional name for this injector instance, which will be used in error messages.

function createNgModule

createNgModule: <T>(
    ngModule: Type<T>,
    parentInjector?: Injector
) => NgModuleRef<T>;

Returns a new NgModuleRef instance based on the NgModule class and parent injector provided.
Parameter ngModule
NgModule class.
Parameter parentInjector
Optional injector instance to use as a parent for the module injector. If not provided, NullInjector will be used instead.
Returns
NgModuleRef that represents an NgModule instance.

function createPlatform

createPlatform: (injector: Injector) => PlatformRef;

Creates a platform. Platforms must be created on launch using this function.

function createPlatformFactory

createPlatformFactory: (
    parentPlatformFactory: (extraProviders?: StaticProvider[]) => PlatformRef,
    name: string,
    providers?: StaticProvider[]
) => (extraProviders?: StaticProvider[]) => PlatformRef;

Creates a factory for a platform. Can be used to provide or override Providers specific to your application's runtime needs, such as PLATFORM_INITIALIZER and PLATFORM_ID.
Parameter parentPlatformFactory
Another platform factory to modify. Allows you to compose factories to build up configurations that might be required by different libraries or parts of the application.
Parameter name
Identifies the new platform factory.
Parameter providers
A set of dependency providers for platforms created with the new factory.

function destroyPlatform

destroyPlatform: () => void;

Destroys the current Angular platform and all Angular applications on the page. Destroys all modules and listeners registered with the platform.

function effect

effect: (
    effectFn: (onCleanup: EffectCleanupRegisterFn) => void,
    options?: CreateEffectOptions
) => EffectRef;

Create a global Effect for the given reactive function.

function enableProdMode

enableProdMode: () => void;

Disable Angular's development mode, which turns off assertions and other checks within the framework.
One important assertion this disables verifies that a change detection pass does not result in additional changes to any bindings (also known as unidirectional data flow).
Using this method is discouraged as the Angular CLI will set production mode when using the optimization option.
See Also

function forwardRef

forwardRef: (forwardRefFn: ForwardRefFn) => Type<any>;

Allows to refer to references which are not yet defined.

For instance, forwardRef is used when the token which we need to refer to for the purposes of DI is declared, but not yet defined. It is also used when the token which we use when creating a query is not yet defined.

forwardRef is also used to break circularities in standalone components imports.

### Circular dependency example

### Circular standalone reference import example

@Component({
  standalone: true,
  imports: [ChildComponent],
  selector: 'app-parent',
  template: `<app-child [hideParent]="hideParent"></app-child>`,
})
export class ParentComponent {
  @Input() hideParent: boolean;
}


@Component({
  standalone: true,
  imports: [CommonModule, forwardRef(() => ParentComponent)],
  selector: 'app-child',
  template: `<app-parent *ngIf="!hideParent"></app-parent>`,
})
export class ChildComponent {
  @Input() hideParent: boolean;
}

function getDebugNode

getDebugNode: (nativeNode: any) => DebugNode | null;

function getModuleFactory

getModuleFactory: (id: string) => NgModuleFactory<any>;

Returns the NgModuleFactory with the given id (specified using [@NgModule.id field](api/core/NgModule#id)), if it exists and has been loaded. Factories for NgModules that do not specify an id cannot be retrieved. Throws if an NgModule cannot be found.
Deprecated
Use getNgModuleById instead.

function getNgModuleById

getNgModuleById: <T>(id: string) => Type<T>;

Returns the NgModule class with the given id (specified using [@NgModule.id field](api/core/NgModule#id)), if it exists and has been loaded. Classes for NgModules that do not specify an id cannot be retrieved. Throws if an NgModule cannot be found.

function getPlatform

getPlatform: () => PlatformRef | null;

Returns the current platform.

function importProvidersFrom

importProvidersFrom: (
    ...sources: ImportProvidersSource[]
) => EnvironmentProviders;

Collects providers from all NgModules and standalone components, including transitively imported ones.
Providers extracted via importProvidersFrom are only usable in an application injector or another environment injector (such as a route injector). They should not be used in component providers.
More information about standalone components can be found in [this guide](guide/standalone-components).
The results of the importProvidersFrom call can be used in the bootstrapApplication call:
await bootstrapApplication(RootComponent, { providers: [ importProvidersFrom(NgModuleOne, NgModuleTwo) ] });
You can also use the importProvidersFrom results in the providers field of a route, when a standalone component is used:
export const ROUTES: Route[] = [ { path: 'foo', providers: [ importProvidersFrom(NgModuleOne, NgModuleTwo) ], component: YourStandaloneComponent } ];
Returns
Collected providers from the specified list of types.

function inject

inject: {
    <T>(token: ProviderToken<T>): T;
    <T>(token: ProviderToken<T>, flags?: InjectFlags): T;
    <T>(token: ProviderToken<T>, options: InjectOptions & { optional?: false }): T;
    <T>(token: ProviderToken<T>, options: InjectOptions): T;
};

Parameter token
A token that represents a dependency that should be injected.
Returns
the injected value if operation is successful, null otherwise.
Throws
if called outside of a supported context.
Parameter token
A token that represents a dependency that should be injected.
Parameter flags
Control how injection is executed. The flags correspond to injection strategies that can be specified with parameter decorators @Host, @Self, @SkipSelf, and @Optional.
Returns
the injected value if operation is successful, null otherwise.
Throws
if called outside of a supported context.
Deprecated
prefer an options object instead of InjectFlags
Parameter token
A token that represents a dependency that should be injected.
Parameter options
Control how injection is executed. Options correspond to injection strategies that can be specified with parameter decorators @Host, @Self, @SkipSelf, and @Optional.
Returns
the injected value if operation is successful.
Throws
if called outside of a supported context, or if the token is not found.
Parameter token
A token that represents a dependency that should be injected.
Parameter options
Control how injection is executed. Options correspond to injection strategies that can be specified with parameter decorators @Host, @Self, @SkipSelf, and @Optional.
Returns
the injected value if operation is successful, null if the token is not found and optional injection has been requested.
Throws
if called outside of a supported context, or if the token is not found and optional injection was not requested.

function isDevMode

isDevMode: () => boolean;

Returns whether Angular is in development mode.
By default, this is true, unless enableProdMode is invoked prior to calling this method or the application is built using the Angular CLI with the optimization option.
See Also

function isSignal

isSignal: (value: unknown) => value is () => unknown;

Checks if the given value is a reactive Signal.

function isStandalone

isStandalone: (type: Type<unknown>) => boolean;

Checks whether a given Component, Directive or Pipe is marked as standalone. This will return false if passed anything other than a Component, Directive, or Pipe class See [this guide](/guide/standalone-components) for additional information:
Parameter type
A reference to a Component, Directive or Pipe.

function makeEnvironmentProviders

makeEnvironmentProviders: (
    providers: (Provider | EnvironmentProviders)[]
) => EnvironmentProviders;

Wrap an array of Providers into EnvironmentProviders, preventing them from being accidentally referenced in @Component in a component injector.

function makeStateKey

makeStateKey: <T = void>(key: string) => StateKey<T>;

Create a StateKey<T> that can be used to store value of type T with TransferState.

Example:

const COUNTER_KEY = makeStateKey<number>('counter');
let value = 10;

transferState.set(COUNTER_KEY, value);

function mergeApplicationConfig

mergeApplicationConfig: (...configs: ApplicationConfig[]) => ApplicationConfig;

Merge multiple application configurations from left to right.
Parameter configs
Two or more configurations to be merged.
Returns
A merged [ApplicationConfig](api/core/ApplicationConfig).

function numberAttribute

numberAttribute: (value: unknown, fallbackValue?: number) => number;

Transforms a value (typically a string) to a number. Intended to be used as a transform function of an input.
Parameter value
Value to be transformed.
Parameter fallbackValue
Value to use if the provided value can't be parsed as a number.
```typescript @Input({ transform: numberAttribute }) id!: number; ```

function ɵ_sanitizeHtml

ɵ_sanitizeHtml: (
    defaultDoc: any,
    unsafeHtmlInput: string
) => TrustedHTML | string;

Sanitizes the given unsafe, untrusted HTML fragment, and returns HTML text that is safe to add to the DOM in a browser environment.

function ɵ_sanitizeUrl

ɵ_sanitizeUrl: (url: string) => string;

function ɵallowSanitizationBypassAndThrow

ɵallowSanitizationBypassAndThrow: {
    (value: any, type: ɵBypassType.Html): value is ɵSafeHtml;
    (value: any, type: ɵBypassType.ResourceUrl): value is ɵSafeResourceUrl;
    (value: any, type: ɵBypassType.Script): value is ɵSafeScript;
    (value: any, type: ɵBypassType.Style): value is ɵSafeStyle;
    (value: any, type: ɵBypassType.Url): value is ɵSafeUrl;
    (value: any, type: ɵBypassType): boolean;
};

function ɵannotateForHydration

ɵannotateForHydration: (appRef: ApplicationRef, doc: Document) => void;

Annotates all components bootstrapped in a given ApplicationRef with info needed for hydration.
Parameter appRef
An instance of an ApplicationRef.
Parameter doc
A reference to the current Document instance.

function ɵbypassSanitizationTrustHtml

ɵbypassSanitizationTrustHtml: (trustedHtml: string) => ɵSafeHtml;

Mark html string as trusted.
This function wraps the trusted string in String and brands it in a way which makes it recognizable to htmlSanitizer to be trusted implicitly.
Parameter trustedHtml
html string which needs to be implicitly trusted.
Returns
a html which has been branded to be implicitly trusted.

function ɵbypassSanitizationTrustResourceUrl

ɵbypassSanitizationTrustResourceUrl: (
    trustedResourceUrl: string
) => ɵSafeResourceUrl;

Mark url string as trusted.
This function wraps the trusted string in String and brands it in a way which makes it recognizable to resourceUrlSanitizer to be trusted implicitly.
Parameter trustedResourceUrl
url string which needs to be implicitly trusted.
Returns
a url which has been branded to be implicitly trusted.

function ɵbypassSanitizationTrustScript

ɵbypassSanitizationTrustScript: (trustedScript: string) => ɵSafeScript;

Mark script string as trusted.
This function wraps the trusted string in String and brands it in a way which makes it recognizable to scriptSanitizer to be trusted implicitly.
Parameter trustedScript
script string which needs to be implicitly trusted.
Returns
a script which has been branded to be implicitly trusted.

function ɵbypassSanitizationTrustStyle

ɵbypassSanitizationTrustStyle: (trustedStyle: string) => ɵSafeStyle;

Mark style string as trusted.
This function wraps the trusted string in String and brands it in a way which makes it recognizable to styleSanitizer to be trusted implicitly.
Parameter trustedStyle
style string which needs to be implicitly trusted.
Returns
a style hich has been branded to be implicitly trusted.

function ɵbypassSanitizationTrustUrl

ɵbypassSanitizationTrustUrl: (trustedUrl: string) => ɵSafeUrl;

Mark url string as trusted.
This function wraps the trusted string in String and brands it in a way which makes it recognizable to urlSanitizer to be trusted implicitly.
Parameter trustedUrl
url string which needs to be implicitly trusted.
Returns
a url which has been branded to be implicitly trusted.

function ɵclearResolutionOfComponentResourcesQueue

ɵclearResolutionOfComponentResourcesQueue: () => Map<Type<any>, Component>;

function ɵcompileComponent

ɵcompileComponent: (type: Type<any>, metadata: Component) => void;

Compile an Angular component according to its decorator metadata, and patch the resulting component def (ɵcmp) onto the component type.
Compilation may be asynchronous (due to the need to resolve URLs for the component template or other resources, for example). In the event that compilation is not immediate, compileComponent will enqueue resource resolution into a global queue and will fail to return the ɵcmp until the global queue has been resolved with a call to resolveComponentResources.

function ɵcompileDirective

ɵcompileDirective: (type: Type<any>, directive: Directive | null) => void;

Compile an Angular directive according to its decorator metadata, and patch the resulting directive def onto the component type.
In the event that compilation is not immediate, compileDirective will return a Promise which will resolve when compilation completes and the directive becomes usable.

function ɵcompileNgModule

ɵcompileNgModule: (moduleType: Type<any>, ngModule?: NgModule) => void;

Compiles a module in JIT mode.
This function automatically gets called when a class has a @NgModule decorator.

function ɵcompileNgModuleDefs

ɵcompileNgModuleDefs: (
    moduleType: ɵNgModuleType,
    ngModule: NgModule,
    allowDuplicateDeclarationsInRoot?: boolean
) => void;

Compiles and adds the ɵmod, ɵfac and ɵinj properties to the module class.
It's possible to compile a module via this API which will allow duplicate declarations in its root.

function ɵcompileNgModuleFactory

ɵcompileNgModuleFactory: <M>(
    injector: Injector,
    options: CompilerOptions,
    moduleType: Type<M>
) => Promise<NgModuleFactory<M>>;

function ɵcompilePipe

ɵcompilePipe: (type: Type<any>, meta: Pipe) => void;

function ɵconvertToBitFlags

ɵconvertToBitFlags: (
    flags: InjectOptions | InjectFlags | undefined
) => InjectFlags | undefined;

function ɵcreateInjector

ɵcreateInjector: (
    defType: any,
    parent?: Injector | null,
    additionalProviders?: Array<Provider | StaticProvider> | null,
    name?: string
) => Injector;

Create a new Injector which is configured using a defType of InjectorType<any>s.

function ɵdevModeEqual

ɵdevModeEqual: (a: any, b: any) => boolean;

function ɵfindLocaleData

ɵfindLocaleData: (locale: string) => any;

Finds the locale data for a given locale.
Parameter locale
The locale code.
Returns
The locale data.
See Also
- [Internationalization (i18n) Guide](https://angular.io/guide/i18n-overview)

function ɵflushModuleScopingQueueAsMuchAsPossible

ɵflushModuleScopingQueueAsMuchAsPossible: () => void;

Loops over queued module definitions, if a given module definition has all of its declarations resolved, it dequeues that module definition and sets the scope on its declarations.

function ɵformatRuntimeError

ɵformatRuntimeError: <T extends number = ɵRuntimeErrorCode>(
    code: T,
    message: null | false | string
) => string;

Called to format a runtime error. See additional info on the message argument type in the RuntimeError class description.

function ɵgenerateStandaloneInDeclarationsError

ɵgenerateStandaloneInDeclarationsError: (
    type: Type<any>,
    location: string
) => string;

function ɵgetAsyncClassMetadataFn

ɵgetAsyncClassMetadataFn: (
    type: Type<unknown>
) => (() => Promise<Array<Type<unknown>>>) | null;

If a given component has unresolved async metadata - returns a reference to a function that applies component metadata after resolving defer-loadable dependencies. Otherwise - this function returns null.

function ɵgetDebugNode

ɵgetDebugNode: (nativeNode: any) => DebugNode | null;

function ɵgetDeferBlocks

ɵgetDeferBlocks: (lView: LView, deferBlocks: ɵDeferBlockDetails[]) => void;

Retrieves all defer blocks in a given LView.
Parameter lView
lView with defer blocks
Parameter deferBlocks
defer block aggregator array

function ɵgetDirectives

ɵgetDirectives: (node: Node) => {}[];

Retrieves directive instances associated with a given DOM node. Does not include component instances.
Given the following DOM structure:
<app-root> <button my-button></button> <my-comp></my-comp> </app-root>
Calling getDirectives on <button> will return an array with an instance of the MyButton directive that is associated with the DOM node.
Calling getDirectives on <my-comp> will return an empty array.
Parameter node
DOM node for which to get the directives.
Returns
Array of directives associated with the node.
ng

function ɵgetHostElement

ɵgetHostElement: (componentOrDirective: {}) => Element;

Retrieves the host element of a component or directive instance. The host element is the DOM element that matched the selector of the directive.
Parameter componentOrDirective
Component or directive instance for which the host element should be retrieved.
Returns
Host element of the target.
ng

function ɵgetInjectableDef

ɵgetInjectableDef: <T>(type: any) => ɵɵInjectableDeclaration<T> | null;

Read the injectable def (ɵprov) for type in a way which is immune to accidentally reading inherited value.
Parameter type
A type which may have its own (non-inherited) ɵprov.

function ɵgetLContext

ɵgetLContext: (target: any) => ɵLContext | null;

Returns the matching LContext data for a given DOM node, directive or component instance.
This function will examine the provided DOM element, component, or directive instance's monkey-patched property to derive the LContext data. Once called then the monkey-patched value will be that of the newly created LContext.
If the monkey-patched value is the LView instance then the context value for that target will be created and the monkey-patch reference will be updated. Therefore when this function is called it may mutate the provided element's, component's or any of the associated directive's monkey-patch values.
If the monkey-patch value is not detected then the code will walk up the DOM until an element is found which contains a monkey-patch reference. When that occurs then the provided element will be updated with a new context (which is then returned). If the monkey-patch value is not detected for a component/directive instance then it will throw an error (all components and directives should be automatically monkey-patched by ivy).
Parameter target
Component, Directive or DOM Node.

function ɵgetLocaleCurrencyCode

ɵgetLocaleCurrencyCode: (locale: string) => string | null;

Retrieves the default currency code for the given locale.
The default is defined as the first currency which is still in use.
Parameter locale
The code of the locale whose currency code we want.
Returns
The code of the default currency for the given locale.

function ɵgetLocalePluralCase

ɵgetLocalePluralCase: (locale: string) => (value: number) => number;

Retrieves the plural function used by ICU expressions to determine the plural case to use for a given locale.
Parameter locale
A locale code for the locale format rules to use.
Returns
The plural function for the locale.
See Also
- NgPlural
- [Internationalization (i18n) Guide](/guide/i18n-overview)

function ɵgetSanitizationBypassType

ɵgetSanitizationBypassType: (value: any) => ɵBypassType | null;

function ɵgetUnknownElementStrictMode

ɵgetUnknownElementStrictMode: () => boolean;

Gets the current value of the strict mode.

function ɵgetUnknownPropertyStrictMode

ɵgetUnknownPropertyStrictMode: () => boolean;

Gets the current value of the strict mode.

function ɵinjectChangeDetectorRef

ɵinjectChangeDetectorRef: (flags: InjectFlags) => ChangeDetectorRef;

Returns a ChangeDetectorRef (a.k.a. a ViewRef)

function ɵinternalAfterNextRender

ɵinternalAfterNextRender: (
    callback: VoidFunction,
    options?: InternalAfterNextRenderOptions
) => void;

Register a callback to run once before any userspace afterRender or afterNextRender callbacks.
This function should almost always be used instead of afterRender or afterNextRender for implementing framework functionality. Consider:
1.) AfterRenderPhase.EarlyRead is intended to be used for implementing custom layout. If the framework itself mutates the DOM after *any* AfterRenderPhase.EarlyRead callbacks are run, the phase can no longer reliably serve its purpose.
2.) Importing afterRender in the framework can reduce the ability for it to be tree-shaken, and the framework shouldn't need much of the behavior.

function ɵinternalCreateApplication

ɵinternalCreateApplication: (config: {
    rootComponent?: Type<unknown>;
    appProviders?: Array<Provider | EnvironmentProviders>;
    platformProviders?: Provider[];
}) => Promise<ApplicationRef>;

Internal create application API that implements the core application creation logic and optional bootstrap logic.
Platforms (such as platform-browser) may require different set of application and platform providers for an application to function correctly. As a result, platforms may use this function internally and supply the necessary providers during the bootstrap, while exposing platform-specific APIs as a part of their public API.
Returns
A promise that returns an ApplicationRef instance once resolved.

function ɵisBoundToModule

ɵisBoundToModule: <C>(cf: ComponentFactory<C>) => boolean;

function ɵisComponentDefPendingResolution

ɵisComponentDefPendingResolution: (type: Type<any>) => boolean;

function ɵisEnvironmentProviders

ɵisEnvironmentProviders: (
    value: Provider | EnvironmentProviders | ɵInternalEnvironmentProviders
) => value is ɵInternalEnvironmentProviders;

function ɵisInjectable

ɵisInjectable: (type: any) => boolean;

function ɵisNgModule

ɵisNgModule: <T>(value: Type<T>) => value is Type<T> & { ɵmod: ɵNgModuleDef<T> };

function ɵisPromise

ɵisPromise: <T = any>(obj: any) => obj is Promise<T>;

Determine if the argument is shaped like a Promise

function ɵisSubscribable

ɵisSubscribable: <T>(obj: any | Subscribable<T>) => obj is Subscribable<T>;

Determine if the argument is a Subscribable

function ɵLifecycleHooksFeature

ɵLifecycleHooksFeature: () => void;

Used to enable lifecycle hooks on the root component.
Include this feature when calling renderComponent if the root component you are rendering has lifecycle hooks defined. Otherwise, the hooks won't be called properly.
Example:
renderComponent(AppComponent, {hostFeatures: [LifecycleHooksFeature]});

function ɵnoSideEffects

ɵnoSideEffects: <T>(fn: () => T) => T;

Convince closure compiler that the wrapped function has no side-effects.
Closure compiler always assumes that toString has no side-effects. We use this quirk to allow us to execute a function but have closure compiler mark the call as no-side-effects. It is important that the return value for the noSideEffects function be assigned to something which is retained otherwise the call to noSideEffects will be removed by closure compiler.

function ɵɵadvance

ɵɵadvance: (delta: number) => void;

Advances to an element for later binding instructions.

Used in conjunction with instructions like property to act on elements with specified indices, for example those created with element or elementStart.

(rf: RenderFlags, ctx: any) => {
  if (rf & 1) {
    text(0, 'Hello');
    text(1, 'Goodbye')
    element(2, 'div');
  }
  if (rf & 2) {
    advance(2); // Advance twice to the <div>.
    property('title', 'test');
  }
 }

Parameter delta

Number of elements to advance forwards by.

function ɵɵattribute

ɵɵattribute: (
    name: string,
    value: any,
    sanitizer?: SanitizerFn | null,
    namespace?: string
) => typeof ɵɵattribute;

Updates the value of or removes a bound attribute on an Element.
Used in the case of [attr.title]="value"
Parameter name
name The name of the attribute.
Parameter value
value The attribute is removed when value is null or undefined. Otherwise the attribute value is set to the stringified value.
Parameter sanitizer
An optional function used to sanitize the value.
Parameter namespace
Optional namespace to use when setting the attribute.

function ɵɵattributeInterpolate1

ɵɵattributeInterpolate1: (
    attrName: string,
    prefix: string,
    v0: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate1;

Update an interpolated attribute on an element with single bound value surrounded by text.
Used when the value passed to a property has 1 interpolated value in it:
<div attr.title="prefix{{v0}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate1('title', 'prefix', v0, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate2

ɵɵattributeInterpolate2: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate2;

Update an interpolated attribute on an element with 2 bound values surrounded by text.
Used when the value passed to a property has 2 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate2('title', 'prefix', v0, '-', v1, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate3

ɵɵattributeInterpolate3: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate3;

Update an interpolated attribute on an element with 3 bound values surrounded by text.
Used when the value passed to a property has 3 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate3( 'title', 'prefix', v0, '-', v1, '-', v2, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate4

ɵɵattributeInterpolate4: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate4;

Update an interpolated attribute on an element with 4 bound values surrounded by text.
Used when the value passed to a property has 4 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate4( 'title', 'prefix', v0, '-', v1, '-', v2, '-', v3, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate5

ɵɵattributeInterpolate5: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate5;

Update an interpolated attribute on an element with 5 bound values surrounded by text.
Used when the value passed to a property has 5 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate5( 'title', 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate6

ɵɵattributeInterpolate6: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate6;

Update an interpolated attribute on an element with 6 bound values surrounded by text.
Used when the value passed to a property has 6 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate6( 'title', 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate7

ɵɵattributeInterpolate7: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    i5: string,
    v6: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate7;

Update an interpolated attribute on an element with 7 bound values surrounded by text.
Used when the value passed to a property has 7 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate7( 'title', 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter i5
Static value used for concatenation only.
Parameter v6
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolate8

ɵɵattributeInterpolate8: (
    attrName: string,
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    i5: string,
    v6: any,
    i6: string,
    v7: any,
    suffix: string,
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolate8;

Update an interpolated attribute on an element with 8 bound values surrounded by text.
Used when the value passed to a property has 8 interpolated values in it:
<div attr.title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}-{{v7}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolate8( 'title', 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, '-', v7, 'suffix');
Parameter attrName
The name of the attribute to update
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter i5
Static value used for concatenation only.
Parameter v6
Value checked for change.
Parameter i6
Static value used for concatenation only.
Parameter v7
Value checked for change.
Parameter suffix
Static value used for concatenation only.
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵattributeInterpolateV

ɵɵattributeInterpolateV: (
    attrName: string,
    values: any[],
    sanitizer?: SanitizerFn,
    namespace?: string
) => typeof ɵɵattributeInterpolateV;

Update an interpolated attribute on an element with 9 or more bound values surrounded by text.
Used when the number of interpolated values exceeds 8.
<div title="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}-{{v7}}-{{v8}}-{{v9}}suffix"></div>
Its compiled representation is::
ɵɵattributeInterpolateV( 'title', ['prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, '-', v7, '-', v9, 'suffix']);
Parameter attrName
The name of the attribute to update.
Parameter values
The collection of values and the strings in-between those values, beginning with a string prefix and ending with a string suffix. (e.g. ['prefix', value0, '-', value1, '-', value2, ..., value99, 'suffix'])
Parameter sanitizer
An optional sanitizer function
Returns
itself, so that it may be chained.

function ɵɵclassMap

ɵɵclassMap: (classes: string | { [className: string]: boolean }) => void;

Update class bindings using an object literal or class-string on an element.
This instruction is meant to apply styling via the [class]="exp" template bindings. When classes are applied to the element they will then be updated with respect to any styles/classes set via classProp. If any classes are set to falsy then they will be removed from the element.
Note that the styling instruction will not be applied until stylingApply is called. Note that this will the provided classMap value to the host element if this function is called within a host binding.
Parameter classes
A key/value map or string of CSS classes that will be added to the given element. Any missing classes (that have already been applied to the element beforehand) will be removed (unset) from the element's list of CSS classes.

function ɵɵclassMapInterpolate1

ɵɵclassMapInterpolate1: (prefix: string, v0: any, suffix: string) => void;

Update an interpolated class on an element with single bound value surrounded by text.
Used when the value passed to a property has 1 interpolated value in it:
<div class="prefix{{v0}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate1('prefix', v0, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate2

ɵɵclassMapInterpolate2: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    suffix: string
) => void;

Update an interpolated class on an element with 2 bound values surrounded by text.
Used when the value passed to a property has 2 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate2('prefix', v0, '-', v1, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate3

ɵɵclassMapInterpolate3: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    suffix: string
) => void;

Update an interpolated class on an element with 3 bound values surrounded by text.
Used when the value passed to a property has 3 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate3( 'prefix', v0, '-', v1, '-', v2, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate4

ɵɵclassMapInterpolate4: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    suffix: string
) => void;

Update an interpolated class on an element with 4 bound values surrounded by text.
Used when the value passed to a property has 4 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate4( 'prefix', v0, '-', v1, '-', v2, '-', v3, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate5

ɵɵclassMapInterpolate5: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    suffix: string
) => void;

Update an interpolated class on an element with 5 bound values surrounded by text.
Used when the value passed to a property has 5 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate5( 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate6

ɵɵclassMapInterpolate6: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    suffix: string
) => void;

Update an interpolated class on an element with 6 bound values surrounded by text.
Used when the value passed to a property has 6 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate6( 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate7

ɵɵclassMapInterpolate7: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    i5: string,
    v6: any,
    suffix: string
) => void;

Update an interpolated class on an element with 7 bound values surrounded by text.
Used when the value passed to a property has 7 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate7( 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter i5
Static value used for concatenation only.
Parameter v6
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolate8

ɵɵclassMapInterpolate8: (
    prefix: string,
    v0: any,
    i0: string,
    v1: any,
    i1: string,
    v2: any,
    i2: string,
    v3: any,
    i3: string,
    v4: any,
    i4: string,
    v5: any,
    i5: string,
    v6: any,
    i6: string,
    v7: any,
    suffix: string
) => void;

Update an interpolated class on an element with 8 bound values surrounded by text.
Used when the value passed to a property has 8 interpolated values in it:
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}-{{v7}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolate8( 'prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, '-', v7, 'suffix');
Parameter prefix
Static value used for concatenation only.
Parameter v0
Value checked for change.
Parameter i0
Static value used for concatenation only.
Parameter v1
Value checked for change.
Parameter i1
Static value used for concatenation only.
Parameter v2
Value checked for change.
Parameter i2
Static value used for concatenation only.
Parameter v3
Value checked for change.
Parameter i3
Static value used for concatenation only.
Parameter v4
Value checked for change.
Parameter i4
Static value used for concatenation only.
Parameter v5
Value checked for change.
Parameter i5
Static value used for concatenation only.
Parameter v6
Value checked for change.
Parameter i6
Static value used for concatenation only.
Parameter v7
Value checked for change.
Parameter suffix
Static value used for concatenation only.

function ɵɵclassMapInterpolateV

ɵɵclassMapInterpolateV: (values: any[]) => void;

Update an interpolated class on an element with 9 or more bound values surrounded by text.
Used when the number of interpolated values exceeds 8.
<div class="prefix{{v0}}-{{v1}}-{{v2}}-{{v3}}-{{v4}}-{{v5}}-{{v6}}-{{v7}}-{{v8}}-{{v9}}suffix"></div>
Its compiled representation is:
ɵɵclassMapInterpolateV( ['prefix', v0, '-', v1, '-', v2, '-', v3, '-', v4, '-', v5, '-', v6, '-', v7, '-', v9, 'suffix']);
.
Parameter values
The collection of values and the strings in-between those values, beginning with a string prefix and ending with a string suffix. (e.g. ['prefix', value0, '-', value1, '-', value2, ..., value99, 'suffix'])

function ɵɵclassProp

ɵɵclassProp: (
    className: string,
    value: boolean | undefined | null
) => typeof ɵɵclassProp;

Update a class binding on an element with the provided value.
This instruction is meant to handle the [class.foo]="exp" case and, therefore, the class binding itself must already be allocated using styling within the creation block.
Parameter prop
A valid CSS class (only one).
Parameter value
A true/false value which will turn the class on or off.
Note that this will apply the provided class value to the host element if this function is called within a host binding function.

function ɵɵcomponentInstance

ɵɵcomponentInstance: () => unknown;

Instruction that returns the component instance in which the current instruction is executing. This is a constant-time version of nextContent for the case where we know that we need the component instance specifically, rather than the context of a particular template.

function ɵɵconditional

ɵɵconditional: <T>(
    containerIndex: number,
    matchingTemplateIndex: number,
    value?: T
) => void;

The conditional instruction represents the basic building block on the runtime side to support built-in "if" and "switch". On the high level this instruction is responsible for adding and removing views selected by a conditional expression.
Parameter containerIndex
index of a container in a host view (indexed from HEADER_OFFSET) where conditional views should be inserted.
Parameter matchingTemplateIndex
index of a template TNode representing a conditional view to be inserted; -1 represents a special case when there is no view to insert.

function ɵɵcontentQuery

ɵɵcontentQuery: <T>(
    directiveIndex: number,
    predicate: ProviderToken<unknown> | string[],
    flags: QueryFlags,
    read?: any
) => void;

Registers a QueryList, associated with a content query, for later refresh (part of a view refresh).
Parameter directiveIndex
Current directive index
Parameter predicate
The type for which the query will search
Parameter flags
Flags associated with the query
Parameter read
What to save in the query
Returns
QueryList

function ɵɵCopyDefinitionFeature

ɵɵCopyDefinitionFeature: (
    definition: ɵDirectiveDef<any> | ɵComponentDef<any>
) => void;

Copies the fields not handled by the ɵɵInheritDefinitionFeature from the supertype of a definition.
This exists primarily to support ngcc migration of an existing View Engine pattern, where an entire decorator is inherited from a parent to a child class. When ngcc detects this case, it generates a skeleton definition on the child class, and applies this feature.
The ɵɵCopyDefinitionFeature then copies any needed fields from the parent class' definition, including things like the component template function.
Parameter definition
The definition of a child class which inherits from a parent class with its own definition.

function ɵɵdefer

ɵɵdefer: (
    index: number,
    primaryTmplIndex: number,
    dependencyResolverFn?: DependencyResolverFn | null,
    loadingTmplIndex?: number | null,
    placeholderTmplIndex?: number | null,
    errorTmplIndex?: number | null,
    loadingConfigIndex?: number | null,
    placeholderConfigIndex?: number | null,
    enableTimerScheduling?: typeof ɵɵdeferEnableTimerScheduling
) => void;

Creates runtime data structures for defer blocks.
Parameter index
Index of the defer instruction.
Parameter primaryTmplIndex
Index of the template with the primary block content.
Parameter dependencyResolverFn
Function that contains dependencies for this defer block.
Parameter loadingTmplIndex
Index of the template with the loading block content.
Parameter placeholderTmplIndex
Index of the template with the placeholder block content.
Parameter errorTmplIndex
Index of the template with the error block content.
Parameter loadingConfigIndex
Index in the constants array of the configuration of the loading. block.
Parameter placeholderConfigIndex
Index in the constants array of the configuration of the placeholder block.
Parameter enableTimerScheduling
Function that enables timer-related scheduling if after or minimum parameters are setup on the @loading or @placeholder blocks.

function ɵɵdeferEnableTimerScheduling

ɵɵdeferEnableTimerScheduling: (
    tView: TView,
    tDetails: TDeferBlockDetails,
    placeholderConfigIndex?: number | null,
    loadingConfigIndex?: number | null
) => void;

Enables timer-related scheduling if after or minimum parameters are setup on the @loading or @placeholder blocks.

function ɵɵdeferOnHover

ɵɵdeferOnHover: (triggerIndex: number, walkUpTimes?: number) => void;

Creates runtime data structures for the on hover deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferOnIdle

ɵɵdeferOnIdle: () => void;

Sets up logic to handle the on idle deferred trigger.

function ɵɵdeferOnImmediate

ɵɵdeferOnImmediate: () => void;

Sets up logic to handle the on immediate deferred trigger.

function ɵɵdeferOnInteraction

ɵɵdeferOnInteraction: (triggerIndex: number, walkUpTimes?: number) => void;

Creates runtime data structures for the on interaction deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferOnTimer

ɵɵdeferOnTimer: (delay: number) => void;

Creates runtime data structures for the on timer deferred trigger.
Parameter delay
Amount of time to wait before loading the content.

function ɵɵdeferOnViewport

ɵɵdeferOnViewport: (triggerIndex: number, walkUpTimes?: number) => void;

Creates runtime data structures for the on viewport deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferPrefetchOnHover

ɵɵdeferPrefetchOnHover: (triggerIndex: number, walkUpTimes?: number) => void;

Creates runtime data structures for the prefetch on hover deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferPrefetchOnIdle

ɵɵdeferPrefetchOnIdle: () => void;

Sets up logic to handle the prefetch on idle deferred trigger.

function ɵɵdeferPrefetchOnImmediate

ɵɵdeferPrefetchOnImmediate: () => void;

Sets up logic to handle the prefetch on immediate deferred trigger.

function ɵɵdeferPrefetchOnInteraction

ɵɵdeferPrefetchOnInteraction: (
    triggerIndex: number,
    walkUpTimes?: number
) => void;

Creates runtime data structures for the prefetch on interaction deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferPrefetchOnTimer

ɵɵdeferPrefetchOnTimer: (delay: number) => void;

Creates runtime data structures for the prefetch on timer deferred trigger.
Parameter delay
Amount of time to wait before prefetching the content.

function ɵɵdeferPrefetchOnViewport

ɵɵdeferPrefetchOnViewport: (triggerIndex: number, walkUpTimes?: number) => void;

Creates runtime data structures for the prefetch on viewport deferred trigger.
Parameter triggerIndex
Index at which to find the trigger element.
Parameter walkUpTimes
Number of times to walk up/down the tree hierarchy to find the trigger.

function ɵɵdeferPrefetchWhen

ɵɵdeferPrefetchWhen: (rawValue: unknown) => void;

Prefetches the deferred content when a value becomes truthy.

function ɵɵdeferWhen

ɵɵdeferWhen: (rawValue: unknown) => void;

Loads defer block dependencies when a trigger value becomes truthy.

function ɵɵdefineComponent

ɵɵdefineComponent: <T>(
    componentDefinition: ComponentDefinition<T>
) => Mutable<ɵComponentDef<any>, keyof ɵComponentDef<any>>;

Create a component definition object.

# Example

class MyComponent {
  // Generated by Angular Template Compiler
  // [Symbol] syntax will not be supported by TypeScript until v2.7
  static ɵcmp = defineComponent({
    ...
  });
}

function ɵɵdefineDirective

ɵɵdefineDirective: <T>(
    directiveDefinition: DirectiveDefinition<T>
) => Mutable<ɵDirectiveDef<any>, keyof ɵDirectiveDef<any>>;

Create a directive definition object.

# Example

class MyDirective {
  // Generated by Angular Template Compiler
  // [Symbol] syntax will not be supported by TypeScript until v2.7
  static ɵdir = ɵɵdefineDirective({
    ...
  });
}

function ɵɵdefineInjectable

ɵɵdefineInjectable: <T>(opts: {
    token: unknown;
    providedIn?: Type<any> | 'root' | 'platform' | 'any' | 'environment' | null;
    factory: () => T;
}) => unknown;

Construct an injectable definition which defines how a token will be constructed by the DI system, and in which injectors (if any) it will be available.
This should be assigned to a static ɵprov field on a type, which will then be an InjectableType.
Options: * providedIn determines which injectors will include the injectable, by either associating it with an @NgModule or other InjectorType, or by specifying that this injectable should be provided in the 'root' injector, which will be the application-level injector in most apps. * factory gives the zero argument function which will create an instance of the injectable. The factory can call [inject](api/core/inject) to access the Injector and request injection of dependencies.
This instruction has been emitted by ViewEngine for some time and is deployed to npm.

function ɵɵdefineInjector

ɵɵdefineInjector: (options: { providers?: any[]; imports?: any[] }) => unknown;

Construct an InjectorDef which configures an injector.
This should be assigned to a static injector def (ɵinj) field on a type, which will then be an InjectorType.
Options:
* providers: an optional array of providers to add to the injector. Each provider must either have a factory or point to a type which has a ɵprov static property (the type must be an InjectableType). * imports: an optional array of imports of other InjectorTypes or InjectorTypeWithModules whose providers will also be added to the injector. Locally provided types will override providers from imports.

function ɵɵdefineNgModule

ɵɵdefineNgModule: <T>(def: {
    type: T;
    bootstrap?: Type<any>[] | (() => Type<any>[]);
    declarations?: Type<any>[] | (() => Type<any>[]);
    imports?: Type<any>[] | (() => Type<any>[]);
    exports?: Type<any>[] | (() => Type<any>[]);
    schemas?: SchemaMetadata[] | null;
    id?: string | null;
}) => unknown;

function ɵɵdefinePipe

ɵɵdefinePipe: <T>(pipeDef: {
    name: string;
    type: Type<T>;
    pure?: boolean;
    standalone?: boolean;
}) => unknown;

Create a pipe definition object.

# Example

class MyPipe implements PipeTransform {
  // Generated by Angular Template Compiler
  static ɵpipe = definePipe({
    ...
  });
}

Parameter pipeDef

Pipe definition generated by the compiler

function ɵɵdirectiveInject

ɵɵdirectiveInject: {
    <T>(token: ProviderToken<T>): T;
    <T>(token: ProviderToken<T>, flags: InjectFlags): T;
};

Returns the value associated to the given token from the injectors.
directiveInject is intended to be used for directive, component and pipe factories. All other injection use inject which does not walk the node injector tree.
Usage example (in factory function):
class SomeDirective { constructor(directive: DirectiveA) {} static ɵdir = ɵɵdefineDirective({ type: SomeDirective, factory: () => new SomeDirective(ɵɵdirectiveInject(DirectiveA)) }); }
Parameter token
the type or token to inject
Parameter flags
Injection flags
Returns
the value from the injector or null when not found

function ɵɵdisableBindings

ɵɵdisableBindings: () => void;

Disables directive matching on element.

* Example:

<my-comp my-directive>
  Should match component / directive.
</my-comp>
<div ngNonBindable>
  <!-- ɵɵdisableBindings() -->
  <my-comp my-directive>
    Should not match component / directive because we are in ngNonBindable.
  </my-comp>
  <!-- ɵɵenableBindings() -->
</div>

function ɵɵelement

ɵɵelement: (
    index: number,
    name: string,
    attrsIndex?: number | null,
    localRefsIndex?: number
) => typeof ɵɵelement;

Creates an empty element using elementStart and elementEnd
Parameter index
Index of the element in the data array
Parameter name
Name of the DOM Node
Parameter attrsIndex
Index of the element's attributes in the consts array.
Parameter localRefsIndex
Index of the element's local references in the consts array.
Returns
This function returns itself so that it may be chained.

function ɵɵelementContainer

ɵɵelementContainer: (
    index: number,
    attrsIndex?: number | null,
    localRefsIndex?: number
) => typeof ɵɵelementContainer;

Creates an empty logical container using elementContainerStart and elementContainerEnd
Parameter index
Index of the element in the LView array
Parameter attrsIndex
Index of the container attributes in the consts array.
Parameter localRefsIndex
Index of the container's local references in the consts array.
Returns
This function returns itself so that it may be chained.

function ɵɵelementContainerEnd

ɵɵelementContainerEnd: () => typeof ɵɵelementContainerEnd;

Mark the end of the .
Returns
This function returns itself so that it may be chained.

function ɵɵelementContainerStart

ɵɵelementContainerStart: (
    index: number,
    attrsIndex?: number | null,
    localRefsIndex?: number
) => typeof ɵɵelementContainerStart;

Creates a logical container for other nodes () backed by a comment node in the DOM. The instruction must later be followed by elementContainerEnd() call.
Parameter index
Index of the element in the LView array
Parameter attrsIndex
Index of the container attributes in the consts array.
Parameter localRefsIndex
Index of the container's local references in the consts array.
Returns
This function returns itself so that it may be chained.
Even if this instruction accepts a set of attributes no actual attribute values are propagated to the DOM (as a comment node can't have attributes). Attributes are here only for directive matching purposes and setting initial inputs of directives.

function ɵɵelementEnd

ɵɵelementEnd: () => typeof ɵɵelementEnd;

Mark the end of the element.
Returns
This function returns itself so that it may be chained.

function ɵɵelementStart

ɵɵelementStart: (
    index: number,
    name: string,
    attrsIndex?: number | null,
    localRefsIndex?: number
) => typeof ɵɵelementStart;

Create DOM element. The instruction must later be followed by elementEnd() call.
Parameter index
Index of the element in the LView array
Parameter name
Name of the DOM Node
Parameter attrsIndex
Index of the element's attributes in the consts array.
Parameter localRefsIndex
Index of the element's local references in the consts array.
Returns
This function returns itself so that it may be chained.
Attributes and localRefs are passed as an array of strings where elements with an even index hold an attribute name and elements with an odd index hold an attribute value, ex.: ['id', 'warning5', 'class', 'alert']

function ɵɵenableBindings

ɵɵenableBindings: () => void;

Enables directive matching on elements.

* Example:

<my-comp my-directive>
  Should match component / directive.
</my-comp>
<div ngNonBindable>
  <!-- ɵɵdisableBindings() -->
  <my-comp my-directive>
    Should not match component / directive because we are in ngNonBindable.
  </my-comp>
  <!-- ɵɵenableBindings() -->
</div>

function ɵɵgetComponentDepsFactory

ɵɵgetComponentDepsFactory: (
    type: ɵComponentType<any>,
    rawImports?: RawScopeInfoFromDecorator[]
) => () => DependencyTypeList;

function ɵɵgetCurrentView

ɵɵgetCurrentView: () => OpaqueViewState;

Returns the current OpaqueViewState instance.
Used in conjunction with the restoreView() instruction to save a snapshot of the current view and restore it when listeners are invoked. This allows walking the declaration view tree in listeners to get vars from parent views.

function ɵɵgetInheritedFactory

ɵɵgetInheritedFactory: <T>(type: Type<any>) => (type: Type<T>) => T;

function ɵɵHostDirectivesFeature

ɵɵHostDirectivesFeature: (
    rawHostDirectives: HostDirectiveConfig[] | (() => HostDirectiveConfig[])
) => DirectiveDefFeature;

This feature adds the host directives behavior to a directive definition by patching a function onto it. The expectation is that the runtime will invoke the function during directive matching.

For example:

class ComponentWithHostDirective {
  static ɵcmp = defineComponent({
   type: ComponentWithHostDirective,
   features: [ɵɵHostDirectivesFeature([
     SimpleHostDirective,
     {directive: AdvancedHostDirective, inputs: ['foo: alias'], outputs: ['bar']},
   ])]
 });
}

function ɵɵhostProperty

ɵɵhostProperty: <T>(
    propName: string,
    value: T,
    sanitizer?: SanitizerFn | null
) => typeof ɵɵhostProperty;

Update a property on a host element. Only applies to native node properties, not inputs.
Operates on the element selected by index via the select instruction.
Parameter propName
Name of property. Because it is going to DOM, this is not subject to renaming as part of minification.
Parameter value
New value to write.
Parameter sanitizer
An optional function used to sanitize the value.
Returns
This function returns itself so that it may be chained (e.g. property('name', ctx.name)('title', ctx.title))

function ɵɵi18n

ɵɵi18n: (index: number, messageIndex: number, subTemplateIndex?: number) => void;

Use this instruction to create a translation block that doesn't contain any placeholder. It calls both i18nStart and i18nEnd in one instruction.
The translation message is the value which is locale specific. The translation string may contain placeholders which associate inner elements and sub-templates within the translation.
The translation message placeholders are: - �{index}(:{block})�: *Binding Placeholder*: Marks a location where an expression will be interpolated into. The placeholder index points to the expression binding index. An optional block that matches the sub-template in which it was declared. - �#{index}(:{block})�/�/#{index}(:{block})�: *Element Placeholder*: Marks the beginning and end of DOM element that were embedded in the original translation block. The placeholder index points to the element index in the template instructions set. An optional block that matches the sub-template in which it was declared. - �*{index}:{block}�/�/*{index}:{block}�: *Sub-template Placeholder*: Sub-templates must be split up and translated separately in each angular template function. The index points to the template instruction index. A block that matches the sub-template in which it was declared.
Parameter index
A unique index of the translation in the static block.
Parameter messageIndex
An index of the translation message from the def.consts array.
Parameter subTemplateIndex
Optional sub-template index in the message.

function ɵɵi18nApply

ɵɵi18nApply: (index: number) => void;

Updates a translation block or an i18n attribute when the bindings have changed.
Parameter index
Index of either i18nStart (translation block) or i18nAttributes (i18n attribute) on which it should update the content.

function ɵɵi18nAttributes

ɵɵi18nAttributes: (index: number, attrsIndex: number) => void;

Marks a list of attributes as translatable.
Parameter index
A unique index in the static block
Parameter values

function ɵɵi18nEnd

ɵɵi18nEnd: () => void;

Translates a translation block marked by i18nStart and i18nEnd. It inserts the text/ICU nodes into the render tree, moves the placeholder nodes and removes the deleted nodes.

function ɵɵi18nExp

ɵɵi18nExp: <T>(value: T) => typeof ɵɵi18nExp;

Stores the values of the bindings during each update cycle in order to determine if we need to update the translated nodes.
Parameter value
The binding's value
Returns
This function returns itself so that it may be chained (e.g. i18nExp(ctx.name)(ctx.title))

function ɵɵi18nPostprocess

ɵɵi18nPostprocess: (
    message: string,
    replacements?: { [key: string]: string | string[] }
) => string;

Handles message string post-processing for internationalization.
Handles message string post-processing by transforming it from intermediate format (that might contain some markers that we need to replace) to the final form, consumable by i18nStart instruction. Post processing steps include:
1. Resolve all multi-value cases (like [�*1:1��#2:1�|�#4:1�|�5�]) 2. Replace all ICU vars (like "VAR_PLURAL") 3. Replace all placeholders used inside ICUs in a form of {PLACEHOLDER} 4. Replace all ICU references with corresponding values (like �ICU_EXP_ICU_1�) in case multiple ICUs have the same placeholder name
Parameter message
Raw translation string for post processing
Parameter replacements
Set of replacements that should be applied
Returns
Transformed string that can be consumed by i18nStart instruction

function ɵɵi18nStart

ɵɵi18nStart: (
    index: number,
    messageIndex: number,
    subTemplateIndex?: number
) => void;

Marks a block of text as translatable.
The instructions i18nStart and i18nEnd mark the translation block in the template. The translation message is the value which is locale specific. The translation string may contain placeholders which associate inner elements and sub-templates within the translation.
The translation message placeholders are: - �{index}(:{block})�: *Binding Placeholder*: Marks a location where an expression will be interpolated into. The placeholder index points to the expression binding index. An optional block that matches the sub-template in which it was declared. - �#{index}(:{block})�/�/#{index}(:{block})�: *Element Placeholder*: Marks the beginning and end of DOM element that were embedded in the original translation block. The placeholder index points to the element index in the template instructions set. An optional block that matches the sub-template in which it was declared. - �*{index}:{block}�/�/*{index}:{block}�: *Sub-template Placeholder*: Sub-templates must be split up and translated separately in each angular template function. The index points to the template instruction index. A block that matches the sub-template in which it was declared.
Parameter index
A unique index of the translation in the static block.
Parameter messageIndex
An index of the translation message from the def.consts array.
Parameter subTemplateIndex
Optional sub-template index in the message.

function ɵɵInheritDefinitionFeature

ɵɵInheritDefinitionFeature: (
    definition: ɵDirectiveDef<any> | ɵComponentDef<any>
) => void;

Merges the definition from a super class to a sub class.
Parameter definition
The definition that is a SubClass of another directive of component

function ɵɵinject

ɵɵinject: {
    <T>(token: ProviderToken<T>): T;
    <T>(token: ProviderToken<T>, flags?: InjectFlags): T;
};

Generated instruction: injects a token from the currently active injector.
(Additional documentation moved to inject, as it is the public API, and an alias for this instruction)
See Also
- inject This instruction has been emitted by ViewEngine for some time and is deployed to npm.

function ɵɵinjectAttribute

ɵɵinjectAttribute: (attrNameToInject: string) => string | null;

Facade for the attribute injection from DI.

function ɵɵInputTransformsFeature

ɵɵInputTransformsFeature: (definition: ɵDirectiveDef<unknown>) => void;

Decorates the directive definition with support for input transform functions.
If the directive uses inheritance, the feature should be included before the InheritDefinitionFeature to ensure that the inputTransforms field is populated.

function ɵɵinvalidFactory

ɵɵinvalidFactory: () => never;

Throws an error indicating that a factory function could not be generated by the compiler for a particular class.
This instruction allows the actual error message to be optimized away when ngDevMode is turned off, saving bytes of generated code while still providing a good experience in dev mode.
The name of the class is not mentioned here, but will be in the generated factory function name and thus in the stack trace.

function ɵɵinvalidFactoryDep

ɵɵinvalidFactoryDep: (index: number) => never;

Throws an error indicating that a factory function could not be generated by the compiler for a particular class.
The name of the class is not mentioned here, but will be in the generated factory function name and thus in the stack trace.

function ɵɵlistener

ɵɵlistener: (
    eventName: string,
    listenerFn: (e?: any) => any,
    useCapture?: boolean,
    eventTargetResolver?: GlobalTargetResolver
) => typeof ɵɵlistener;

Adds an event listener to the current node.
If an output exists on one of the node's directives, it also subscribes to the output and saves the subscription for later cleanup.
Parameter eventName
Name of the event
Parameter listenerFn
The function to be called when event emits
Parameter useCapture
Whether or not to use capture in event listener - this argument is a reminder from the Renderer3 infrastructure and should be removed from the instruction arguments
Parameter eventTargetResolver
Function that returns global target information in case this listener should be attached to a global object like window, document or body

function ɵɵloadQuery

ɵɵloadQuery: <T>() => QueryList<T>;

Loads a QueryList corresponding to the current view or content query.

function ɵɵnamespaceHTML

ɵɵnamespaceHTML: () => void;

Sets the namespace used to create elements to null, which forces element creation to use createElement rather than createElementNS.

function ɵɵnamespaceMathML

ɵɵnamespaceMathML: () => void;

Sets the namespace used to create elements to 'http://www.w3.org/1998/MathML/' in global state.

function ɵɵnamespaceSVG

ɵɵnamespaceSVG: () => void;

Sets the namespace used to create elements to 'http://www.w3.org/2000/svg' in global state.

function ɵɵnextContext

ɵɵnextContext: <T = any>(level?: number) => T;

Retrieves a context at the level specified and saves it as the global, contextViewData. Will get the next level up if level is not specified.
This is used to save contexts of parent views so they can be bound in embedded views, or in conjunction with reference() to bind a ref from a parent view.
Parameter level
The relative level of the view from which to grab context compared to contextVewData
Returns
context

function ɵɵngDeclareClassMetadata

ɵɵngDeclareClassMetadata: (decl: {
    type: Type<any>;
    decorators: any[];
    ctorParameters?: () => any[];
    propDecorators?: { [field: string]: any };
}) => void;

Evaluates the class metadata declaration.

function ɵɵngDeclareComponent

ɵɵngDeclareComponent: (decl: R3DeclareComponentFacade) => unknown;

Compiles a partial component declaration object into a full component definition object.

function ɵɵngDeclareDirective

ɵɵngDeclareDirective: (decl: R3DeclareDirectiveFacade) => unknown;

Compiles a partial directive declaration object into a full directive definition object.

function ɵɵngDeclareFactory

ɵɵngDeclareFactory: (decl: R3DeclareFactoryFacade) => unknown;

Compiles a partial pipe declaration object into a full pipe definition object.

function ɵɵngDeclareInjectable

ɵɵngDeclareInjectable: (decl: R3DeclareInjectableFaca

@angular/core

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Enums

Type Aliases

Namespaces

Variables

variable ANIMATION_MODULE_TYPE

variable APP_BOOTSTRAP_LISTENER

variable APP_ID

variable APP_INITIALIZER

See Also

variable Attribute

variable CHILD_HEAD

variable CHILD_TAIL

variable CLEANUP

variable COMPILER_OPTIONS

variable Component

variable CONTAINERS

variable ContentChild

variable ContentChildren

variable CONTEXT

variable createNgModuleRef

Deprecated

variable CSP_NONCE

variable CUSTOM_ELEMENTS_SCHEMA

variable DECLARATION_COMPONENT_VIEW

variable DECLARATION_LCONTAINER

variable DECLARATION_VIEW

variable DEFAULT_CURRENCY_CODE

variable defineInjectable

Deprecated

variable DEHYDRATED_VIEWS

variable Directive

variable DISCONNECTED_NODES

variable EFFECTS_TO_SCHEDULE

variable ELEMENT_CONTAINERS

variable ELEMENT_MARKER

variable EMBEDDED_VIEW_INJECTOR

variable ENVIRONMENT

variable ENVIRONMENT_INITIALIZER

variable EventEmitter

variable FLAGS

variable Host

variable HOST

variable HostBinding

variable HostListener

variable HYDRATION

variable ICU_MARKER

variable ID

variable Inject

variable Injectable

variable INJECTOR

variable INJECTOR_2

variable Input

variable ITS_JUST_ANGULAR

variable LOCALE_ID

variable MOVED_VIEWS

variable MULTIPLIER

variable NATIVE

variable NEXT

variable NgModule

variable NO_ERRORS_SCHEMA

variable NODES

variable NUM_ROOT_NODES

variable ON_DESTROY_HOOKS

variable Optional

variable Output

variable ɵALLOW_MULTIPLE_PLATFORMS

variable ɵCONTAINER_HEADER_OFFSET

variable ɵDEFAULT_LOCALE_ID

variable ɵdefaultIterableDiffers

variable ɵdefaultKeyValueDiffers

variable ɵDEFER_BLOCK_CONFIG

variable ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR