ionic-framework/packages/ionic-angular/src/navigation/nav-params.ts

/**
 * @name NavParams
 * @description
 * NavParams are an object that exists on a page and can contain data for that particular view.
 * Similar to how data was pass to a view in V1 with `$stateParams`, NavParams offer a much more flexible
 * option with a simple `get` method.
 *
 * @usage
 *
 * ```ts
 * import { NavParams } from 'ionic-angular';
 *
 * export class MyClass {
 *   constructor(navParams: NavParams) {
 *     // userParams is an object we have in our nav-parameters
 *     const params = navParams.get('userParams');
 *   }
 * }
 * ```
 *
 * @demo /docs/demos/src/nav-params/
 * @see {@link /docs/components#navigation Navigation Component Docs}
 * @see {@link ../NavController/ NavController API Docs}
 * @see {@link /docs/api/components/nav/Nav/ Nav API Docs}
 * @see {@link /docs/api/components/nav/NavPush/ NavPush API Docs}
 */
export class NavParams {

  /**
   * @hidden
   * @param {TODO} data  TODO
   */
  constructor(public data: any = {}) {}

  /**
   * Get the value of a navigation parameter for the current view
   *
   * ```ts
   * import { NavParams } from 'ionic-angular';
   *
   * export class MyClass {
   *   constructor(public navParams: NavParams) {
   *     // userParams is an object we have in our navigation parameters
   *     this.navParams.get('userParams');
   *   }
   * }
   * ```
   *
   *
   * @param {string} param the parameter you want to get the value for
   */
  get(param: string): any {
    return this.data[param];
  }
}