@angular/core

Implements Angular's core functionality, low-level services, and utilities.

  • Defines the class infrastructure for components, view hierarchies, change detection, rendering, and event handling.

  • Defines the decorators that supply metadata and context for Angular constructs.

  • Defines infrastructure for dependency injection (DI), internationalization (i18n), and various testing and debugging facilities.

入口点

主要

@angular/core

Implements Angular's core functionality, low-level services, and utilities.

次要

@angular/core/testing

主入口点的导出

模块

ApplicationModule

Configures the root injector for an app with providers of @angular/core dependencies that ApplicationRef needs to bootstrap components.

ApplicationInitStatus

A class that reflects the state of running APP_INITIALIZERs.

ChangeDetectorRef

Angular 各种视图的基础类,提供变更检测功能。 变更检测树会收集要检查的所有视图。 使用这些方法从树中添加或移除视图、初始化变更检测并显式地把这些视图标记为脏的,意思是它们变了、需要重新渲染。

Base class for Angular Views, provides change detection functionality. A change-detection tree collects all views that are to be checked for changes. Use the methods to add and remove views from the tree, initiate change-detection, and explicitly mark views as dirty, meaning that they have changed and need to be rerendered.

Compiler

Low-level service for running the angular compiler during runtime to create ComponentFactorys, which can later be used to create and render a Component instance.

CompilerFactory

A factory for creating a Compiler

ComponentFactory
ComponentFactoryResolver
ComponentRef

Represents a component created by a ComponentFactory. Provides access to the component instance and related objects, and provides the means of destroying the instance.

DefaultIterableDiffer

已废弃: v4.0.0 - Should not be part of public API.

ElementRef

对视图中某个原生元素的包装器。

A wrapper around a native element inside of a View.

EmbeddedViewRef

Represents an Angular view in a view container. An embedded view can be referenced from a component other than the hosting component whose template defines it, or it can be defined independently by a TemplateRef.

ErrorHandler

Provides a hook for centralized exception handling.

EventEmitter

Use in directives and components to emit custom events synchronously or asynchronously, and register handlers for those events by subscribing to an instance.

InjectionToken

Creates a token that can be used in a DI Provider.

Injector

Concrete injectors implement this interface.

IterableDiffers

A repository of different iterable diffing strategies used by NgFor, NgClass, and others.

KeyValueDiffers

A repository of different Map diffing strategies used by NgClass, NgStyle, and others.

ModuleWithComponentFactories

Combination of NgModuleFactory and ComponentFactorys.

NgModuleFactory
NgModuleFactoryLoader

Used to load ng module factories.

NgModuleRef

Represents an instance of an NgModule created via a NgModuleFactory.

NgProbeToken

A token for third-party components that can register themselves with NgProbe.

NgZone

An injectable service for executing work inside or outside of the Angular zone.

Query

Base class for query metadata.

QueryList

一个不可修改的条目列表,当应用状态变化时,Angular 会保证它是最新的。

An unmodifiable list of items that Angular keeps up to date when the state of the application changes.

ReflectiveInjector

已废弃: from v5 - slow and brings in a lot of code, Use Injector.create instead.

A ReflectiveDependency injection container used for instantiating objects and resolving dependencies.

ReflectiveKey

已废弃: No replacement

A unique object used for retrieving items from the ReflectiveInjector.

RenderComponentType

已废弃: Use RendererType2 (and Renderer2) instead.

Renderer

已废弃: Use the Renderer2 instead.

Renderer2

扩展此基类以实现自定义渲染器。默认情况下,Angular 会把模板渲染成 DOM。 你可以使用自定义渲染器来拦截渲染类调用,或用于渲染一些非 DOM 的东西。

Extend this base class to implement custom rendering. By default, Angular renders a template into DOM. You can use custom rendering to intercept rendering calls, or to render to something other than DOM.

RendererFactory2

Creates and initializes a custom renderer that implements the Renderer2 base class.

ResolvedReflectiveFactory

An internal resolved representation of a factory function created by resolving Provider.

RootRenderer

已废弃: Use RendererFactory2 instead.

Injectable service that provides a low-level interface for modifying the UI.

Sanitizer

Sanitizer is used by the views to sanitize potentially dangerous values.

SimpleChange

表示从旧值到新值的一次变更。

