clearDatabase

Resets the database data. By default, the data is retrieved again immediately.

note

This can be considered a nuke option as all previous data will be lost.

Field Configurations

Key	Type	Description	Default Value
"params"	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"reload"	Boolean,String	Specifies whether all sources should be retrieved directly.	true

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Clear a database

Goal: Create a clearDatabase action clearing the database.

To achieve this the following code can be used:

{
  "type": "clearDatabase",
  "params": {
    "relaod": true
  }
}

The reload parameter specifies whether all sources should be retrieved directly.

Result:

A clearDatabase action has been created.