Type Definitions
req
The req object represents the HTTP request and has properties for the request query string, parameters, body, HTTP headers, and so on.
- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
params | Object | HTTP request parameter. | |
body | Object | <optional> | HTTP POST request body. |
header | Object | HTTP request header. |
- Source
res
The res object represents the HTTP response that an [Express] app sends when it gets an HTTP request.
- Object
- Source
roles
- Object
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
roles | Object | roles configuration object Properties
|
- Source
template
A template is an object property of the workspace.templates
- Object
| Name | Type | Description |
|---|---|---|
_type | Object | The _type property distinguish the origin of a template. 'core' templates are added from the /mod/workspace/templates directory. A 'custom' is added from a custom_template JSON file defined in the process.env. A 'workspace' is added from the workspace itself. A _type='template' object is assigned in the assignWorkspaceTemplates method. |
src | String | The source is a location from which a template object is loaded when required. Once loaded the template will be cached. |
cached | Object | The cached template. |
template | String | The string representation of a template, eg. html, sql. |
render | function | A method which resolves in a template string. |
module | Boolean | The template is a module. |
workspace
The workspace object defines the mapp resources available in an XYZ instance.
- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
roles | Object | <optional> | Each property of the roles object is a role which can be assigned to a user. |
dbs | string | <optional> | The fallback dbs connection if not implicit in [query] template. |
locale | Object | The default locale which serves as a templates for all locales in workspace. | |
locales | Object | Each property in the locales object is a locale available from this workspace. |