Represents a basic change from a previous to a new value.

SystemJsNgModuleLoader

NgModuleFactoryLoader that uses SystemJS to load NgModuleFactory

SystemJsNgModuleLoaderConfig

Configuration for SystemJsNgModuleLoader. token.

TemplateRef

表示一个内嵌模板,它可用于实例化内嵌的视图。 要想根据模板实例化内嵌的视图,请使用 ViewContainerRefcreateEmbeddedView() 方法。

Represents an embedded template that can be used to instantiate embedded views. To instantiate embedded views based on a template, use the ViewContainerRef method createEmbeddedView().

Testability

The Testability service provides testing hooks that can be accessed from the browser and by services such as Protractor. Each bootstrapped Angular application on the page will have an instance of Testability.

TestabilityRegistry

A global registry of Testabilityinstances for specific elements.

Version

Represents the version of Angular

ViewContainerRef

表示可以将一个或多个视图附着到组件中的容器。

Represents a container where one or more views can be attached to a component.

ViewRef

Represents an Angular view, specifically the host view that is defined by a component. Also serves as the base class that adds destroy methods for embedded views.

WrappedValue

表示 Pipe转换的值已经变化了 —— 即使其引用并没有变。

Indicates that the result of a Pipetransformation has changed even though the reference has not changed.

装饰器

Attribute

Attribute decorator and metadata.

Component

一个装饰器,用于把某个类标记为 Angular 组件,并为它配置一些元数据,以决定该组件在运行期间该如何处理、实例化和使用。

Decorator that marks a class as an Angular component and provides configuration metadata that determines how the component should be processed, instantiated, and used at runtime.

ContentChild

Configures a content query.

ContentChildren

Configures a content query.

Directive

把一个类标记为 Angular 指令。你可以定义自己的指令来为 DOM 中的元素添加自定义行为。 该选项提供配置元数据,用于决定该指令在运行期间要如何处理、实例化和使用。

Marks a class as an Angular directive. You can define your own directives to attach custom behavior to elements in the DOM. The options provide configuration metadata that determines how the directive should be processed, instantiated and used at runtime.

Host

A constructor parameter decorator that tells the DI framework to retrieve a dependency from any injector until reaching the host element of the current component.

HostBinding
HostListener

把一个事件绑定到一个宿主监听器,并提供配置元数据。 当宿主元素发出特定的事件时,Angular 就会执行所提供的处理器方法,并使用其结果更新所绑定到的元素。 如果该事件处理器返回 false,则在所绑定的元素上执行 preventDefault

Binds a CSS 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.

Inject

A constructor parameter decorator that specifies a custom provider of a dependency.

Injectable

标记性元数据,表示一个类可以由 Injector 进行创建。

A marker metadata that marks a class as available to Injector for creation.

Input
NgModule
Optional

A constructor parameter decorator that marks a dependency as optional.

Output
Pipe
Self

A constructor parameter decorator that tells the DI framework to retrieve a dependency only from the local injector.

SkipSelf

A constructor parameter decorator that tells the DI framework that dependency resolution should start from the parent injector.

ViewChild

属性装饰器,用于配置一个视图查询。 变更检测器会在视图的 DOM 中查找能匹配上该选择器的第一个元素或指令。 如果视图的 DOM 发生了变化,出现了匹配该选择器的新的子节点,该属性就会被更新。

Property decorator that configures a view query. The change detector looks for the first element or the directive matching the selector in the view DOM. If the view DOM changes, and a new child matches the selector, the property is updated.

ViewChildren

Configures a view query.

函数

asNativeElements
assertPlatform

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

createInjector

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

createPlatform

Creates a platform. Platforms have to be eagerly created via this function.

createPlatformFactory

Creates a factory for a platform

defineInjectable

Construct an InjectableDef which defines how a token will be constructed by the DI system, and in which injectors (if any) it will be available.

defineInjector

Construct an InjectorDef which configures an injector.

destroyPlatform

Destroy the existing platform.

enableProdMode

Disable Angular's development mode, which turns off assertions and other checks within the framework.

forwardRef

Allows to refer to references which are not yet defined.

getPlatform

Returns the current platform.

inject
isDevMode

Returns whether Angular is in development mode. After called once, the value is locked and won't change any more.

resolveForwardRef

Lazily retrieves the reference value from a forwardRef.

