next-core-application

Augmented.js Next Core - Application

API

Table of Contents

• Application
  • Parameters
  • Examples
  • router
  • started
  • initialize
  • beforeInitialize
  • afterInitialize
  • name
  • metadata
  • setMetadataItem
    • Parameters
  • getMetadataItem
    • Parameters
  • registerRouter
    • Parameters
  • start
  • stop
  • datastore
    • Properties

Application

Application Class for use to define an application.
An application contains metadata and initializers for the application.
Applications track history, and normally would contain the entire single page App startup.

Supported options are:

• metadata - an object of metadata to use for storing properties
• name - the name of the application
• datastore - a datastore to use via the datastore property
• router - the router to use via the router property

Parameters

• options object options to init the application

Examples

const app = new Application({ "name": "Awesome" });
app.start();

const app = new Application();
app.name = "My Super Application!";
app.setMetadataItem("description", "something very awesome");
app.initialize = () => { do some stuff... };
app.start();

router

The router property of the application

started

The started property of the application

Returns boolean Returns the property of the started Event

initialize

Event for after during startup of the application

beforeInitialize

Event for before the startup of the application

afterInitialize

Event for after the startup of the application

name

The application name

metadata

The metadata map

Returns any Map of metadata in an Augmented.Utility.Map

setMetadataItem

Set a specific item in metadata

Parameters

• key string Key to set
• value object Value of the key

getMetadataItem

Get a specific item in metadata

Parameters

• key string Key

Returns object value of the key

registerRouter

Register a Router - adds routes to the application

Parameters

• router Router Router to register

start

Event to start the application and history

Returns Promise Promise.Resolve or Promise.Reject based on success

stop

Event to stop the application and history

datastore

Gets the datastore for the application

Properties

• datastore (Augmented.Model | object)