/workspace/getLocale
The getLocale module exports the getLocale method which is required by the getLayer and workspace modules.
- Source
Requires
- module:/utils/envReplace
- module:/utils/merge
- module:/utils/telemetry
- module:/workspace/cache
- module:/workspace/composeObj
- module:/workspace/getTemplate
Methods
(async, inner) getLocale(params, parentLocaleopt) → {Promise.<(Object|Error)>}
Nested locales can be requested by providing an array of locale keys. The first locale key will be used to retrieve the locale object and the remaining locale keys will be merged into the first locale as nested locales.
The getLocale method will return an error if the requesting user does not have access to the locale.
| Name | Type | Attributes | Description |
|---|---|---|---|
params | Object | ||
parentLocale | Object | <optional> | Locale will be merged into optional parentLocale to create a nested locale. |
| Name | Type | Attributes | Description |
|---|---|---|---|
params.locale | string | <optional> | Locale key. |
params.locale | array | <optional> | An array of locale keys to be merged as a nested locale. |
params.user | Object | <optional> | Requesting user. |
user.roles | Array | <optional> | User roles. |
params.layers | Boolean | <optional> | Whether to retrieve layers for the locale. |
- Source
JSON Locale.
- Type:
- Promise.<(Object|Error)>
(inner) localeAttribute(localeopt) → {string}
Returns the locale param as a string span attribute.
| Name | Type | Attributes | Description |
|---|---|---|---|
locale | string | | <optional> | The locale param. |
- Source
The locale key.
- Type:
- string
(async, inner) mergeParentLocale(locale, parentLocaleopt)
Merges a child locale into a parent locale, composing their properties and updating the nested locale structure.
| Name | Type | Attributes | Description |
|---|---|---|---|
locale | Object | The locale object to compose. | |
parentLocale | Object | <optional> | Optional parent locale to merge into. |
- Source
(async, inner) resolveLocale(params, parentLocaleopt) → {Promise.<(Object|Error)>}
Resolves the locale for the getLocale method.
| Name | Type | Attributes | Description |
|---|---|---|---|
params | Object | ||
parentLocale | Object | <optional> | Locale will be merged into optional parentLocale to create a nested locale. |
- Source
JSON Locale.
- Type:
- Promise.<(Object|Error)>
(async, inner) workspaceLocale(workspace, params) → {Promise.<(Object|Error)>}
Returns a clone of the locale for the first locale key in the params.locale. The first key is removed from a params.locale array, the remaining keys are nested locales.
The locale is looked up in the workspace.locale, the workspace.locales, or the workspace templates. A locale object provided as locale key is cloned.
| Name | Type | Description |
|---|---|---|
workspace | workspace | The cached workspace. |
params | Object |
| Name | Type | Attributes | Description |
|---|---|---|---|
params.locale | string | | <optional> | Locale key, array of locale keys, or locale object. |
- Source
JSON Locale or the getTemplate error.
- Type:
- Promise.<(Object|Error)>