cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(core): export the ...Decorator interfaces to ensure they are documented (#28836) (#28961)

Browse Source 
If an interface is not exported publicly from its package, then the doc-gen
does not see it, and so cannot include it in the generated documentation.

This was the case for a number of `...Decorator` interfaces, such as
`PipeDecorator` and `InputDecorator.

This commit adds these interfaces to the public export to fix this problem.

PR Close #28836

PR Close #28961
This commit is contained in:
Brandon 2019-02-19 19:52:21 +00:00 committed by Ben Lesh
parent d374787db6
commit 0977d95802
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/core/src/metadata.ts
View File

@ -17,7 +17,7 @@ import {DoBootstrap, ModuleWithProviders, NgModule, SchemaMetadata} from './meta
import {ViewEncapsulation} from './metadata/view'; import {ViewEncapsulation} from './metadata/view';
export {ANALYZE_FOR_ENTRY_COMPONENTS, Attribute, ContentChild, ContentChildDecorator, ContentChildren, ContentChildrenDecorator, Query, ViewChild, ViewChildDecorator, ViewChildren, ViewChildrenDecorator} from './metadata/di'; export {ANALYZE_FOR_ENTRY_COMPONENTS, Attribute, ContentChild, ContentChildDecorator, ContentChildren, ContentChildrenDecorator, Query, ViewChild, ViewChildDecorator, ViewChildren, ViewChildrenDecorator} from './metadata/di';
export {Component, ComponentDecorator, Directive, DirectiveDecorator, HostBinding, HostListener, Input, Output, Pipe} from './metadata/directives'; export {Component, ComponentDecorator, Directive, DirectiveDecorator, HostBinding, HostBindingDecorator, HostListener, HostListenerDecorator, Input, InputDecorator, Output, OutputDecorator, Pipe, PipeDecorator} from './metadata/directives';
export {AfterContentChecked, AfterContentInit, AfterViewChecked, AfterViewInit, DoCheck, OnChanges, OnDestroy, OnInit} from './metadata/lifecycle_hooks'; export {AfterContentChecked, AfterContentInit, AfterViewChecked, AfterViewInit, DoCheck, OnChanges, OnDestroy, OnInit} from './metadata/lifecycle_hooks';
export {CUSTOM_ELEMENTS_SCHEMA, DoBootstrap, ModuleWithProviders, NO_ERRORS_SCHEMA, NgModule, SchemaMetadata} from './metadata/ng_module'; export {CUSTOM_ELEMENTS_SCHEMA, DoBootstrap, ModuleWithProviders, NO_ERRORS_SCHEMA, NgModule, SchemaMetadata} from './metadata/ng_module';
export {ViewEncapsulation} from './metadata/view'; export {ViewEncapsulation} from './metadata/view';

25
tools/public_api_guard/core/core.d.ts vendored
View File

@ -354,6 +354,11 @@ export interface HostBinding {
export declare const HostBinding: HostBindingDecorator; export declare const HostBinding: HostBindingDecorator;
export interface HostBindingDecorator {
(hostPropertyName?: string): any;
new (hostPropertyName?: string): any;
}
export interface HostDecorator { export interface HostDecorator {
(): any; (): any;
new (): Host; new (): Host;
@ -366,6 +371,11 @@ export interface HostListener {
export declare const HostListener: HostListenerDecorator; export declare const HostListener: HostListenerDecorator;
export interface HostListenerDecorator {
(eventName: string, args?: string[]): any;
new (eventName: string, args?: string[]): any;
}
export declare function inject<T>(token: Type<T> | InjectionToken<T>): T; export declare function inject<T>(token: Type<T> | InjectionToken<T>): T;
export declare function inject<T>(token: Type<T> | InjectionToken<T>, flags?: InjectFlags): T | null; export declare function inject<T>(token: Type<T> | InjectionToken<T>, flags?: InjectFlags): T | null;
@ -447,6 +457,11 @@ export interface Input {
export declare const Input: InputDecorator; export declare const Input: InputDecorator;
export interface InputDecorator {
(bindingPropertyName?: string): any;
new (bindingPropertyName?: string): any;
}
export declare function isDevMode(): boolean; export declare function isDevMode(): boolean;
export interface IterableChangeRecord<V> { export interface IterableChangeRecord<V> {
@ -627,6 +642,11 @@ export interface Output {
export declare const Output: OutputDecorator; export declare const Output: OutputDecorator;
export interface OutputDecorator {
(bindingPropertyName?: string): any;
new (bindingPropertyName?: string): any;
}
export declare const PACKAGE_ROOT_URL: InjectionToken<string>; export declare const PACKAGE_ROOT_URL: InjectionToken<string>;
export interface Pipe { export interface Pipe {
@ -636,6 +656,11 @@ export interface Pipe {
export declare const Pipe: PipeDecorator; export declare const Pipe: PipeDecorator;
export interface PipeDecorator {
(obj: Pipe): TypeDecorator;
new (obj: Pipe): Pipe;
}
export interface PipeTransform { export interface PipeTransform {
transform(value: any, ...args: any[]): any; transform(value: any, ...args: any[]): any;
} }