@angular-wave/angular.ts 0.9.1 → 0.9.3

package/@types/router/transition/reject-factory.d.ts

@@ -0,0 +1,43 @@
+/**
+ * An object for Transition Rejection reasons.
+ */
+export type RejectType = number;
+export namespace RejectType {
+  let SUPERSEDED: number;
+  let ABORTED: number;
+  let INVALID: number;
+  let IGNORED: number;
+  let ERROR: number;
+}
+export class Rejection {
+  /** Returns a Rejection due to transition superseded */
+  static superseded(detail: any, options: any): Rejection;
+  /** Returns a Rejection due to redirected transition */
+  static redirected(detail: any): Rejection;
+  /** Returns a Rejection due to invalid transition */
+  static invalid(detail: any): Rejection;
+  /** Returns a Rejection due to ignored transition */
+  static ignored(detail: any): Rejection;
+  /** Returns a Rejection due to aborted transition */
+  static aborted(detail: any): Rejection;
+  /** Returns a Rejection due to aborted transition */
+  static errored(detail: any): Rejection;
+  /**
+   * Returns a Rejection
+   *
+   * Normalizes a value as a Rejection.
+   * If the value is already a Rejection, returns it.
+   * Otherwise, wraps and returns the value as a Rejection (Rejection type: ERROR).
+   *
+   * @returns `detail` if it is already a `Rejection`, else returns an ERROR Rejection.
+   */
+  static normalize(detail: any): any;
+  constructor(type: any, message: any, detail: any);
+  $id: number;
+  type: any;
+  message: any;
+  detail: any;
+  redirected: boolean;
+  toString(): string;
+  toPromise(): any;
+}

package/@types/router/transition/transition-event-type.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This class defines a type of hook, such as `onBefore` or `onEnter`.
+ * Plugins can define custom hook types, such as sticky states does for `onInactive`.
+ */
+export class TransitionEventType {
+  constructor(
+    name: any,
+    hookPhase: any,
+    hookOrder: any,
+    criteriaMatchPath: any,
+    reverseSort?: boolean,
+    getResultHandler?: (hook: any) => (result: any) => any,
+    getErrorHandler?: () => (error: any) => any,
+    synchronous?: boolean,
+  );
+  name: any;
+  hookPhase: any;
+  hookOrder: any;
+  criteriaMatchPath: any;
+  reverseSort: boolean;
+  getResultHandler: (hook: any) => (result: any) => any;
+  getErrorHandler: () => (error: any) => any;
+  synchronous: boolean;
+}

package/@types/router/transition/transition-hook.d.ts

@@ -0,0 +1,86 @@
+export class TransitionHook {
+  /**
+   * Chains together an array of TransitionHooks.
+   *
+   * Given a list of [[TransitionHook]] objects, chains them together.
+   * Each hook is invoked after the previous one completes.
+   *
+   * #### Example:
+   * ```js
+   * var hooks: TransitionHook[] = getHooks();
+   * let promise: Promise<any> = TransitionHook.chain(hooks);
+   *
+   * promise.then(handleSuccess, handleError);
+   * ```
+   *
+   * @param hooks the list of hooks to chain together
+   * @param waitFor if provided, the chain is `.then()`'ed off this promise
+   * @returns a `Promise` for sequentially invoking the hooks (in order)
+   */
+  static chain(hooks: any, waitFor: any): any;
+  /**
+   * Invokes all the provided TransitionHooks, in order.
+   * Each hook's return value is checked.
+   * If any hook returns a promise, then the rest of the hooks are chained off that promise, and the promise is returned.
+   * If no hook returns a promise, then all hooks are processed synchronously.
+   *
+   * @param hooks the list of TransitionHooks to invoke
+   * @param doneCallback a callback that is invoked after all the hooks have successfully completed
+   *
+   * @returns a promise for the async result, or the result of the callback
+   */
+  static invokeHooks(hooks: any, doneCallback: any): any;
+  /**
+   * Run all TransitionHooks, ignoring their return value.
+   */
+  static runAllHooks(hooks: any): void;
+  constructor(
+    transition: any,
+    stateContext: any,
+    registeredHook: any,
+    options: any,
+  );
+  transition: any;
+  stateContext: any;
+  registeredHook: any;
+  options: any;
+  isSuperseded: () => boolean;
+  type: any;
+  logError(err: any): void;
+  invokeHook(): any;
+  /**
+   * This method handles the return value of a Transition Hook.
+   *
+   * A hook can return false (cancel), a TargetState (redirect),
+   * or a promise (which may later resolve to false or a redirect)
+   *
+   * This also handles "transition superseded" -- when a new transition
+   * was started while the hook was still running
+   */
+  handleHookResult(result: any): any;
+  /**
+   * Return a Rejection promise if the transition is no longer current due
+   * a new transition has started and superseded this one.
+   */
+  getNotCurrentRejection(): any;
+  toString(): string;
+}
+export namespace TransitionHook {
+  /**
+   * These GetResultHandler(s) are used by [[invokeHook]] below
+   * Each HookType chooses a GetResultHandler (See: [[TransitionService._defineCoreEvents]])
+   */
+  function HANDLE_RESULT(hook: any): (result: any) => any;
+  /**
+   * If the result is a promise rejection, log it.
+   * Otherwise, ignore the result.
+   */
+  function LOG_REJECTED_RESULT(hook: any): (result: any) => any;
+  /**
+   * These GetErrorHandler(s) are used by [[invokeHook]] below
+   * Each HookType chooses a GetErrorHandler (See: [[TransitionService._defineCoreEvents]])
+   */
+  function LOG_ERROR(hook: any): (error: any) => any;
+  function REJECT_ERROR(): (error: any) => any;
+  function THROW_ERROR(): (error: any) => never;
+}

