Members
(static) dependencies :Array.<string>
- Source:
Class dependencies:
['app', 'config', 'ide.link'].
Methods
dump(…parameters)
- Source:
Dump variables as an HTTP response, or in the console if response is not available.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parameters |
* |
<repeatable> |
The dumped parameters. |
dumpForFile(file, …parameters)
- Source:
Dump variable from the explicitly given file.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
file |
string | The file the dump was originally called. | |
parameters |
* |
<repeatable> |
The dumped parameters. |
respondWithDump(data)
- Source:
Send the proper response with the dumped data.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
support.services.Dumper.DumperData | The processed dump data model. |
getDump(…parameters)
- Source:
Get dump without the whole HTML page around it.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parameters |
* |
<repeatable> |
The dumped parameters. |
Returns:
The rendered dump.
- Type
- string
getDumpForFile(file, …parameters)
- Source:
Get dump without the whole HTML page around it from the explicitly given file.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
file |
string | The file the dump was originally called. | |
parameters |
* |
<repeatable> |
The dumped parameters. |
Returns:
The rendered dump.
- Type
- string
makeDump(data)
- Source:
Make dump view with the dump formatted data.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
support.services.Dumper.DumperData | The processed dump data model. |
Returns:
The rendered dump.
- Type
- string
getDumpData(…parameters)
- Source:
Get dump data without the main rendered view.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parameters |
* |
<repeatable> |
The dumped parameters. |
Returns:
The processed dump data model.
- Type
- support.services.Dumper.DumperData
getDumpDataForFile(file, …parameters)
- Source:
Get dump data withou the main rendered view for the explicitly given file.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
file |
string | The file the dump was originally called. | |
parameters |
* |
<repeatable> |
The dumped parameters. |
Returns:
The processed dump data model.
- Type
- support.services.Dumper.DumperData
stringify(data, levelopt)
- Source:
Stringify a value by using the dedicated views for the current view engine.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
data |
* | The data to stringify. | ||
level |
number |
<optional> |
0
|
The depth level. |
Returns:
The stringified value.
- Type
- string
getStringifiedObjectModel(data, levelopt)
- Source:
Stringify a plain object, an instance or an array and return a model containing rendering information.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
data |
object | Array.<*> | The data to stringify. | ||
level |
number |
<optional> |
0
|
The depth level. |
Returns:
The rendering information with the stringified value.
- Type
- Object
getStringifiedObjectItemModel(key, data, levelopt)
- Source:
Stringify object item and return a model containing rendering information.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
key |
string | number | The object item key. | ||
data |
* | The object item. | ||
level |
number |
<optional> |
1
|
The depth level. |
Returns:
The rendering information with the stringified value.
- Type
- Object
stringifyCircular(data)
- Source:
Stringify ciurcular reference.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
object | Array.<*> | The circular instance. |
Returns:
The stringified circular reference.
- Type
- string
getStringifiedPrimitiveModel(data)
- Source:
Stringify a non-object primitive and return a model containing rendering information.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
* | The data to stringify. |
Returns:
The rendering information with the stringified value.
- Type
- Object
getObjectTypeName(data)
- Source:
Get object type formatted name.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
object | Array.<*> | The object to get name from. |
Returns:
The object name.
- Type
- string
getDelta(instance)
- Source:
Get delta for specific instance.
If not an object or an array, null is returned.
Parameters:
| Name | Type | Description |
|---|---|---|
instance |
* | The instance to get delta from. |
Returns:
The delta, or null if not applicable.
- Type
- null | number
useTheme(theme)
- Source:
Use theme by name.
The theme data will be fetched from the `http.dumper.themes` configuration.
Parameters:
| Name | Type | Description |
|---|---|---|
theme |
string | The theme name. |
Returns:
The current dumper instance.
- Type
- http.services.Dumper
setResponse(response)
- Source:
Set the current response instance.
Parameters:
| Name | Type | Description |
|---|---|---|
response |
response | The current response instance. |
Returns:
The current dumper instance.
- Type
- http.services.Dumper
makeView(viewName, data)
- Source:
Render a view by name with the appropriate namespace for the current engine.
Parameters:
| Name | Type | Description |
|---|---|---|
viewName |
string | The view name, without namespace or engine prefix. |
data |
* | The view-model data. |
Returns:
The rendered view.
- Type
- string
getLocation()
- Source:
Get the dump file and line location.
Returns:
The dump call location.
- Type
- string
getLocationLink(locationopt)
- Source:
Get the dump location IDE link.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
location |
string |
<optional> |
this.getLocation()
|
The location to get link from. |
Returns:
The IDE link to the dump call.
- Type
- string
shouldDump()
- Source:
Check if the dumper should dump or return dumped content based on the current environment and configuration.
Returns:
Indicates that the dumper should dump.
- Type
- boolean