An abstract class that an Angular component class can extend to automatically handle defining lifecycle event methods for the AoT compiler, as well as allowing dynamic template checking with AoT.
abstract class AotAware extends AotDynamic() {
public ngOnChanges();
public ngOnInit();
public ngOnDestroy();
public ngDoCheck();
public ngAfterContentInit();
public ngAfterContentChecked();
public ngAfterViewInit();
public ngAfterViewChecked();
}Creates an event source, which is an Observable that automatically emits when the given function (eventType) is called.
function EventSource(): EventSourceDecorator
function EventSource(...methodDecorators: MethodDecorator[]): EventSourceDecorator
function EventSource(options: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): EventSourceDecoratoroptions - The options to use for this event source. See EventSource.DecoratorOptions.
methodDecorators - A list of MethodDecorators that should be applied to the underlying event function.
Note: If the target property's name is of the format "<eventType>$", options.eventType can be omitted and automatically deduced from the property name.
interface DecoratorOptions {
eventType?: EventType;
skipMethodCheck?: boolean;
unmanaged?: boolean;
}eventType - (Optional) The name of the function that represents the event or action. If not specified, the name will try to be deduced from the name of the property being decorated instead.
skipMethodCheck - (Optional) Whether or not to ignore existing method declarations in the class when defining the EventSource. If set to false, an error will be thrown if a method is defined with the same name as the eventType. Defaults to false.
unmanaged - (Optional) Whether or not the EventSource should be excluded from automatic subscription cleanup when component is destroyed. Defaults to false.
EventType represents the name of the function being proxied.
type EventType = string;Creates a state emitter, which is a Subject that automatically emits when the underlying property value is modified, and automatically updates the property value when the Subject emits.
function StateEmitter(): StateEmitterDecorator
function StateEmitter(...propertyDecorators: PropertyDecorator[]): StateEmitterDecorator
function StateEmitter(params: StateEmitter.DecoratorParams, ...propertyDecorators: PropertyDecorator[]): StateEmitterDecoratorparams - The parameters to use for this state emitter. See StateEmitter.DecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: If the target property's name is of the format "<emitterType>$", params.propertyName can be omitted and automatically deduced from the property name.
interface DecoratorParams {
propertyName?: EmitterType;
initialValue?: any;
readOnly?: boolean;
writeOnly?: boolean;
unmanaged?: boolean;
proxyMode?: ProxyMode;
proxyPath?: string;
proxyMergeUpdates?: boolean;
}propertyName - (Optional) The name of the underlying property that should be created for use by the component's template. If not specified, the name will try to be deduced from the name of the property being decorated instead.
initialValue - (Optional) The initial value to be emitted. Defaults to undefined.
readOnly - (Optional) Whether or not the underlying property being created should be read-only. Defaults to false.
writeOnly - (Optional) Whether or not the underlying property being created should be write-only. If set to true and the component/directive is using AutoPush, special care will be taken to ensure change detection is invoked even if the StateEmitter is never used in the template/binding (i.e. in a directive). Defaults to false.
unmanaged - (Optional) Whether or not the StateEmitter should be excluded from automatic subscription cleanup when component is destroyed. Defaults to false. Note: This property has no effect when proxyMode is set to Alias.
proxyMode - (Optional) The proxy mode to use for the StateEmitter. Defaults to None. For all possible values, see StateEmitter.ProxyMode.
proxyPath - (Conditional) The path of the property to be proxied. Required if proxyMode is not set to None.
proxyMergeUpdates - (Optional) Whether or not newly emitted values via dynamic proxy property paths should be merged with the previously emitted value. Defaults to true if the emitted value is an instance of Object, otherwise defaults to false.
type EmitterType = string;type ProxyMode = keyof {
None,
From,
Alias,
Merge
}Helper decorator that creates a StateEmitter with proxyMode set to Alias.
function Alias(params: ProxyDecoratorParams | string, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - The parameters to use for this state emitter, or a string that is shorthand for passing the path parameter. See StateEmitter.ProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({proxyMode: EmitterMetadata.ProxyMode.Alias});Helper decorator that creates a StateEmitter with proxyMode set to From.
function From(params: ProxyDecoratorParams | string, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - The parameters to use for this state emitter, or a string that is shorthand for passing the path parameter. See StateEmitter.ProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({proxyMode: EmitterMetadata.ProxyMode.From});Helper decorator that creates a StateEmitter with proxyMode set to Merge.
function Merge(params: ProxyDecoratorParams | string, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - The parameters to use for this state emitter, or a string that is shorthand for passing the path parameter. See StateEmitter.ProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({proxyMode: EmitterMetadata.ProxyMode.Merge});interface ProxyDecoratorParams {
path: string;
propertyName?: EmitterType;
mergeUpdates?: boolean;
readOnly?: boolean;
writeOnly?: boolean;
unmanaged?: boolean;
}path - See StateEmitter.DecoratorParams.proxyPath.
propertyName - (Optional) See StateEmitter.DecoratorParams.propertyName.
mergeUpdates - (Optional) See StateEmitter.DecoratorParams.proxyMergeUpdates.
readOnly - (Optional) See StateEmitter.DecoratorParams.readOnly.
writeOnly - (Optional) See StateEmitter.DecoratorParams.writeOnly.
unmanaged - (Optional) See StateEmitter.DecoratorParams.unmanaged.
Helper decorator that creates a self-proxying StateEmitter with proxyMode set to Alias.
function AliasSelf(params?: SelfProxyDecoratorParams, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - (Optional) The parameters to use for this state emitter. See StateEmitter.SelfProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({
proxyMode: EmitterMetadata.ProxyMode.Alias,
proxyPath: "foo$"
})
public foo$: Subject<any>;Helper decorator that creates a self-proxying StateEmitter with proxyMode set to From.
function FromSelf(params?: SelfProxyDecoratorParams, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - (Optional) The parameters to use for this state emitter. See StateEmitter.SelfProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({
proxyMode: EmitterMetadata.ProxyMode.From,
proxyPath: "foo$"
})
public foo$: Subject<any>;Helper decorator that creates a self-proxying StateEmitter with proxyMode set to Merge.
function MergeSelf(params?: SelfProxyDecoratorParams, ...propertyDecorators: PropertyDecorator[]): PropertyDecoratorparams - (Optional) The parameters to use for this state emitter. See StateEmitter.SelfProxyDecoratorParams.
propertyDecorators - A list of PropertyDecorators that should be applied to the underlying property.
Note: This is functionally equivalent to:
StateEmitter({
proxyMode: EmitterMetadata.ProxyMode.Merge,
proxyPath: "foo$"
})
public foo$: Subject<any>;interface SelfProxyDecoratorParams {
propertyName?: EmitterType;
readOnly?: boolean;
writeOnly?: boolean;
unmanaged?: boolean;
}propertyName - (Optional) See StateEmitter.DecoratorParams.propertyName.
readOnly - (Optional) See StateEmitter.DecoratorParams.readOnly.
writeOnly - (Optional) See StateEmitter.DecoratorParams.writeOnly.
unmanaged - (Optional) See StateEmitter.DecoratorParams.unmanaged.
AutoPush enables automatic change detection management of StateEmitters for performant OnPush components and directives. Any change to a StateEmitter value will invoke detection on the component automatically, eliminating the need to ever manually invoke change detection in special cases.
function AutoPush(options?: AutoPush.CdRefOptions): ClassDecoratorClass decorator that enables AutoPush for a component or directive.
options - The change detection options to use for this component. See AutoPush.CdRefOptions.
Note: When using Angular's AoT compiler, you must also inject a change detector reference in the component's constructor. See this section for more info.
function enable(component: any, changeDetector: ChangeDetectorLike, options?: CdRefOptions) {
Metadata.SetMetadata(CHANGE_DETECTOR_REF, component, changeDetector);
}function enable(component: any, changeDetector: ChangeDetectorProxy, options?: Options) {
Metadata.SetMetadata(CHANGE_DETECTOR_REF, component, changeDetector);
}Enables AutoPush for a specfic instance of a component or directive using the given change detector reference or proxy.
component - The component or directive instance to enable AutoPush for.
changeDetector - The change detector reference or ChangeDetectorProxy to use to invoke change detection.
options - The change detection options to use for this instance. See AutoPush.CdRefOptions.
interface Options {}interface CdRefOptions extends Options {
forceDetectChanges?: boolean;
}forceDetectChanges - By default, ChangeDetectorRef.markforCheck will be called when StateEmitter properties are changed. When this is enabled, ChangeDetectorRef.detectChanges will be called instead.
interface ChangeDetectorProxy {
doCheck(): void;
}Interface that represents logic to be invoked as change detection.
doCheck - Function that will be invoked when a component's StateEmitter properties are changed.
function OnChanges(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function OnInit(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function OnDestroy(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function DoCheck(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function AfterContentInit(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function AfterContentChecked(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function AfterViewInit(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.
function AfterViewChecked(options?: EventSource.DecoratorOptions, ...methodDecorators: MethodDecorator[]): PropertyDecoratorSee EventSource.