litespeed.js/docs/services/router.md

Lite & fast micro javascript framework that is easy to learn

# State

The state service manages the application state registration and routing logic.

## API

- [add(path, view)](#add)
- [change(url, replace)](#change)
- [reload()](#reload)
- [match(location)](#match)
- [getCurrent()](#getCurrent)
- [getPrevious()](#getPrevious)

## Attributes

- [params](params)

### add()

Add a new state to the app states list. When a the app init or when a URL changes the [match](#match) method will check all states to find a state that matches the current URL.

Param | Type | Description
--- | --- | ---
**path** | string | State URL path
**view** | object | State [view object]((/docs/services/view.md))

#### Return Value

Returns state object instance.

#### Example
```js
state.add('/contact-us', {
    'template': '/templates/contact-us.html',
    'repeat': false,
});
```

### change()

Change app current state. Use the replace param to control whether the new state should replace current state in History API or added as a new state. This mainly affects the behaviour of the browser back button. 

Param | Type | Description
--- | --- | ---
**url** | string | New state URL
**replace** | boolean | Add new state or replace current one

#### Return Value

Returns state object instance.

#### Example
```js
state.change('/new-view', false);
```

### reload()

The reload method reload current app state and re-render the [ls-scope](/docs/views/scope.md) view component 

#### Return Value

Returns state object instance.

#### Example
```js
state.reload();
```

### match()

The match method iterate over all the states that has been registered to the state service with the [add](#add) method and find the current state against the [location object](https://www.w3schools.com/jsref/obj_location.asp) received in the method call.   

Param | Type | Description
--- | --- | ---
**location** | object | [location object](https://www.w3schools.com/jsref/obj_location.asp)

#### Return Value

Returns matching state or null if no state was found.

#### Example
```js
state.change('/new-view', false);
```

### getCurrent()

Get current app state object.   

#### Return Value

Returns current app state object.

#### Example
```js
state.getCurrent();
```

### getPrevious()

Get previous app state object.   

#### Return Value

Returns previous app state object.

#### Example
```js
state.getPrevious();
```