setTestabilityGetter

Set the GetTestabilityimplementation used by the Angular testing framework.

结构

AfterContentChecked

一个生命周期钩子,它会在默认的变更检测器对指令的所有内容完成了变更检查之后调用。

A lifecycle hook that is called after the default change detector has completed checking all content of a directive.

AfterContentInit

一个生命周期钩子,它会在 Angular 完全实例化了指令的所有内容之后调用。 定义一个 ngAfterContentInit() 方法来处理额外的初始化任务。

A lifecycle hook that is called after Angular has fully initialized all content of a directive. Define an ngAfterContentInit() method to handle any additional initialization tasks.

AfterViewChecked

一个生命周期钩子,它会在默认的变更检测器完成了对组件视图的变更检测之后调用。

A lifecycle hook that is called after the default change detector has completed checking a component's view for changes.

AfterViewInit

一个生命周期钩子,会在 Angular 完全初始化了组件的视图后调用。 定义一个 ngAfterViewInit() 方法来处理一些额外的初始化任务。

A lifecycle hook that is called after Angular has fully initialized a component's view. Define an ngAfterViewInit() method to handle any additional initialization tasks.

ApplicationRef

A reference to an Angular application running on a page.

ChangeDetectionStrategy

The strategy that the default change detector uses to detect changes. When set, takes effect the next time change detection is triggered.

ClassProvider

Configures the Injector to return an instance of useClass for a token.

CollectionChangeRecord

已废弃: v4.0.0 - Use IterableChangeRecord instead.

ConstructorSansProvider

Configures the Injector to return an instance of a token.

DebugElement
DebugNode
DoBootstrap

Hook for manual bootstrapping of the application instead of using bootstrap array in @NgModule annotation.

DoCheck

一个生命周期钩子,除了使用默认的变更检查器执行检查之外,还会为指令执行自定义的变更检测函数。

A lifecycle hook that invokes a custom change-detection function for a directive, in addition to the check performed by the default change-detector.

ExistingProvider

Configures the Injector to return a value of another useExisting token.

FactoryProvider

Configures the Injector to return a value by invoking a useFactory function.

ForwardRefFn

An interface that a function passed into forwardRefhas to implement.

GetTestability

Adapter interface for retrieving the Testability service associated for a particular context.

InjectFlags

Injection flags for DI.

InjectableType

A Type which has an InjectableDef static field.

InjectorType

A type which has an InjectorDef static field.

IterableChangeRecord

Record representing the item change information.

IterableChanges

An object describing the changes in the Iterable collection since last time IterableDiffer#diff() was invoked.

IterableDiffer

A strategy for tracking changes over time to an iterable. Used by NgForOfto respond to changes in an iterable by effecting equivalent changes in the DOM.

IterableDifferFactory

Provides a factory for IterableDiffer.

KeyValueChangeRecord

Record representing the item change information.

KeyValueChanges

An object describing the changes in the Map or {[k:string]: string} since last time KeyValueDiffer#diff() was invoked.

KeyValueDiffer

A differ that tracks changes made to an object over time.

KeyValueDifferFactory

Provides a factory for KeyValueDiffer.

MissingTranslationStrategy

Use this enum at bootstrap as an option of bootstrapModule to define the strategy that the compiler should use in case of missing translations:

  • Error: throw if you have missing translations.
  • Warning (default): show a warning in the console and/or shell.
  • Ignore: do nothing.
ModuleWithProviders

对 NgModule 及其相关 providers 的包装。

A wrapper around an NgModule that associates it with the providers.

OnChanges

一个生命周期钩子,当指令的任何一个可绑定属性发生变化时调用。 定义一个 ngOnChanges() 方法来处理这些变更。

A lifecycle hook that is called when any data-bound property of a directive changes. Define an ngOnChanges() method to handle the changes.

OnDestroy

一个生命周期钩子,它会在指令、管道或服务被销毁时调用。 用于在实例被销毁时,执行一些自定义清理代码。

A lifecycle hook that is called when a directive, pipe, or service is destroyed. Use for any custom cleanup that needs to occur when the instance is destroyed.

OnInit

一个生命周期钩子,它会在 Angular 初始化完了该指令的所有数据绑定属性之后调用。 定义 ngOnInit() 方法可以处理所有附加的初始化任务。

