inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +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

40
docs/core/services/app-config.service.md
View File

@@ -13,27 +13,27 @@ Supports app configuration settings, stored server side.
### Methods
* **get**(key: `string`, defaultValue?: \`\`)<br/>
- **get**(key: `string`, defaultValue?: )<br/>
Gets the value of a named property.
* *key:* `string` - Name of the property
* *defaultValue:* \`\` - (Optional) Value to return if the key is not found
* **getLocationHostname**(): `string`<br/>
- _key:_ `string` - Name of the property
- _defaultValue:_ - (Optional) Value to return if the key is not found
- **getLocationHostname**(): `string`<br/>
Gets the location.hostname property.
* **Returns** `string` - Value of the property
* **getLocationPort**(prefix: `string` = `""`): `string`<br/>
- **Returns** `string` - Value of the property
- **getLocationPort**(prefix: `string` = `""`): `string`<br/>
Gets the location.port property.
* *prefix:* `string` - Text added before port value
* **Returns** `string` - Port with prefix
* **getLocationProtocol**(): `string`<br/>
- _prefix:_ `string` - Text added before port value
- **Returns** `string` - Port with prefix
- **getLocationProtocol**(): `string`<br/>
Gets the location.protocol value.
* **Returns** `string` - The location.protocol string
* **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>`<br/>
- **Returns** `string` - The location.protocol string
- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>`<br/>
Loads the config file.
* **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete
* **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<any>` - Notification when loading is complete
- **select**(property: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Requests notification of a property value when it is loaded.
* *property:* `string` - The desired property value
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded
- _property:_ `string` - The desired property value
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Property value, when loaded
## Details
@@ -107,11 +107,11 @@ The [`AppConfigService`](../../core/services/app-config.service.md) supports a l
The supported variables are:
| Variable name | Runtime value |
| ------------- | ------------------- |
| protocol | `location.protocol` |
| hostname | `location.hostname` |
| port | `location.port` |
| Variable name | Runtime value |
| ------------- | ------------- |
| protocol | `location.protocol` |
| hostname | `location.hostname` |
| port | `location.port` |
## App Config onLoad Stream