ember-source/types/stable/@ember/routing/none-location.d.ts

A JavaScript framework for creating ambitious web applications

declare module '@ember/routing/none-location' {
  import EmberObject from '@ember/object';
  import type { default as EmberLocation, UpdateCallback } from '@ember/routing/location';
  /**
    @module @ember/routing/none-location
    */
  /**
      NoneLocation does not interact with the browser. It is useful for
      testing, or when you need to manage state with your Router, but temporarily
      don't want it to muck with the URL (for example when you embed your
      application in a larger page).

      Using `NoneLocation` causes Ember to not store the applications URL state
      in the actual URL. This is generally used for testing purposes, and is one
      of the changes made when calling `App.setupForTesting()`.

      @class NoneLocation
      @extends EmberObject
      @protected
    */
  export default class NoneLocation extends EmberObject implements EmberLocation {
    updateCallback?: UpdateCallback;
    path: string;
    /**
          Will be pre-pended to path.
      
          @private
          @property rootURL
          @default '/'
        */
    rootURL: string;
    initState(): void;
    /**
          Returns the current path without `rootURL`.
      
          @private
          @method getURL
          @return {String} path
        */
    getURL(): string;
    /**
          Set the path and remembers what was set. Using this method
          to change the path will not invoke the `updateURL` callback.
      
          @private
          @method setURL
          @param path {String}
        */
    setURL(path: string): void;
    /**
          Register a callback to be invoked when the path changes. These
          callbacks will execute when the user presses the back or forward
          button, but not after `setURL` is invoked.
      
          @private
          @method onUpdateURL
          @param callback {Function}
        */
    onUpdateURL(callback: (url: string) => void): void;
    /**
          Sets the path and calls the `updateURL` callback.
      
          @private
          @method handleURL
          @param url {String}
        */
    handleURL(url: string): void;
    /**
          Given a URL, formats it to be placed into the page as part
          of an element's `href` attribute.
      
          @private
          @method formatURL
          @param {String} url
          @return {String} url
        */
    formatURL(url: string): string;
  }
}