inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/core/services/log.service.md
View File

@@ -51,49 +51,49 @@ export class AppComponent {
### Methods
* **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
Logs a message if a boolean test fails.
* *test:* `boolean` - (Optional) Test value (typically a boolean expression)
* *message:* `string` - (Optional) Message to show if test is false
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **debug**(message?: `any`, optionalParams: `any[]`)<br/>
- _test:_ `boolean` - (Optional) Test value (typically a boolean expression)
- _message:_ `string` - (Optional) Message to show if test is false
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **debug**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "DEBUG" level.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **error**(message?: `any`, optionalParams: `any[]`)<br/>
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **error**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "ERROR" level.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)<br/>
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)<br/>
Converts a log level name string into its numeric equivalent.
* *level:* `string` - Level name
* **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
* **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
- _level:_ `string` - Level name
- **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
- **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
Starts an indented group of log messages.
* *groupTitle:* `string` - (Optional) Title shown at the start of the group
* *optionalParams:* `any[]` - Interpolation values for the title in "printf" format
* **groupEnd**()<br/>
- _groupTitle:_ `string` - (Optional) Title shown at the start of the group
- _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format
- **groupEnd**()<br/>
Ends a indented group of log messages.
* **info**(message?: `any`, optionalParams: `any[]`)<br/>
- **info**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "INFO" level.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **log**(message?: `any`, optionalParams: `any[]`)<br/>
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **log**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at any level from "TRACE" upwards.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **messageBus**(text: `string`, logLevel: `string`)<br/>
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **messageBus**(text: `string`, logLevel: `string`)<br/>
Triggers notification callback for log messages.
* *text:* `string` - Message text
* *logLevel:* `string` - Log level for the message
* **trace**(message?: `any`, optionalParams: `any[]`)<br/>
- _text:_ `string` - Message text
- _logLevel:_ `string` - Log level for the message
- **trace**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "TRACE" level.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **warn**(message?: `any`, optionalParams: `any[]`)<br/>
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **warn**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "WARN" level.
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
## Details
@@ -101,16 +101,16 @@ export class AppComponent {
There are 6 levels of logs that you can use:
| Name | Level |
| ------ | ----- |
| TRACE | 5 |
| DEBUG | 4 |
| INFO | 3 |
| WARN | 2 |
| ERROR | 1 |
| SILENT | 0 |
| Name | Level |
| ---- | ----- |
| TRACE | 5 |
| DEBUG | 4 |
| INFO | 3 |
| WARN | 2 |
| ERROR | 1 |
| SILENT | 0 |
You can set the default log level using the ***logLevel*** property in `app.config.json`.
You can set the default log level using the **_logLevel_** property in `app.config.json`.
The factory setting for this property is `TRACE`.
For example, you can set the default log level to `WARNING` as follows: