This is the multi-page printable view of this section. Click here to print.
Reference pages answer exact API questions. If you are learning a concept, start with Get Started or a task guide.
| Need | Reference |
|---|---|
| HTML behavior | Directive reference |
| Injected runtime behavior | Service reference |
| Display transformations | Filters |
| Injected browser objects | Values |
| Navigation | Routing |
| Motion | Animations |
| TypeScript contracts | Generated TypeDoc |
Read how to use reference if tokens, signatures, lifecycle notes, or TypeDoc notation are unfamiliar.
Use documentation by intent:
Plural sections such as Directives and Services teach workflows. Singular sections such as Directive and Service are feature reference.
An ng-* HTML name is usually a directive. A name injected into a function is a
service or value token. A capitalized TypeScript name is a generated type.
value?: string means the property is optional and, when supplied, must be a
string. string | null means either value is accepted. () => void means a
function takes no arguments and returns no useful value. Array<T> means an
array whose items have type T.
Before using an API, determine when it is created, when callbacks run, and who releases listeners or resources. Component, directive, scope, route, and application lifetimes are different.
Use exported package members, documented injection tokens, and generated TypeDoc pages. Names marked internal, generated DOM details, and implementation files are not application contracts.
Once you find the exact signature, use the linked task or concept page to see the API in an application workflow.
Check that the bootstrapped module name matches the registered module, the root
exists, and AngularTS is loaded once. Do not bootstrap on ng-if, ng-include,
or ng-view.
Confirm the provider is registered before use, its module is in the dependency graph, and the token spelling is correct. Regenerate language bindings after changing the public namespace.
Read the value through a reactive binding. In typed views, use a reader such as
() => controller.value. In keyed collections, call the item reader.
Use stable domain keys. Do not key mutable records by array position when insertion, removal, or sorting is possible.
Confirm an ng-view outlet exists, the state names a registered component or
template, and parent/child names match the declaration.
Review the boundary instead of disabling security. Identify the source, expected sink, and smallest safe trust policy.
Run the integration’s generation command and aggregate integration validation. Never hand-edit generated bindings, externs, or parity artifacts.
Detect optional APIs before constructing a service. Select a fallback and show an actionable unsupported state when none exists.
Continue with Troubleshooting.
Every shipped directive module, service module, filter module, public injection token, and built-in configuration key must map to documentation.
A mapping is either:
The mapping is stored in docs/public-feature-docs.json. CI discovers the
source surface and fails when a module or public token changes without updated
documentation ownership.
Utility, worker, WebAssembly, and transport helpers are documented at their user-facing boundary rather than by internal source file. Generated TypeScript API pages remain the authoritative signature reference; guides explain when and why to use those signatures.