package/@types/router/transition/transition-service.d.ts

@@ -0,0 +1,116 @@
+export namespace defaultTransOpts {
+  let location: boolean;
+  let relative: any;
+  let inherit: boolean;
+  let notify: boolean;
+  let reload: boolean;
+  let supercede: boolean;
+  let custom: {};
+  function current(): any;
+  let source: string;
+}
+/**
+ * This class provides services related to Transitions.
+ *
+ * - Most importantly, it allows global Transition Hooks to be registered.
+ * - It allows the default transition error handler to be set.
+ * - It also has a factory function for creating new [[Transition]] objects, (used internally by the [[StateService]]).
+ *
+ * At bootstrap, [[UIRouter]] creates a single instance (singleton) of this class.
+ *
+ * This API is located at `router.transitionService` ([[UIRouter.transitionService]])
+ */
+export class TransitionProvider {
+  static $inject: string[];
+  /**
+   * @param {import('../router.js').Router} globals
+   * @param viewService
+   */
+  constructor(globals: import("../router.js").Router, viewService: any);
+  _transitionCount: number;
+  /** The transition hook types, such as `onEnter`, `onStart`, etc */
+  _eventTypes: any[];
+  /** @internal The registered transition hooks */
+  _registeredHooks: {};
+  /** The  paths on a criteria object */
+  _criteriaPaths: {};
+  globals: import("../router.js").Router;
+  $view: any;
+  _deregisterHookFns: {};
+  _pluginapi: any;
+  $get: (
+    | string
+    | ((
+        stateService: any,
+        urlService: any,
+        stateRegistry: any,
+        viewService: any,
+      ) => this)
+  )[];
+  /**
+   * Registers a [[TransitionHookFn]], called *while a transition is being constructed*.
+   *
+   * Registers a transition lifecycle hook, which is invoked during transition construction.
+   *
+   * This low level hook should only be used by plugins.
+   * This can be a useful time for plugins to add resolves or mutate the transition as needed.
+   * The Sticky States plugin uses this hook to modify the treechanges.
+   *
+   * ### Lifecycle
+   *
+   * `onCreate` hooks are invoked *while a transition is being constructed*.
+   *
+   * ### Return value
+   *
+   * The hook's return value is ignored
+   *
+   * @internal
+   * @param criteria defines which Transitions the Hook should be invoked for.
+   * @param callback the hook function which will be invoked.
+   * @param options the registration options
+   * @returns a function which deregisters the hook.
+   */
+  /**
+   * Creates a new [[Transition]] object
+   *
+   * This is a factory function for creating new Transition objects.
+   * It is used internally by the [[StateService]] and should generally not be called by application code.
+   *
+   * @internal
+   * @param fromPath the path to the current state (the from state)
+   * @param targetState the target state (destination)
+   * @returns a Transition
+   */
+  create(fromPath: any, targetState: any): Transition;
+  _defineCoreEvents(): void;
+  _defineCorePaths(): void;
+  _defineEvent(
+    name: any,
+    hookPhase: any,
+    hookOrder: any,
+    criteriaMatchPath: any,
+    reverseSort?: boolean,
+    getResultHandler?: (hook: any) => (result: any) => any,
+    getErrorHandler?: () => (error: any) => any,
+    synchronous?: boolean,
+  ): void;
+  _getEvents(phase: any): any[];
+  /**
+   * Adds a Path to be used as a criterion against a TreeChanges path
+   *
+   * For example: the `exiting` path in [[HookMatchCriteria]] is a STATE scoped path.
+   * It was defined by calling `defineTreeChangesCriterion('exiting', TransitionHookScope.STATE)`
+   * Each state in the exiting path is checked against the criteria and returned as part of the match.
+   *
+   * Another example: the `to` path in [[HookMatchCriteria]] is a TRANSITION scoped path.
+   * It was defined by calling `defineTreeChangesCriterion('to', TransitionHookScope.TRANSITION)`
+   * Only the tail of the `to` path is checked against the criteria and returned as part of the match.
+   *
+   * @internal
+   */
+  _definePathType(name: any, hookScope: any): void;
+  _getPathTypes(): {};
+  getHooks(hookName: any): any;
+  _registerCoreTransitionHooks(): void;
+}
+import { Transition } from "./transition.js";