A lifecycle hook that is called after Angular has initialized all data-bound properties of a directive. Define an ngOnInit() method to handle any additional initialization tasks.

PipeTransform

要创建一个管道,你必须实现该接口。

To create a Pipe, you must implement this interface.

PlatformRef

The Angular platform is the entry point for Angular on a web page. Each page has exactly one platform, and services (such as reflection) which are common to every Angular application running on the page are bound in its scope.

Predicate

A boolean-valued function over a value, possibly including context information regarding that value's position in an array.

RendererStyleFlags2

Flags for renderer-specific style modifiers.

RendererType2

Used by RendererFactory2 to associate custom rendering data and styles with a rendering implementation.

ResolvedReflectiveProvider

An internal resolved representation of a Provider used by the Injector.

SchemaMetadata

与 NgModule 相关的 schema(HTML架构)定义。

A schema definition associated with an NgModule.

SecurityContext

A SecurityContext marks a location that has dangerous security implications, e.g. a DOM property like innerHTML that could cause Cross Site Scripting (XSS) security bugs when improperly handled.

SimpleChanges

定义一个对象,它把属性与 SimpleChange 的实例关联起来。

Defines an object that associates properties with instances of SimpleChange.

TrackByFunction

An optional function passed into NgForOfthat defines how to track items in an iterable (e.g. fby index or id)

Type

Represents a type that a Component or other object is instances of.

TypeDecorator

An interface implemented by all Angular type decorators, which allows them to be used as ES7 decorators as well as Angular DSL syntax.

TypeProvider

Configures the Injector to return an instance of Type when `Type' is used as the token.

ValueProvider

Configures the Injector to return a value for a token.

ViewEncapsulation

Defines template and style encapsulation options available for Component's Component.

WtfScopeFn

A scope function for the Web Tracing Framework (WTF).

类型

ANALYZE_FOR_ENTRY_COMPONENTS

This token can be used to create a virtual provider that will populate the entryComponents fields of components and ng modules based on its useValue. All components that are referenced in the useValue value (either directly or in a nested array or map) will be added to the entryComponents property.

APP_BOOTSTRAP_LISTENER

All callbacks provided via this token will be called for every component that is bootstrapped. Signature of the callback:

APP_ID

A DI Token representing a unique string id assigned to the application by Angular and used primarily for prefixing application attributes and CSS styles when ViewEncapsulation.Emulated is being used.

APP_INITIALIZER

A function that will be executed when an application is initialized.

COMPILER_OPTIONS

Token to provide CompilerOptions in the platform injector.

CUSTOM_ELEMENTS_SCHEMA

定义一个 schema,它允许 NgModule 包含下列内容:

Defines a schema that allows an NgModule to contain the following:

CompilerOptions

Options for creating a compiler

INJECTOR

An InjectionToken that gets the current Injector for createInjector()-style injectors.

InjectableProvider

@Injectable 装饰器中使用的可注入对象提供商。

Injectable providers used in @Injectable decorator.

LOCALE_ID

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.

NO_ERRORS_SCHEMA

定义了一个允许任何元素上的任何属性的 schema。

Defines a schema that allows any property on any element.

NgIterable

A type describing supported iterable types.

PACKAGE_ROOT_URL

A token which indicates the root directory of the application

PLATFORM_ID

A token that indicates an opaque platform id.

PLATFORM_INITIALIZER

A function that will be executed when a platform is initialized.

Provider

Describes how the Injector should be configured.

StaticProvider

Describes how the Injector should be configured in a static way (Without reflection).

TRANSLATIONS

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.

TRANSLATIONS_FORMAT

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

getDebugNode
getModuleFactory

Returns the NgModuleFactory with the given id, if it exists and has been loaded. Factories for modules that do not specify an id cannot be retrieved. Throws if the module cannot be found.

platformCore

This platform has to be included in any other platform

wtfCreateScope

Create trace scope.

wtfEndTimeRange

Ends a async time range operation. [range] is the return value from [wtfStartTimeRange] Async ranges only work if WTF has been enabled.

wtfLeave

Used to mark end of Scope.

wtfStartTimeRange

Used to mark Async start. Async are similar to scope but they don't have to be strictly nested. The return value is used in the call to [endAsync]. Async ranges only work if WTF has been enabled.