UNPKG

1.39 kBTypeScriptView Raw
1/**
2 * # The state subsystem
3 *
4 * This subsystem implements the ui-router state tree
5 *
6 * - The [[StateService]] has state-related service methods such as:
7 * - [[StateService.get]]: Get a registered [[StateDeclaration]] object
8 * - [[StateService.go]]: Transition from the current state to a new state
9 * - [[StateService.reload]]: Reload the current state
10 * - [[StateService.target]]: Get a [[TargetState]] (useful when redirecting from a Transition Hook)
11 * - [[StateService.onInvalid]]: Register a callback for when a transition to an invalid state is started
12 * - [[StateService.defaultErrorHandler]]: Register a global callback for when a transition errors
13 * - The [[StateDeclaration]] interface defines the shape of a state declaration
14 * - The [[StateRegistry]] contains all the registered states
15 * - States can be added/removed using the [[StateRegistry.register]] and [[StateRegistry.deregister]]
16 * - Note: Bootstrap state registration differs by front-end framework.
17 * - Get notified of state registration/deregistration using [[StateRegistry.onStatesChanged]].
18 *
19 * @packageDocumentation
20 */
21export * from './interface';
22export * from './stateBuilder';
23export * from './stateObject';
24export * from './stateMatcher';
25export * from './stateQueueManager';
26export * from './stateRegistry';
27export * from './stateService';
28export * from './targetState';