package/@types/router/transition/transition.d.ts

@@ -0,0 +1,331 @@
+/** @typedef {import('./interface.ts').IHookRegistry} IHookRegistry */
+/**
+ * Represents a transition between two states.
+ *
+ * When navigating to a state, we are transitioning **from** the current state **to** the new state.
+ *
+ * This object contains all contextual information about the to/from states, parameters, resolves.
+ * It has information about all states being entered and exited as a result of the transition.
+ * @implements {IHookRegistry}
+ */
+export class Transition implements IHookRegistry {
+  /**
+   * Creates a new Transition object.
+   *
+   * If the target state is not valid, an error is thrown.
+   *
+   * @param {Array<import('../path/path-node.js').PathNode>} fromPath The path of [[PathNode]]s from which the transition is leaving.  The last node in the `fromPath`
+   *        encapsulates the "from state".
+   * @param {import('../state/target-state.js').TargetState} targetState The target state and parameters being transitioned to (also, the transition options)
+   * @param {import('../transition/transition-service.js').TransitionProvider} transitionService The [[TransitionService]] instance
+   * @param {import('../router.js').Router} globals
+   */
+  constructor(
+    fromPath: Array<import("../path/path-node.js").PathNode>,
+    targetState: import("../state/target-state.js").TargetState,
+    transitionService: import("../transition/transition-service.js").TransitionProvider,
+    globals: import("../router.js").Router,
+  );
+  /**
+   * @type {import('../router.js').Router}
+   */
+  globals: import("../router.js").Router;
+  transitionService: import("../transition/transition-service.js").TransitionProvider;
+  _deferred: any;
+  /**
+   * This promise is resolved or rejected based on the outcome of the Transition.
+   *
+   * When the transition is successful, the promise is resolved
+   * When the transition is unsuccessful, the promise is rejected with the [[Rejection]] or javascript error
+   */
+  promise: any;
+  /** @internal Holds the hook registration functions such as those passed to Transition.onStart() */
+  _registeredHooks: {};
+  _hookBuilder: HookBuilder;
+  /** Checks if this transition is currently active/running. */
+  isActive: () => boolean;
+  _targetState: import("../state/target-state.js").TargetState;
+  _options: any;
+  $id: number;
+  _treeChanges: import("./interface.js").TreeChanges;
+  onStart: any;
+  onBefore: any;
+  onSuccess: any;
+  onEnter: any;
+  onRetain: any;
+  onExit: any;
+  onFinish: any;
+  onError: any;
+  /**
+   * Creates the transition-level hook registration functions
+   * (which can then be used to register hooks)
+   */
+  createTransitionHookRegFns(): void;
+  getHooks(hookName: any): any;
+  applyViewConfigs(): void;
+  /**
+   * @returns {import('../state/state-object.js').StateObject} the internal from [State] object
+   */
+  $from(): import("../state/state-object.js").StateObject;
+  /**
+   * @returns {import('../state/state-object.js').StateObject} the internal to [State] object
+   */
+  $to(): import("../state/state-object.js").StateObject;
+  /**
+   * Returns the "from state"
+   *
+   * Returns the state that the transition is coming *from*.
+   *
+   * @returns The state declaration object for the Transition's ("from state").
+   */
+  from(): import("../state/interface.ts").StateDeclaration;
+  /**
+   * Returns the "to state"
+   *
+   * Returns the state that the transition is going *to*.
+   *
+   * @returns The state declaration object for the Transition's target state ("to state").
+   */
+  to(): import("../state/interface.ts").StateDeclaration;
+  /**
+   * Gets the Target State
+   *
+   * A transition's [[TargetState]] encapsulates the [[to]] state, the [[params]], and the [[options]] as a single object.
+   *
+   * @returns the [[TargetState]] of this Transition
+   */
+  targetState(): import("../state/target-state.js").TargetState;
+  /**
+   * Determines whether two transitions are equivalent.
+   * @deprecated
+   */
+  is(compare: any): any;
+  params(pathname?: string): any;
+  /**
+   * Gets all available resolve tokens (keys)
+   *
+   * This method can be used in conjunction with [[injector]] to inspect the resolve values
+   * available to the Transition.
+   *
+   * This returns all the tokens defined on [[StateDeclaration.resolve]] blocks, for the states
+   * in the Transition's [[TreeChanges.to]] path.
+   *
+   * #### Example:
+   * This example logs all resolve values
+   * ```js
+   * let tokens = trans.getResolveTokens();
+   * tokens.forEach(token => console.log(token + " = " + trans.injector().get(token)));
+   * ```
+   *
+   * #### Example:
+   * This example creates promises for each resolve value.
+   * This triggers fetches of resolves (if any have not yet been fetched).
+   * When all promises have all settled, it logs the resolve values.
+   * ```js
+   * let tokens = trans.getResolveTokens();
+   * let promise = tokens.map(token => trans.injector().getAsync(token));
+   * Promise.all(promises).then(values => console.log("Resolved values: " + values));
+   * ```
+   *
+   * Note: Angular 1 users whould use `$q.all()`
+   *
+   * @param pathname resolve context's path name (e.g., `to` or `from`)
+   *
+   * @returns an array of resolve tokens (keys)
+   */
+  getResolveTokens(pathname?: string): any;
+  /**
+   * Dynamically adds a new [[Resolvable]] (i.e., [[StateDeclaration.resolve]]) to this transition.
+   *
+   * Allows a transition hook to dynamically add a Resolvable to this Transition.
+   *
+   * Use the [[Transition.injector]] to retrieve the resolved data in subsequent hooks ([[UIInjector.get]]).
+   *
+   * If a `state` argument is provided, the Resolvable is processed when that state is being entered.
+   * If no `state` is provided then the root state is used.
+   * If the given `state` has already been entered, the Resolvable is processed when any child state is entered.
+   * If no child states will be entered, the Resolvable is processed during the `onFinish` phase of the Transition.
+   *
+   * The `state` argument also scopes the resolved data.
+   * The resolved data is available from the injector for that `state` and any children states.
+   *
+   * #### Example:
+   * ```js
+   * transitionService.onBefore({}, transition => {
+   *   transition.addResolvable({
+   *     token: 'myResolve',
+   *     deps: ['MyService'],
+   *     resolveFn: myService => myService.getData()
+   *   });
+   * });
+   * ```
+   *
+   * @param resolvable a [[ResolvableLiteral]] object (or a [[Resolvable]])
+   * @param state the state in the "to path" which should receive the new resolve (otherwise, the root state)
+   */
+  addResolvable(resolvable: any, state: any): void;
+  /**
+   * Gets the transition from which this transition was redirected.
+   *
+   * If the current transition is a redirect, this method returns the transition that was redirected.
+   *
+   * #### Example:
+   * ```js
+   * let transitionA = $state.go('A').transition
+   * transitionA.onStart({}, () => $state.target('B'));
+   * $transitions.onSuccess({ to: 'B' }, (trans) => {
+   *   trans.to().name === 'B'; // true
+   *   trans.redirectedFrom() === transitionA; // true
+   * });
+   * ```
+   *
+   * @returns The previous Transition, or null if this Transition is not the result of a redirection
+   */
+  redirectedFrom(): any;
+  /**
+   * Gets the original transition in a redirect chain
+   *
+   * A transition might belong to a long chain of multiple redirects.
+   * This method walks the [[redirectedFrom]] chain back to the original (first) transition in the chain.
+   *
+   * #### Example:
+   * ```js
+   * // states
+   * registry.register({ name: 'A', redirectTo: 'B' });
+   * registry.register({ name: 'B', redirectTo: 'C' });
+   * registry.register({ name: 'C', redirectTo: 'D' });
+   * registry.register({ name: 'D' });
+   *
+   * let transitionA = $state.go('A').transition
+   *
+   * $transitions.onSuccess({ to: 'D' }, (trans) => {
+   *   trans.to().name === 'D'; // true
+   *   trans.redirectedFrom().to().name === 'C'; // true
+   *   trans.originalTransition() === transitionA; // true
+   *   trans.originalTransition().to().name === 'A'; // true
+   * });
+   * ```
+   *
+   * @returns The original Transition that started a redirect chain
+   */
+  originalTransition(): any;
+  /**
+   * Get the transition options
+   *
+   * @returns the options for this Transition.
+   */
+  options(): any;
+  /**
+   * Gets the states being entered.
+   *
+   * @returns an array of states that will be entered during this transition.
+   */
+  entering(): any;
+  /**
+   * Gets the states being exited.
+   *
+   * @returns an array of states that will be exited during this transition.
+   */
+  exiting(): any;
+  /**
+   * Gets the states being retained.
+   *
+   * @returns an array of states that are already entered from a previous Transition, that will not be
+   *    exited during this Transition
+   */
+  retained(): any;
+  /**
+   * Get the [[ViewConfig]]s associated with this Transition
+   *
+   * Each state can define one or more views (template/controller), which are encapsulated as `ViewConfig` objects.
+   * This method fetches the `ViewConfigs` for a given path in the Transition (e.g., "to" or "entering").
+   *
+   * @param pathname the name of the path to fetch views for:
+   *   (`'to'`, `'from'`, `'entering'`, `'exiting'`, `'retained'`)
+   * @param state If provided, only returns the `ViewConfig`s for a single state in the path
+   *
+   * @returns a list of ViewConfig objects for the given path.
+   */
+  views(pathname: string, state: any): any;
+  treeChanges(
+    pathname: any,
+  ):
+    | import("../path/path-node.js").PathNode[]
+    | import("./interface.js").TreeChanges;
+  /**
+   * Creates a new transition that is a redirection of the current one.
+   *
+   * This transition can be returned from a [[TransitionService]] hook to
+   * redirect a transition to a new state and/or set of parameters.
+   *
+   * @internal
+   *
+   * @returns Returns a new [[Transition]] instance.
+   */
+  redirect(targetState: any): Transition;
+  /** @internal If a transition doesn't exit/enter any states, returns any [[Param]] whose value changed */
+  _changedParams(): any;
+  /**
+   * Returns true if the transition is dynamic.
+   *
+   * A transition is dynamic if no states are entered nor exited, but at least one dynamic parameter has changed.
+   *
+   * @returns true if the Transition is dynamic
+   */
+  dynamic(): any;
+  /**
+   * Returns true if the transition is ignored.
+   *
+   * A transition is ignored if no states are entered nor exited, and no parameter values have changed.
+   *
+   * @returns true if the Transition is ignored.
+   */
+  ignored(): boolean;
+  _ignoredReason(): "SameAsCurrent" | "SameAsPending";
+  /**
+   * Runs the transition
+   *
+   * This method is generally called from the [[StateService.transitionTo]]
+   *
+   * @internal
+   *
+   * @returns a promise for a successful transition.
+   */
+  run(): any;
+  success: boolean;
+  _error: any;
+  /**
+   * Checks if the Transition is valid
+   *
+   * @returns true if the Transition is valid
+   */
+  valid(): boolean;
+  /**
+   * Aborts this transition
+   *
+   * Imperative API to abort a Transition.
+   * This only applies to Transitions that are not yet complete.
+   */
+  abort(): void;
+  _aborted: boolean;
+  /**
+   * The Transition error reason.
+   *
+   * If the transition is invalid (and could not be run), returns the reason the transition is invalid.
+   * If the transition was valid and ran, but was not successful, returns the reason the transition failed.
+   *
+   * @returns a transition rejection explaining why the transition is invalid, or the reason the transition failed.
+   */
+  error(): any;
+  /**
+   * A string representation of the Transition
+   *
+   * @returns A string representation of the Transition
+   */
+  toString(): string;
+}
+export namespace Transition {
+  export { Transition as diToken };
+}
+export type IHookRegistry = import("./interface.ts").IHookRegistry;
+import { HookBuilder } from "./hook-builder.js";

package/@types/router/url/url-config.d.ts

@@ -0,0 +1,99 @@
+/**
+ * An API to customize the URL behavior and retrieve URL configuration
+ *
+ * This API is used to customize the behavior of the URL.
+ * This includes optional trailing slashes ([[strictMode]]), case sensitivity ([[caseInsensitive]]),
+ * and custom parameter encoding (custom [[type]]).
+ *
+ * It also has information about the location (url) configuration such as [[port]] and [[baseHref]].
+ * This information can be used to build absolute URLs, such as
+ * `https://example.com:443/basepath/state/substate?param1=a#hashvalue`;
+ *
+ * This API is found at `router.urlService.config` (see: [[UIRouter.urlService]], [[URLService.config]])
+ */
+export class UrlConfigProvider {
+  /** @type {ParamTypes} */
+  paramTypes: ParamTypes;
+  /** @type {boolean} */
+  _isCaseInsensitive: boolean;
+  /** @type {boolean} */
+  _isStrictMode: boolean;
+  /** @type {boolean} */
+  _defaultSquashPolicy: boolean;
+  $get: (() => any)[];
+  /**
+   * Defines whether URL matching should be case sensitive (the default behavior), or not.
+   *
+   * #### Example:
+   * ```js
+   * // Allow case insensitive url matches
+   * urlService.config.caseInsensitive(true);
+   * ```
+   *
+   * @param value `false` to match URL in a case sensitive manner; otherwise `true`;
+   * @returns the current value of caseInsensitive
+   */
+  caseInsensitive(value: any): any;
+  /**
+   * Sets the default behavior when generating or matching URLs with default parameter values.
+   *
+   * #### Example:
+   * ```js
+   * // Remove default parameter values from the url
+   * urlService.config.defaultSquashPolicy(true);
+   * ```
+   *
+   * @param value A string that defines the default parameter URL squashing behavior.
+   *    - `nosquash`: When generating an href with a default parameter value, do not squash the parameter value from the URL
+   *    - `slash`: When generating an href with a default parameter value, squash (remove) the parameter value, and, if the
+   *      parameter is surrounded by slashes, squash (remove) one slash from the URL
+   *    - any other string, e.g. "~": When generating an href with a default parameter value, squash (remove)
+   *      the parameter value from the URL and replace it with this string.
+   * @returns the current value of defaultSquashPolicy
+   */
+  defaultSquashPolicy(value: any): any;
+  /**
+   * Defines whether URLs should match trailing slashes, or not (the default behavior).
+   *
+   * #### Example:
+   * ```js
+   * // Allow optional trailing slashes
+   * urlService.config.strictMode(false);
+   * ```
+   *
+   * @param value `false` to match trailing slashes in URLs, otherwise `true`.
+   * @returns the current value of strictMode
+   */
+  strictMode(value: any): any;
+  /**
+   * Creates and registers a custom [[ParamType]] object
+   *
+   * A custom parameter type can be used to generate URLs with typed parameters or custom encoding/decoding.
+   *
+   * #### Note: Register custom types *before using them* in a state definition.
+   *
+   * #### Example:
+   * ```js
+   * // Encode object parameter as JSON string
+   * urlService.config.type('myjson', {
+   *   encode: (obj) => JSON.stringify(obj),
+   *   decode: (str) => JSON.parse(str),
+   *   is: (val) => typeof(val) === 'object',
+   *   pattern: /[^/]+/,
+   *   equals: (a, b) => _.isEqual(a, b),
+   * });
+   * ```
+   *
+   * See [[ParamTypeDefinition]] for more examples
+   *
+   * @param name The type name.
+   * @param definition The type definition. See [[ParamTypeDefinition]] for information on the values accepted.
+   * @param definitionFn A function that is injected before the app runtime starts.
+   *        The result of this function should be a [[ParamTypeDefinition]].
+   *        The result is merged into the existing `definition`.
+   *        See [[ParamType]] for information on the values accepted.
+   *
+   * @returns if only the `name` parameter was specified: the currently registered [[ParamType]] object, or undefined
+   */
+  type(name: any, definition: any, definitionFn: any): any;
+}