# ibm-wch-sdk-utils

> Software development kit to simplify the development of Angular based single page applications against Watson Content Hub.

Latest version **5.0.361** (published 2018-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install ibm-wch-sdk-utils
pnpm add ibm-wch-sdk-utils
yarn add ibm-wch-sdk-utils
bun add ibm-wch-sdk-utils
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.361 |
| Published | 2018-10-10 |
| First published | 2018-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | carstenleue |

## Links

- npm: https://www.npmjs.com/package/ibm-wch-sdk-utils
- Repository: git@github.ibm.com:DX/prod-wch-sdk
- Issues: https://developer.ibm.com/answers/smartspace/wch/index.html
- npm.io page: https://npm.io/package/ibm-wch-sdk-utils

## Dependencies (2)

- [tslib](https://npm.io/package/tslib.md) ^1.7.1
- [ibm-wch-sdk-api](https://npm.io/package/ibm-wch-sdk-api.md) 5.0.361

## Recent versions

- 5.0.361 (latest) — 2018-10-10
- 5.0.341 — 2018-06-21
- 5.0.340 — 2018-06-21
- 5.0.334 — 2018-05-23
- 5.0.321 — 2018-05-22
- 5.0.325 — 2018-05-09
- 5.0.316 — 2018-05-09
- 5.0.314 — 2018-04-30
- 5.0.300 — 2018-04-27
- 5.0.269 — 2018-04-10
- 5.0.265 — 2018-04-06
- 5.0.258 — 2018-04-04
- 5.0.254 — 2018-04-04
- 5.0.240 — 2018-03-27
- 5.0.238 — 2018-03-26
- … 10 more at https://npm.io/package/ibm-wch-sdk-utils/versions

## README

<a name="_6413c217ac070f0cc888ef237e5f77bca091ed14c4a6b017e8102394c2fc842d"></a>
# ibm-wch-sdk-utils

Exposes framework independent APIs to support the implementation of [ibm-wch-sdk-ng](https://www.npmjs.com/package/ibm-wch-sdk-ng) and similar SDK.

## Details

Refer to the [documentation](#_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375).

## Changes

[CHANGELOG](#_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512)

## Class documentation

Refer to the [documentation](#_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b).

<a name="_4f5f0d570547cc32a6c26a19831659ff187906f3e173dec4cc7caa8b01b03375"></a>
# Utils

TBD

<a name="_20bdb6f8aeaf2e57d73cf0f8f7596ac3a05ab33429cf49a686e6738debcd4512"></a>
# Changelog

## Current

### Added

* Added typecheck methods for the new `group` element type
* New `getCategoryLeaf` helper function
* Initial version
<a name="_28a07594e891c43454fa39c2c573639385bbf768c0897d05c3db61d89570388b"></a>

Utils
=====

TBD

## Index

### External modules

* ["cache/cache.utils"](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)
* ["categories/categories"](#_6ef573db579410052240872183feb1248a890ed1b2fad6c3f8446d371be0652a)
* ["consumers/consumer"](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)
* ["cors/cors.utils"](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)
* ["debug/debug.utils"](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* ["elements/element"](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* ["error/error"](#_4410fb8e64cb7359fd126243eba5ac43323fc1ad53e8a0ed5444a22f1d782c37)
* ["generators/generator"](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)
* ["generators/lazy.generator"](#_db0d7cc88f59eaa9805726888c3ff94c1889f2e2533723c90cffdefcdb8b55b6)
* ["hash/hash.utils"](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* ["http/http.utils"](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* ["idle/idle"](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["js/js.utils"](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* ["json/json.utils"](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
* ["layouts/layout"](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* ["logger/console.logger"](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* ["logger/noop.logger"](#_98e353213f9cc2221a397c6f11f63e5ce44eb6f9cade1c13cc5caae0f419bb41)
* ["logger/noop.logger.service"](#_cd33d6b69708d7a6c383b5faabace0c44d3cc36d96617836792718f8aff4b154)
* ["messages/message.event"](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* ["messages/navigate.by.path.handler"](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)
* ["messages/refresh.handler"](#_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526)
* ["messages/set.mode.handler"](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)
* ["messages/subscribe.active.route.handler"](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)
* ["messages/subscribe.handler"](#_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce)
* ["messages/subscribe.mode.handler"](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)
* ["messages/subscribe.route.handler"](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)
* ["misc"](#_87db2cbdba9ba53c30678c1ae3b89f921797d847824725865bae172d8e624ed2)
* ["operators/operators"](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* ["predicates/predicates"](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* ["rendering/rendering"](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* ["rx/rx.utils"](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* ["search/search.utils"](#_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311)
* ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* ["site/sites.constants"](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)
* ["static/static.resources"](#_e8a27f1e14373c14869782e771b6d002ee138a12c4dc32d803dddb985812df86)
* ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)
* ["storage/storage.service"](#_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf)
* ["url/url.utils"](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* ["wch/wch.utils"](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

---


<a name="_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["cache/cache.utils"](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)

# External module: "cache/cache.utils"

## Index

### Interfaces

* [CacheImpl](#_7f7e46578096800d809ec39521155bff7d5fece796e2914c49a794151c0ffb51)
* [CacheValue](#_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6)

### Type aliases

* [CacheAccessor](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)
* [CacheCallback](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)

### Variables

* [DEFAULT_MAXCOUNT](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)
* [DEFAULT_TIMEOUT](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)

### Functions

* [_createCache](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)

---

## Type aliases

<a id="cacheaccessor"></a>

###  CacheAccessor

**Ƭ CacheAccessor**: *[BiFunction](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`string`, [CacheCallback](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)<`V`>, `V`>*

*Defined in cache/cache.utils.ts:11*

___
<a id="cachecallback"></a>

###  CacheCallback

**Ƭ CacheCallback**: *`UnaryFunction`<`string`, `V`>*

*Defined in cache/cache.utils.ts:10*

___

## Variables

<a id="default_maxcount"></a>

### `<Const>` DEFAULT_MAXCOUNT

**● DEFAULT_MAXCOUNT**: *`100`* = 100

*Defined in cache/cache.utils.ts:28*

___
<a id="default_timeout"></a>

### `<Const>` DEFAULT_TIMEOUT

**● DEFAULT_TIMEOUT**: *`number`* =  30 * 1000

*Defined in cache/cache.utils.ts:25*

___

## Functions

<a id="_createcache"></a>

### `<Const>` _createCache

▸ **_createCache**<`V`>(aTimeout?: *`number`*, aMaxValues?: *`number`*, aLogger?: *`Logger`*): [CacheAccessor](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)<`V`>

*Defined in cache/cache.utils.ts:38*

Constructs a new cache

**Type parameters:**

#### V 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` aTimeout | `number` |  timeout |
| `Optional` aMaxValues | `number` |  maximum cache entries |
| `Optional` aLogger | `Logger` |

**Returns:** [CacheAccessor](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)<`V`>
the accessor function

___


<a name="_6ef573db579410052240872183feb1248a890ed1b2fad6c3f8446d371be0652a"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["categories/categories"](#_6ef573db579410052240872183feb1248a890ed1b2fad6c3f8446d371be0652a)

# External module: "categories/categories"

## Index

### Functions

* [getCategoryLeaf](#_6ef573db579410052240872183feb1248a890ed1b2fad6c3f8446d371be0652a)

---

## Functions

<a id="getcategoryleaf"></a>

### `<Const>` getCategoryLeaf

▸ **getCategoryLeaf**(aCategory: *`Category`*, aIndex?: *`number`*, aFallback?: *`string`*): `string`

*Defined in categories/categories.ts:13*

Extracts the last category element

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aCategory | `Category` |  the category |
| `Optional` aIndex | `number` |  category index |
| `Optional` aFallback | `string` |  fallback |

**Returns:** `string`
the last element

___


<a name="_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["consumers/consumer"](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)

# External module: "consumers/consumer"

## Index

### Type aliases

* [BiConsumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)
* [BiFunction](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)
* [Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)

---

## Type aliases

<a id="biconsumer"></a>

###  BiConsumer

**Ƭ BiConsumer**: *[BiFunction](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T1`, `T2`, `any`>*

*Defined in consumers/consumer.ts:5*

___
<a id="bifunction"></a>

###  BiFunction

**Ƭ BiFunction**: *`function`*

*Defined in consumers/consumer.ts:4*

#### Type declaration
▸(t1: *`T1`*, t2: *`T2`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| t1 | `T1` |
| t2 | `T2` |

**Returns:** `R`

___
<a id="consumer"></a>

###  Consumer

**Ƭ Consumer**: *`UnaryFunction`<`T`, `any`>*

*Defined in consumers/consumer.ts:3*

___


<a name="_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["cors/cors.utils"](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)

# External module: "cors/cors.utils"

## Index

### Variables

* [NULL_ORIGIN](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)
* [_ALL_ORIGINS](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)

### Functions

* [_testOrigin](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)

---

## Variables

<a id="null_origin"></a>

### `<Const>` NULL_ORIGIN

**● NULL_ORIGIN**: *"null"* = "null"

*Defined in cors/cors.utils.ts:11*

___
<a id="_all_origins"></a>

### `<Const>` _ALL_ORIGINS

**● _ALL_ORIGINS**: *"*"* = "*"

*Defined in cors/cors.utils.ts:8*

___

## Functions

<a id="_testorigin"></a>

###  _testOrigin

▸ **_testOrigin**(aOrigin: *`string`*, aAllowedOrigins: *`string`[]*, aLogger?: *`Logger`*): `boolean`

*Defined in cors/cors.utils.ts:21*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aOrigin | `string` |
| aAllowedOrigins | `string`[] |
| `Optional` aLogger | `Logger` |

**Returns:** `boolean`

___


<a name="_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["debug/debug.utils"](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

# External module: "debug/debug.utils"

## Index

### Type aliases

* [AddDebugCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

### Variables

* [COUNTER](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* [_isFrozen](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

### Functions

* [_addDebugInfo](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* [_addSourceCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* [_addSourceDebug](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* [_getCounter](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

---

## Type aliases

<a id="adddebugcallback"></a>

###  AddDebugCallback

**Ƭ AddDebugCallback**: *`function`*

*Defined in debug/debug.utils.ts:13*

#### Type declaration
▸(aDbg: *`any`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aDbg | `any` |

**Returns:** `void`

___

## Variables

<a id="counter"></a>

### `<Let>` COUNTER

**● COUNTER**: *`number`* = 0

*Defined in debug/debug.utils.ts:5*

___
<a id="_isfrozen"></a>

### `<Const>` _isFrozen

**● _isFrozen**: *`isFrozen`* =  Object.isFrozen

*Defined in debug/debug.utils.ts:11*

___

## Functions

<a id="_adddebuginfo"></a>

###  _addDebugInfo

▸ **_addDebugInfo**<`T`>(aCallback: *[AddDebugCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)*, aObject: *`T`*): `T`

*Defined in debug/debug.utils.ts:33*

Augments the object with debug information

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aCallback | [AddDebugCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0) |
| aObject | `T` |  the object |

**Returns:** `T`
the object

___
<a id="_addsourcecallback"></a>

###  _addSourceCallback

▸ **_addSourceCallback**(aSource: *`string`*): [AddDebugCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

*Defined in debug/debug.utils.ts:18*

Adds source information

**Parameters:**

| Param | Type |
| ------ | ------ |
| aSource | `string` |

**Returns:** [AddDebugCallback](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)

___
<a id="_addsourcedebug"></a>

###  _addSourceDebug

▸ **_addSourceDebug**<`T`>(aSource: *`string`*, aObject: *`T`*): `T`

*Defined in debug/debug.utils.ts:54*

Adds source information

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSource | `string` |  source info |
| aObject | `T` |  the object |

**Returns:** `T`
the original object

___
<a id="_getcounter"></a>

###  _getCounter

▸ **_getCounter**(): `number`

*Defined in debug/debug.utils.ts:7*

**Returns:** `number`

___


<a name="_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["elements/element"](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)

# External module: "elements/element"

## Index

### Variables

* [_PROP_ID](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_PROP_SELECTION](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_PROP_TYPE](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_PROP_TYPE_REF](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_PROP_VALUE](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_PROP_VALUES](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)

### Functions

* [_falseHandler](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_getHandler](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isCategoryElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isDateElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isFile](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isFileElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isFormattedTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isGroup](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isGroupElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isImage](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isImageElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isLink](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isLinkElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isLocationElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiDateElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiFileElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiFormattedTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiGroupElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiImageElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiLinkElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiNumberElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiOptionSelectionElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiReferenceElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiToggleElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isMultiVideoElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isNumberElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isOptionSelection](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isOptionSelectionElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isReferenceElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleDateElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleFileElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleFormattedTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleGroupElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleImageElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleLinkElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleNumberElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleOptionSelectionElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleReferenceElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleToggleElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSingleVideoElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeDateElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeFileElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeFormattedTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeGroupElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeImageElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeLinkElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeNumberElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeOptionSelectionElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeReferenceElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeToggleElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isSomeVideoElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isTextElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isToggleElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isType](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isTypeRef](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isVideo](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* [_isVideoElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)

### Object literals

* [HANDLERS](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)

---

## Variables

<a id="_prop_id"></a>

### `<Const>` _PROP_ID

**● _PROP_ID**: *"id"* = "id"

*Defined in elements/element.ts:82*

___
<a id="_prop_selection"></a>

### `<Const>` _PROP_SELECTION

**● _PROP_SELECTION**: *"selection"* = "selection"

*Defined in elements/element.ts:80*

___
<a id="_prop_type"></a>

### `<Const>` _PROP_TYPE

**● _PROP_TYPE**: *"elementType"* = "elementType"

*Defined in elements/element.ts:77*

___
<a id="_prop_type_ref"></a>

### `<Const>` _PROP_TYPE_REF

**● _PROP_TYPE_REF**: *"typeRef"* = "typeRef"

*Defined in elements/element.ts:81*

___
<a id="_prop_value"></a>

### `<Const>` _PROP_VALUE

**● _PROP_VALUE**: *"value"* = "value"

*Defined in elements/element.ts:78*

___
<a id="_prop_values"></a>

### `<Const>` _PROP_VALUES

**● _PROP_VALUES**: *"values"* = "values"

*Defined in elements/element.ts:79*

___

## Functions

<a id="_falsehandler"></a>

### `<Const>` _falseHandler

▸ **_falseHandler**(): `boolean`

*Defined in elements/element.ts:570*

**Returns:** `boolean`

___
<a id="_gethandler"></a>

### `<Const>` _getHandler

▸ **_getHandler**(aElementType: *`string`*): [Predicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`any`>

*Defined in elements/element.ts:572*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aElementType | `string` |

**Returns:** [Predicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`any`>

___
<a id="_iscategoryelement"></a>

###  _isCategoryElement

▸ **_isCategoryElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:332*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isdateelement"></a>

###  _isDateElement

▸ **_isDateElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:322*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_iselement"></a>

###  _isElement

▸ **_isElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:580*

Tests if the value is a value element

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value |

**Returns:** `boolean`
true if the value is a valid element

___
<a id="_isfile"></a>

###  _isFile

▸ **_isFile**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:346*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isfileelement"></a>

###  _isFileElement

▸ **_isFileElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:342*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isformattedtextelement"></a>

###  _isFormattedTextElement

▸ **_isFormattedTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:222*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isgroup"></a>

###  _isGroup

▸ **_isGroup**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:192*

Tests if the value is a vaid group

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value |

**Returns:** `boolean`
true if the value is a group, else false

___
<a id="_isgroupelement"></a>

###  _isGroupElement

▸ **_isGroupElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:182*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isimage"></a>

###  _isImage

▸ **_isImage**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:358*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isimageelement"></a>

###  _isImageElement

▸ **_isImageElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:398*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_islink"></a>

###  _isLink

▸ **_isLink**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:354*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_islinkelement"></a>

###  _isLinkElement

▸ **_isLinkElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:312*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_islocationelement"></a>

###  _isLocationElement

▸ **_isLocationElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:498*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultidateelement"></a>

###  _isMultiDateElement

▸ **_isMultiDateElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:172*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultifileelement"></a>

###  _isMultiFileElement

▸ **_isMultiFileElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:378*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultiformattedtextelement"></a>

###  _isMultiFormattedTextElement

▸ **_isMultiFormattedTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:242*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultigroupelement"></a>

###  _isMultiGroupElement

▸ **_isMultiGroupElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:212*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultiimageelement"></a>

###  _isMultiImageElement

▸ **_isMultiImageElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:418*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultilinkelement"></a>

###  _isMultiLinkElement

▸ **_isMultiLinkElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:458*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultinumberelement"></a>

###  _isMultiNumberElement

▸ **_isMultiNumberElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:272*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultioptionselectionelement"></a>

###  _isMultiOptionSelectionElement

▸ **_isMultiOptionSelectionElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:122*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultireferenceelement"></a>

###  _isMultiReferenceElement

▸ **_isMultiReferenceElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:488*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultitextelement"></a>

###  _isMultiTextElement

▸ **_isMultiTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:152*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultitoggleelement"></a>

###  _isMultiToggleElement

▸ **_isMultiToggleElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:302*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_ismultivideoelement"></a>

###  _isMultiVideoElement

▸ **_isMultiVideoElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:438*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isnumberelement"></a>

###  _isNumberElement

▸ **_isNumberElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:252*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isoptionselection"></a>

###  _isOptionSelection

▸ **_isOptionSelection**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:102*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isoptionselectionelement"></a>

###  _isOptionSelectionElement

▸ **_isOptionSelectionElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:98*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isreferenceelement"></a>

###  _isReferenceElement

▸ **_isReferenceElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:468*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingledateelement"></a>

###  _isSingleDateElement

▸ **_isSingleDateElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:162*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglefileelement"></a>

###  _isSingleFileElement

▸ **_isSingleFileElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:368*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingleformattedtextelement"></a>

###  _isSingleFormattedTextElement

▸ **_isSingleFormattedTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:232*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglegroupelement"></a>

###  _isSingleGroupElement

▸ **_isSingleGroupElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:202*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingleimageelement"></a>

###  _isSingleImageElement

▸ **_isSingleImageElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:408*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglelinkelement"></a>

###  _isSingleLinkElement

▸ **_isSingleLinkElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:448*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglenumberelement"></a>

###  _isSingleNumberElement

▸ **_isSingleNumberElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:262*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingleoptionselectionelement"></a>

###  _isSingleOptionSelectionElement

▸ **_isSingleOptionSelectionElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:112*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglereferenceelement"></a>

###  _isSingleReferenceElement

▸ **_isSingleReferenceElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:478*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingletextelement"></a>

###  _isSingleTextElement

▸ **_isSingleTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:142*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issingletoggleelement"></a>

###  _isSingleToggleElement

▸ **_isSingleToggleElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:292*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issinglevideoelement"></a>

###  _isSingleVideoElement

▸ **_isSingleVideoElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:428*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomedateelement"></a>

###  _isSomeDateElement

▸ **_isSomeDateElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:502*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomefileelement"></a>

###  _isSomeFileElement

▸ **_isSomeFileElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:506*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomeformattedtextelement"></a>

###  _isSomeFormattedTextElement

▸ **_isSomeFormattedTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:510*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomegroupelement"></a>

###  _isSomeGroupElement

▸ **_isSomeGroupElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:514*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomeimageelement"></a>

###  _isSomeImageElement

▸ **_isSomeImageElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:518*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomelinkelement"></a>

###  _isSomeLinkElement

▸ **_isSomeLinkElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:522*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomenumberelement"></a>

###  _isSomeNumberElement

▸ **_isSomeNumberElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:526*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomeoptionselectionelement"></a>

###  _isSomeOptionSelectionElement

▸ **_isSomeOptionSelectionElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:530*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomereferenceelement"></a>

###  _isSomeReferenceElement

▸ **_isSomeReferenceElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:534*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issometextelement"></a>

###  _isSomeTextElement

▸ **_isSomeTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:538*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issometoggleelement"></a>

###  _isSomeToggleElement

▸ **_isSomeToggleElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:542*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_issomevideoelement"></a>

###  _isSomeVideoElement

▸ **_isSomeVideoElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:546*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_istextelement"></a>

###  _isTextElement

▸ **_isTextElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:132*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_istoggleelement"></a>

###  _isToggleElement

▸ **_isToggleElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:282*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_istype"></a>

###  _isType

▸ **_isType**(aType: *`string`*, aValue: * `any` &#124; `null` &#124; `undefined`*): `boolean`

*Defined in elements/element.ts:84*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aType | `string` |
| aValue |  `any` &#124; `null` &#124; `undefined`|

**Returns:** `boolean`

___
<a id="_istyperef"></a>

###  _isTypeRef

▸ **_isTypeRef**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:88*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isvideo"></a>

###  _isVideo

▸ **_isVideo**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:350*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isvideoelement"></a>

###  _isVideoElement

▸ **_isVideoElement**(aValue: *`any`*): `boolean`

*Defined in elements/element.ts:388*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___

## Object literals

<a id="handlers"></a>

### `<Const>` HANDLERS

**HANDLERS**: *`object`*

*Defined in elements/element.ts:553*

Maps from element type to handler function

<a id="handlers.__computed"></a>

####  __computed

**● __computed**: *[_isSomeVideoElement](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)* =  _isSomeVideoElement

*Defined in elements/element.ts:554*
*Defined in elements/element.ts:555*
*Defined in elements/element.ts:556*
*Defined in elements/element.ts:557*
*Defined in elements/element.ts:558*
*Defined in elements/element.ts:559*
*Defined in elements/element.ts:560*
*Defined in elements/element.ts:561*
*Defined in elements/element.ts:562*
*Defined in elements/element.ts:563*
*Defined in elements/element.ts:564*
*Defined in elements/element.ts:565*
*Defined in elements/element.ts:566*
*Defined in elements/element.ts:567*

___

___


<a name="_4410fb8e64cb7359fd126243eba5ac43323fc1ad53e8a0ed5444a22f1d782c37"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["error/error"](#_4410fb8e64cb7359fd126243eba5ac43323fc1ad53e8a0ed5444a22f1d782c37)

# External module: "error/error"

## Index

### Functions

* [isErrorResponse](#_4410fb8e64cb7359fd126243eba5ac43323fc1ad53e8a0ed5444a22f1d782c37)

---

## Functions

<a id="iserrorresponse"></a>

###  isErrorResponse

▸ **isErrorResponse**(aResponse: *`any`*): `boolean`

*Defined in error/error.ts:10*

Tests if a response is an error response

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aResponse | `any` |  the response object |

**Returns:** `boolean`
true if the response is an error response, else false

___


<a name="_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["generators/generator"](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)

# External module: "generators/generator"

## Index

### Type aliases

* [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)

### Functions

* [_arrayGenerator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)
* [_objectGenerator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)

---

## Type aliases

<a id="generator"></a>

###  Generator

**Ƭ Generator**: *`function`*

*Defined in generators/generator.ts:3*

#### Type declaration
▸():  `T` &#124; `null` &#124; `undefined`

**Returns:**  `T` &#124; `null` &#124; `undefined`

___

## Functions

<a id="_arraygenerator"></a>

### `<Const>` _arrayGenerator

▸ **_arrayGenerator**<`T`>(): `T`[]

*Defined in generators/generator.ts:5*

**Type parameters:**

#### T 

**Returns:** `T`[]

___
<a id="_objectgenerator"></a>

### `<Const>` _objectGenerator

▸ **_objectGenerator**(): `any`

*Defined in generators/generator.ts:6*

**Returns:** `any`

___


<a name="_db0d7cc88f59eaa9805726888c3ff94c1889f2e2533723c90cffdefcdb8b55b6"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["generators/lazy.generator"](#_db0d7cc88f59eaa9805726888c3ff94c1889f2e2533723c90cffdefcdb8b55b6)

# External module: "generators/lazy.generator"

## Index

### Functions

* [_lazyGenerator](#_db0d7cc88f59eaa9805726888c3ff94c1889f2e2533723c90cffdefcdb8b55b6)

---

## Functions

<a id="_lazygenerator"></a>

###  _lazyGenerator

▸ **_lazyGenerator**<`T`>(aGenerator: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>*): [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>

*Defined in generators/lazy.generator.ts:10*

Creates a lazy generator for the value

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aGenerator | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`> |  the generator |

**Returns:** [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>
the generator

___


<a name="_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["hash/hash.utils"](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)

# External module: "hash/hash.utils"

## Index

### Variables

* [GOLDEN_RATIO_64](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [HASH_SEED_64](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_DIGITS](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_FIRST_LETTERS](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_FIRST_LETTERS_LENGTH](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_LOWERCASE](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_MAX_INT](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_NEXT_LETTERS](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_NEXT_LETTERS_LENGTH](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_START](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_UPPERCASE](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_abs](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_floor](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_random](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_trunc](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)

### Functions

* [_hashString](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_hashStringSegment](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_hashToIdentifier](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_longCombine](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_longHash](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* [_randomIdentifier](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)

---

## Variables

<a id="golden_ratio_64"></a>

### `<Const>` GOLDEN_RATIO_64

**● GOLDEN_RATIO_64**: *`1140071481932319900`* = 1140071481932319900

*Defined in hash/hash.utils.ts:8*

___
<a id="hash_seed_64"></a>

### `<Const>` HASH_SEED_64

**● HASH_SEED_64**: *`5177618702824568000`* = 5177618702824568000

*Defined in hash/hash.utils.ts:11*

___
<a id="_digits"></a>

### `<Const>` _DIGITS

**● _DIGITS**: *"0123456789"* = "0123456789"

*Defined in hash/hash.utils.ts:41*

___
<a id="_first_letters"></a>

### `<Const>` _FIRST_LETTERS

**● _FIRST_LETTERS**: *`string`* =  _START + _LOWERCASE + _UPPERCASE

*Defined in hash/hash.utils.ts:46*

___
<a id="_first_letters_length"></a>

### `<Const>` _FIRST_LETTERS_LENGTH

**● _FIRST_LETTERS_LENGTH**: *`number`* =  _FIRST_LETTERS.length

*Defined in hash/hash.utils.ts:48*

___
<a id="_lowercase"></a>

### `<Const>` _LOWERCASE

**● _LOWERCASE**: *"abcdefghijklmnopqrstuvwxyz"* = "abcdefghijklmnopqrstuvwxyz"

*Defined in hash/hash.utils.ts:42*

___
<a id="_max_int"></a>

### `<Const>` _MAX_INT

**● _MAX_INT**: *`number`* =  Number.MAX_SAFE_INTEGER

*Defined in hash/hash.utils.ts:78*

___
<a id="_next_letters"></a>

### `<Const>` _NEXT_LETTERS

**● _NEXT_LETTERS**: *`string`* =  _FIRST_LETTERS + _DIGITS

*Defined in hash/hash.utils.ts:47*

___
<a id="_next_letters_length"></a>

### `<Const>` _NEXT_LETTERS_LENGTH

**● _NEXT_LETTERS_LENGTH**: *`number`* =  _NEXT_LETTERS.length

*Defined in hash/hash.utils.ts:49*

___
<a id="_start"></a>

### `<Const>` _START

**● _START**: *"$_"* = "$_"

*Defined in hash/hash.utils.ts:40*

___
<a id="_uppercase"></a>

### `<Const>` _UPPERCASE

**● _UPPERCASE**: *`string`* =  _LOWERCASE.toUpperCase()

*Defined in hash/hash.utils.ts:43*

___
<a id="_abs"></a>

### `<Const>` _abs

**● _abs**: *`abs`* =  Math.abs

*Defined in hash/hash.utils.ts:52*

___
<a id="_floor"></a>

### `<Const>` _floor

**● _floor**: *`floor`* =  Math.floor

*Defined in hash/hash.utils.ts:53*

___
<a id="_random"></a>

### `<Const>` _random

**● _random**: *`random`* =  Math.random

*Defined in hash/hash.utils.ts:76*

___
<a id="_trunc"></a>

### `<Const>` _trunc

**● _trunc**: *`trunc`* =  Math.trunc

*Defined in hash/hash.utils.ts:77*

___

## Functions

<a id="_hashstring"></a>

###  _hashString

▸ **_hashString**(oldHash: *`number`*, s: *`string`*): `number`

*Defined in hash/hash.utils.ts:35*

**Parameters:**

| Param | Type |
| ------ | ------ |
| oldHash | `number` |
| s | `string` |

**Returns:** `number`

___
<a id="_hashstringsegment"></a>

###  _hashStringSegment

▸ **_hashStringSegment**(oldHash: *`number`*, start: *`number`*, len: *`number`*, s: *`string`*): `number`

*Defined in hash/hash.utils.ts:27*

**Parameters:**

| Param | Type |
| ------ | ------ |
| oldHash | `number` |
| start | `number` |
| len | `number` |
| s | `string` |

**Returns:** `number`

___
<a id="_hashtoidentifier"></a>

###  _hashToIdentifier

▸ **_hashToIdentifier**(aHash: *`number`*): `string`

*Defined in hash/hash.utils.ts:61*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aHash | `number` |

**Returns:** `string`

___
<a id="_longcombine"></a>

###  _longCombine

▸ **_longCombine**(oldHash: *`number`*, data: *`number`*): `number`

*Defined in hash/hash.utils.ts:22*

**Parameters:**

| Param | Type |
| ------ | ------ |
| oldHash | `number` |
| data | `number` |

**Returns:** `number`

___
<a id="_longhash"></a>

###  _longHash

▸ **_longHash**(): `number`

*Defined in hash/hash.utils.ts:18*

**Returns:** `number`

___
<a id="_randomidentifier"></a>

###  _randomIdentifier

▸ **_randomIdentifier**(): `string`

*Defined in hash/hash.utils.ts:85*

**Returns:** `string`

___


<a name="_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["http/http.utils"](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)

# External module: "http/http.utils"

## Index

### Interfaces

* [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)
* [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)

### Type aliases

* [Request](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)

### Variables

* [DEFAULT_POLL_TIME](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_POLL_TIME_VARIATION](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_RETRIES](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_API](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_BOOTSTRAP](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_JSONP](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_LOCAL_STORAGE](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_POLLING](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [DEFAULT_USE_STATIC_RESOURCES](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [ID](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [LOGGER](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [MAX_POLL_TIME](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [MAX_POLL_TIME_VARIATION](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [MIN_POLL_TIME](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [MIN_POLL_TIME_VARIATION](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_addDebugSource](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_privateUrlJsonCache](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_privateUrlStringCache](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_publicUrlJsonCache](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_publicUrlStringCache](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)

### Functions

* [_addDebug](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_clip](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_createJsonResource](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_createStringResource](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_createTimer](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_getErrorResponse](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_getJsonResource](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_getStringResource](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_sendJsonRequest](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_sendRequest](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* [_sendTextRequest](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)

### Object literals

* [DEFAULT_HTTP_RESOURCE_OPTIONS](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)

---

## Type aliases

<a id="request"></a>

###  Request

**Ƭ Request**: *`function`*

*Defined in http/http.utils.ts:49*

#### Type declaration
▸(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*): `Observable`<`T`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |

**Returns:** `Observable`<`T`>

___

## Variables

<a id="default_poll_time"></a>

### `<Const>` DEFAULT_POLL_TIME

**● DEFAULT_POLL_TIME**: *`number`* =  10 * 1000

*Defined in http/http.utils.ts:160*

___
<a id="default_poll_time_variation"></a>

### `<Const>` DEFAULT_POLL_TIME_VARIATION

**● DEFAULT_POLL_TIME_VARIATION**: *`0.15`* = 0.15

*Defined in http/http.utils.ts:155*

___
<a id="default_retries"></a>

### `<Const>` DEFAULT_RETRIES

**● DEFAULT_RETRIES**: *`10`* = 10

*Defined in http/http.utils.ts:165*

___
<a id="default_use_api"></a>

### `<Const>` DEFAULT_USE_API

**● DEFAULT_USE_API**: *`true`* = true

*Defined in http/http.utils.ts:175*

___
<a id="default_use_bootstrap"></a>

### `<Const>` DEFAULT_USE_BOOTSTRAP

**● DEFAULT_USE_BOOTSTRAP**: *`true`* = true

*Defined in http/http.utils.ts:185*

___
<a id="default_use_jsonp"></a>

### `<Const>` DEFAULT_USE_JSONP

**● DEFAULT_USE_JSONP**: *`true`* = true

*Defined in http/http.utils.ts:190*

___
<a id="default_use_local_storage"></a>

### `<Const>` DEFAULT_USE_LOCAL_STORAGE

**● DEFAULT_USE_LOCAL_STORAGE**: *`true`* = true

*Defined in http/http.utils.ts:170*

___
<a id="default_use_polling"></a>

### `<Const>` DEFAULT_USE_POLLING

**● DEFAULT_USE_POLLING**: *`true`* = true

*Defined in http/http.utils.ts:195*

___
<a id="default_use_static_resources"></a>

### `<Const>` DEFAULT_USE_STATIC_RESOURCES

**● DEFAULT_USE_STATIC_RESOURCES**: *`true`* = true

*Defined in http/http.utils.ts:180*

___
<a id="id"></a>

### `<Let>` ID

**● ID**: *`number`* = 0

*Defined in http/http.utils.ts:46*

___
<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"http.utils"* = "http.utils"

*Defined in http/http.utils.ts:31*

___
<a id="max_poll_time"></a>

### `<Const>` MAX_POLL_TIME

**● MAX_POLL_TIME**: *`number`* =  Number.MAX_SAFE_INTEGER

*Defined in http/http.utils.ts:199*

___
<a id="max_poll_time_variation"></a>

### `<Const>` MAX_POLL_TIME_VARIATION

**● MAX_POLL_TIME_VARIATION**: *`0.5`* = 0.5

*Defined in http/http.utils.ts:203*

___
<a id="min_poll_time"></a>

### `<Const>` MIN_POLL_TIME

**● MIN_POLL_TIME**: *`1000`* = 1000

*Defined in http/http.utils.ts:198*

___
<a id="min_poll_time_variation"></a>

### `<Const>` MIN_POLL_TIME_VARIATION

**● MIN_POLL_TIME_VARIATION**: *`0`* = 0

*Defined in http/http.utils.ts:202*

___
<a id="_adddebugsource"></a>

### `<Const>` _addDebugSource

**● _addDebugSource**: *`function`* =  dbgSourceCallback(LOGGER)

*Defined in http/http.utils.ts:268*

#### Type declaration
▸(aDbg: *`any`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aDbg | `any` |

**Returns:** `void`

___
<a id="_privateurljsoncache"></a>

### `<Const>` _privateUrlJsonCache

**● _privateUrlJsonCache**: *`function`* =  createCache<Observable<AnyJson>>()

*Defined in http/http.utils.ts:234*

#### Type declaration
▸(t1: *`T1`*, t2: *`T2`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| t1 | `T1` |
| t2 | `T2` |

**Returns:** `R`

___
<a id="_privateurlstringcache"></a>

### `<Const>` _privateUrlStringCache

**● _privateUrlStringCache**: *`function`* =  createCache<Observable<string>>()

*Defined in http/http.utils.ts:233*

#### Type declaration
▸(t1: *`T1`*, t2: *`T2`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| t1 | `T1` |
| t2 | `T2` |

**Returns:** `R`

___
<a id="_publicurljsoncache"></a>

### `<Const>` _publicUrlJsonCache

**● _publicUrlJsonCache**: *`function`* =  createCache<Observable<AnyJson>>()

*Defined in http/http.utils.ts:230*

#### Type declaration
▸(t1: *`T1`*, t2: *`T2`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| t1 | `T1` |
| t2 | `T2` |

**Returns:** `R`

___
<a id="_publicurlstringcache"></a>

### `<Const>` _publicUrlStringCache

**● _publicUrlStringCache**: *`function`* =  createCache<Observable<string>>()

*Defined in http/http.utils.ts:229*

#### Type declaration
▸(t1: *`T1`*, t2: *`T2`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| t1 | `T1` |
| t2 | `T2` |

**Returns:** `R`

___

## Functions

<a id="_adddebug"></a>

###  _addDebug

▸ **_addDebug**(aUrl: *`string`*, aResult: *[JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): [JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Defined in http/http.utils.ts:276*

Add debugging information to the result

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aUrl | `string` |  the URL |
| aResult | [JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |  the result |

**Returns:** [JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

___
<a id="_clip"></a>

###  _clip

▸ **_clip**(aValue: *`number`*, aMin: *`number`*, aMax: *`number`*): `number`

*Defined in http/http.utils.ts:212*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `number` |
| aMin | `number` |
| aMax | `number` |

**Returns:** `number`

___
<a id="_createjsonresource"></a>

###  _createJsonResource

▸ **_createJsonResource**(aURL: *`string`*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aWithCredentials: *`boolean`*, aTrigger: *`Observable`<`any`>*, aOptions: *`HttpResourceOptions`*, aLogger?: *`Logger`*): `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

*Defined in http/http.utils.ts:286*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL | `string` |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| aWithCredentials | `boolean` |
| aTrigger | `Observable`<`any`> |
| aOptions | `HttpResourceOptions` |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

___
<a id="_createstringresource"></a>

###  _createStringResource

▸ **_createStringResource**(aURL: *`string`*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aWithCredentials: *`boolean`*, aTrigger: *`Observable`<`any`>*, aOptions: *`HttpResourceOptions`*, aLogger?: *`Logger`*): `Observable`<`string`>

*Defined in http/http.utils.ts:313*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL | `string` |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| aWithCredentials | `boolean` |
| aTrigger | `Observable`<`any`> |
| aOptions | `HttpResourceOptions` |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<`string`>

___
<a id="_createtimer"></a>

###  _createTimer

▸ **_createTimer**(aOptions?: *`HttpResourceOptions`*): `Observable`<`any`>

*Defined in http/http.utils.ts:242*

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`any`>

___
<a id="_geterrorresponse"></a>

###  _getErrorResponse

▸ **_getErrorResponse**(aError: *`any`*): `ErrorResponse`

*Defined in http/http.utils.ts:57*

Build an error response object

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aError | `any` |  the error |

**Returns:** `ErrorResponse`
the response

___
<a id="_getjsonresource"></a>

###  _getJsonResource

▸ **_getJsonResource**(aURL: *`string`*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aWithCredentials: *`boolean`*, aTrigger: *`Observable`<`any`>*, aOptions?: *`HttpResourceOptions`*, aLogger?: *`Logger`*): `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

*Defined in http/http.utils.ts:354*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL | `string` |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| aWithCredentials | `boolean` |
| aTrigger | `Observable`<`any`> |
| `Optional` aOptions | `HttpResourceOptions` |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

___
<a id="_getstringresource"></a>

###  _getStringResource

▸ **_getStringResource**(aURL: *`string`*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aWithCredentials: *`boolean`*, aTrigger: *`Observable`<`any`>*, aOptions: *`HttpResourceOptions`*, aLogger?: *`Logger`*): `Observable`<`string`>

*Defined in http/http.utils.ts:336*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL | `string` |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| aWithCredentials | `boolean` |
| aTrigger | `Observable`<`any`> |
| aOptions | `HttpResourceOptions` |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<`string`>

___
<a id="_sendjsonrequest"></a>

###  _sendJsonRequest

▸ **_sendJsonRequest**<`T`>(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*, aTrigger: *`Observable`<`any`>*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aLogger?: *`Logger`*): `Observable`<`T`>

*Defined in http/http.utils.ts:130*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |
| aTrigger | `Observable`<`any`> |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<`T`>

___
<a id="_sendrequest"></a>

###  _sendRequest

▸ **_sendRequest**<`T`>(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*, aTrigger: *`Observable`<`any`>*, aRequest: *[Request](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)<`T`>*, aLogger: *`Logger`*): `Observable`<`T`>

*Defined in http/http.utils.ts:84*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |
| aTrigger | `Observable`<`any`> |
| aRequest | [Request](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)<`T`> |
| aLogger | `Logger` |

**Returns:** `Observable`<`T`>

___
<a id="_sendtextrequest"></a>

###  _sendTextRequest

▸ **_sendTextRequest**(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*, aTrigger: *`Observable`<`any`>*, aHttpService: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aLogger?: *`Logger`*): `Observable`<`string`>

*Defined in http/http.utils.ts:146*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |
| aTrigger | `Observable`<`any`> |
| aHttpService | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`<`string`>

___

## Object literals

<a id="default_http_resource_options"></a>

### `<Const>` DEFAULT_HTTP_RESOURCE_OPTIONS

**DEFAULT_HTTP_RESOURCE_OPTIONS**: *`object`*

*Defined in http/http.utils.ts:216*

<a id="default_http_resource_options.polltime"></a>

####  pollTime

**● pollTime**: *`number`* =  DEFAULT_POLL_TIME

*Defined in http/http.utils.ts:218*

___
<a id="default_http_resource_options.polltimevariation"></a>

####  pollTimeVariation

**● pollTimeVariation**: *`number`* =  DEFAULT_POLL_TIME_VARIATION

*Defined in http/http.utils.ts:217*

___
<a id="default_http_resource_options.retries"></a>

####  retries

**● retries**: *`number`* =  DEFAULT_RETRIES

*Defined in http/http.utils.ts:219*

___
<a id="default_http_resource_options.useapi"></a>

####  useApi

**● useApi**: *`true`* =  DEFAULT_USE_API

*Defined in http/http.utils.ts:225*

___
<a id="default_http_resource_options.usebootstrap"></a>

####  useBootstrap

**● useBootstrap**: *`true`* =  DEFAULT_USE_BOOTSTRAP

*Defined in http/http.utils.ts:221*

___
<a id="default_http_resource_options.usejsonp"></a>

####  useJsonP

**● useJsonP**: *`true`* =  DEFAULT_USE_JSONP

*Defined in http/http.utils.ts:223*

___
<a id="default_http_resource_options.uselocalstorage"></a>

####  useLocalStorage

**● useLocalStorage**: *`true`* =  DEFAULT_USE_LOCAL_STORAGE

*Defined in http/http.utils.ts:220*

___
<a id="default_http_resource_options.usepolling"></a>

####  usePolling

**● usePolling**: *`true`* =  DEFAULT_USE_POLLING

*Defined in http/http.utils.ts:224*

___
<a id="default_http_resource_options.usestaticresources"></a>

####  useStaticResources

**● useStaticResources**: *`true`* =  DEFAULT_USE_STATIC_RESOURCES

*Defined in http/http.utils.ts:222*

___

___


<a name="_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["idle/idle"](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)

# External module: "idle/idle"

## Index

### Variables

* [_cancelCallback](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)
* [_setCallback](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)
* [cancelIdleCallback](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)
* [requestIdleCallback](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)

---

## Variables

<a id="_cancelcallback"></a>

### `<Let>` _cancelCallback

**● _cancelCallback**: *`function`*

*Defined in idle/idle.ts:5*

#### Type declaration
▸(aHandle: *`number`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aHandle | `number` |

**Returns:** `void`

___
<a id="_setcallback"></a>

### `<Let>` _setCallback

**● _setCallback**: *`function`*

*Defined in idle/idle.ts:4*

#### Type declaration
▸(aFct: *`Function`*): `number`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aFct | `Function` |

**Returns:** `number`

___
<a id="cancelidlecallback"></a>

###  cancelIdleCallback

**● cancelIdleCallback**: *`function`*

*Defined in idle/idle.ts:8*

#### Type declaration
▸(aHandle: *`number`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aHandle | `number` |

**Returns:** `void`

___
<a id="requestidlecallback"></a>

###  requestIdleCallback

**● requestIdleCallback**: *`function`*

*Defined in idle/idle.ts:7*

#### Type declaration
▸(aCallback: *`Function`*): `number`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aCallback | `Function` |

**Returns:** `number`

___


<a name="_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)

# External module: "index"

## Index

---


<a name="_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["js/js.utils"](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)

# External module: "js/js.utils"

## Index

### Variables

* [KEY_DEBUG](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_FUNCTION_TYPE](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_UNDEFINED_TYPE](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_freeze](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_isFrozen](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_keys](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)

### Functions

* [_anyToString](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_arrayEquals](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_assertArray](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_assertFromGenerator](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_assertObject](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_cloneDeep](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_createGetter](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_deepEquals](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_forEach](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_forIn](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_freezeDeep](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_lastElement](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_objectAssign](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_objectEquals](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_push](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_random](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_reduceForIn](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* [_toInteger](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)

---

## Variables

<a id="key_debug"></a>

### `<Const>` KEY_DEBUG

**● KEY_DEBUG**: *"$$DEBUG"* = "$$DEBUG"

*Defined in js/js.utils.ts:5*

___
<a id="_function_type"></a>

### `<Const>` _FUNCTION_TYPE

**● _FUNCTION_TYPE**: * "string" &#124; "number" &#124; "boolean" &#124; "symbol" &#124; "undefined" &#124; "object" &#124; "function"
* =  typeof _keys

*Defined in js/js.utils.ts:173*

___
<a id="_undefined_type"></a>

### `<Const>` _UNDEFINED_TYPE

**● _UNDEFINED_TYPE**: * "string" &#124; "number" &#124; "boolean" &#124; "symbol" &#124; "undefined" &#124; "object" &#124; "function"
* =  typeof undefined

*Defined in js/js.utils.ts:172*

___
<a id="_freeze"></a>

### `<Const>` _freeze

**● _freeze**: *`freeze`* =  Object.freeze

*Defined in js/js.utils.ts:12*

___
<a id="_isfrozen"></a>

### `<Const>` _isFrozen

**● _isFrozen**: *`isFrozen`* =  Object.isFrozen

*Defined in js/js.utils.ts:13*

___
<a id="_keys"></a>

### `<Const>` _keys

**● _keys**: *`keys`* =  Object.keys

*Defined in js/js.utils.ts:10*

___

## Functions

<a id="_anytostring"></a>

### `<Const>` _anyToString

▸ **_anyToString**(aValue: *`any`*): `string`

*Defined in js/js.utils.ts:101*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `string`

___
<a id="_arrayequals"></a>

### `<Const>` _arrayEquals

▸ **_arrayEquals**<`T`>(aLeft: *`T`[]*, aRight: *`T`[]*, aPredicate: *[EqualsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`>*): `boolean`

*Defined in js/js.utils.ts:22*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `T`[] |
| aRight | `T`[] |
| aPredicate | [EqualsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`> |

**Returns:** `boolean`

___
<a id="_assertarray"></a>

### `<Const>` _assertArray

▸ **_assertArray**<`T`>(aKey: * `number` &#124; `string` &#124; `symbol`*, aObject: *`any`*): `T`[]

*Defined in js/js.utils.ts:146*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey |  `number` &#124; `string` &#124; `symbol`|
| aObject | `any` |

**Returns:** `T`[]

___
<a id="_assertfromgenerator"></a>

### `<Const>` _assertFromGenerator

▸ **_assertFromGenerator**<`T`>(aKey: * `number` &#124; `string` &#124; `symbol`*, aObject: *`any`*, aGenerator: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>*): `T`

*Defined in js/js.utils.ts:142*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey |  `number` &#124; `string` &#124; `symbol`|
| aObject | `any` |
| aGenerator | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`> |

**Returns:** `T`

___
<a id="_assertobject"></a>

### `<Const>` _assertObject

▸ **_assertObject**<`T`>(aKey: * `number` &#124; `string` &#124; `symbol`*, aObject: *`any`*): `T`

*Defined in js/js.utils.ts:144*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey |  `number` &#124; `string` &#124; `symbol`|
| aObject | `any` |

**Returns:** `T`

___
<a id="_clonedeep"></a>

###  _cloneDeep

▸ **_cloneDeep**(aValue: *`any`*): `any`

*Defined in js/js.utils.ts:123*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `any`

___
<a id="_creategetter"></a>

###  _createGetter

▸ **_createGetter**<`T`>(aGetter: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>*): `PropertyDescriptor`

*Defined in js/js.utils.ts:224*

Constructs a getter description

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aGetter | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`> |  the getter |

**Returns:** `PropertyDescriptor`
the description of the getter

___
<a id="_deepequals"></a>

### `<Const>` _deepEquals

▸ **_deepEquals**(aLeft: *`any`*, aRight: *`any`*): `boolean`

*Defined in js/js.utils.ts:84*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `any` |
| aRight | `any` |

**Returns:** `boolean`

___
<a id="_foreach"></a>

###  _forEach

▸ **_forEach**<`T`>(aArray: *`T`[]*, aConsumer: *[Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`>*): `void`

*Defined in js/js.utils.ts:238*

Just run a callback for each element in an array

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aArray | `T`[] |  the array |
| aConsumer | [Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`> |  consumer callback |

**Returns:** `void`

___
<a id="_forin"></a>

###  _forIn

▸ **_forIn**<`T`>(aObject: *`object`*, aConsumer: *[BiConsumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`, `string`>*): `void`

*Defined in js/js.utils.ts:248*

Run a callback for each key value pair

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aObject | `object` |  the object |
| aConsumer | [BiConsumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`, `string`> |  consumer callback |

**Returns:** `void`

___
<a id="_freezedeep"></a>

###  _freezeDeep

▸ **_freezeDeep**(aValue: *`any`*): `any`

*Defined in js/js.utils.ts:181*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `any`

___
<a id="_lastelement"></a>

### `<Const>` _lastElement

▸ **_lastElement**<`T`>(aArray: *`T`[]*): `T`

*Defined in js/js.utils.ts:148*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aArray | `T`[] |

**Returns:** `T`

___
<a id="_objectassign"></a>

### `<Const>` _objectAssign

▸ **_objectAssign**<`T`,`V`>(aKey: *`string`*, aValue: *`V`*, aObject: *`T`*): `T`

*Defined in js/js.utils.ts:113*

**Type parameters:**

#### T 
#### V 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aValue | `V` |
| aObject | `T` |

**Returns:** `T`

___
<a id="_objectequals"></a>

### `<Const>` _objectEquals

▸ **_objectEquals**(aLeft: *`any`*, aRight: *`any`*, aPredicate: *[EqualsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`any`>*): `boolean`

*Defined in js/js.utils.ts:52*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `any` |
| aRight | `any` |
| aPredicate | [EqualsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`any`> |

**Returns:** `boolean`

___
<a id="_push"></a>

### `<Const>` _push

▸ **_push**<`T`>(aValue: *`T`*, aArray: *`T`[]*): `T`[]

*Defined in js/js.utils.ts:96*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `T` |
| aArray | `T`[] |

**Returns:** `T`[]

___
<a id="_random"></a>

###  _random

▸ **_random**(aMin: *`number`*, aMax: *`number`*): `number`

*Defined in js/js.utils.ts:214*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aMin | `number` |
| aMax | `number` |

**Returns:** `number`

___
<a id="_reduceforin"></a>

###  _reduceForIn

▸ **_reduceForIn**<`T`,`R`>(aObject: *`object`*, aFunction: *`function`*, aInitial: *`R`*): `R`

*Defined in js/js.utils.ts:265*

Run a callback for each key value pair

**Type parameters:**

#### T 
#### R 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aObject | `object` |  the object |
| aFunction | `function` |
| aInitial | `R` |

**Returns:** `R`

___
<a id="_tointeger"></a>

###  _toInteger

▸ **_toInteger**(aValue: *`any`*, aDefault: *`number`*): `number`

*Defined in js/js.utils.ts:156*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |
| aDefault | `number` |

**Returns:** `number`

___


<a name="_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["json/json.utils"](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

# External module: "json/json.utils"

## Index

### Interfaces

* [JsonArray](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)

### Type aliases

* [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
* [JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

### Functions

* [_jsonParse](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
* [_jsonStringify](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

---

## Type aliases

<a id="anyjson"></a>

###  AnyJson

**Ƭ AnyJson**: * `boolean` &#124; `number` &#124; `string` &#124; `null` &#124; [JsonArray](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e) &#124; [JsonMap](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
*

*Defined in json/json.utils.ts:3*

___
<a id="jsonmap"></a>

###  JsonMap

**Ƭ JsonMap**: *`any`*

*Defined in json/json.utils.ts:4*

___

## Functions

<a id="_jsonparse"></a>

### `<Const>` _jsonParse

▸ **_jsonParse**<`T`>(aValue: *`string`*): `T`

*Defined in json/json.utils.ts:7*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `string` |

**Returns:** `T`

___
<a id="_jsonstringify"></a>

### `<Const>` _jsonStringify

▸ **_jsonStringify**(aValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): `string`

*Defined in json/json.utils.ts:8*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** `string`

___


<a name="_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["layouts/layout"](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)

# External module: "layouts/layout"

## Index

### Variables

* [DEFAULT_LAYOUT_MAPPING](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [DEFAULT_LAYOUT_MODE](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_MODE_ERROR](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_MODE_FOOTER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_MODE_HEADER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_MODE_NAVIGATION](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_TEMPLATE_ERROR](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_TEMPLATE_FOOTER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_TEMPLATE_HEADER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_TEMPLATE_NAVIGATION](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_TYPE_ANGULAR](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)

### Object literals

* [LAYOUT_ERROR](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_FOOTER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_HEADER](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* [LAYOUT_NAVIGATION](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)

---

## Variables

<a id="default_layout_mapping"></a>

### `<Const>` DEFAULT_LAYOUT_MAPPING

**● DEFAULT_LAYOUT_MAPPING**: *`object`*

*Defined in layouts/layout.ts:37*

#### Type declaration

[layoutMode: `string`]: `Layout`

___
<a id="default_layout_mode"></a>

### `<Const>` DEFAULT_LAYOUT_MODE

**● DEFAULT_LAYOUT_MODE**: *"default"* = "default"

*Defined in layouts/layout.ts:4*

___
<a id="layout_mode_error"></a>

### `<Const>` LAYOUT_MODE_ERROR

**● LAYOUT_MODE_ERROR**: *"wch-error"* = "wch-error"

*Defined in layouts/layout.ts:10*

___
<a id="layout_mode_footer"></a>

### `<Const>` LAYOUT_MODE_FOOTER

**● LAYOUT_MODE_FOOTER**: *"wch-footer"* = "wch-footer"

*Defined in layouts/layout.ts:9*

___
<a id="layout_mode_header"></a>

### `<Const>` LAYOUT_MODE_HEADER

**● LAYOUT_MODE_HEADER**: *"wch-header"* = "wch-header"

*Defined in layouts/layout.ts:8*

___
<a id="layout_mode_navigation"></a>

### `<Const>` LAYOUT_MODE_NAVIGATION

**● LAYOUT_MODE_NAVIGATION**: *"wch-navigation"* = "wch-navigation"

*Defined in layouts/layout.ts:7*

___
<a id="layout_template_error"></a>

### `<Const>` LAYOUT_TEMPLATE_ERROR

**● LAYOUT_TEMPLATE_ERROR**: *"wch-error"* = "wch-error"

*Defined in layouts/layout.ts:15*

___
<a id="layout_template_footer"></a>

### `<Const>` LAYOUT_TEMPLATE_FOOTER

**● LAYOUT_TEMPLATE_FOOTER**: *"wch-footer"* = "wch-footer"

*Defined in layouts/layout.ts:14*

___
<a id="layout_template_header"></a>

### `<Const>` LAYOUT_TEMPLATE_HEADER

**● LAYOUT_TEMPLATE_HEADER**: *"wch-header"* = "wch-header"

*Defined in layouts/layout.ts:13*

___
<a id="layout_template_navigation"></a>

### `<Const>` LAYOUT_TEMPLATE_NAVIGATION

**● LAYOUT_TEMPLATE_NAVIGATION**: *"wch-navigation"* = "wch-navigation"

*Defined in layouts/layout.ts:12*

___
<a id="layout_type_angular"></a>

### `<Const>` LAYOUT_TYPE_ANGULAR

**● LAYOUT_TYPE_ANGULAR**: *"angular"* = "angular"

*Defined in layouts/layout.ts:5*

___

## Object literals

<a id="layout_error"></a>

### `<Const>` LAYOUT_ERROR

**LAYOUT_ERROR**: *`object`*

*Defined in layouts/layout.ts:32*

<a id="layout_error.template"></a>

####  template

**● template**: *`string`* =  LAYOUT_TEMPLATE_ERROR

*Defined in layouts/layout.ts:34*

___
<a id="layout_error.templatetype"></a>

####  templateType

**● templateType**: *`string`* =  LAYOUT_TYPE_ANGULAR

*Defined in layouts/layout.ts:33*

___

___
<a id="layout_footer"></a>

### `<Const>` LAYOUT_FOOTER

**LAYOUT_FOOTER**: *`object`*

*Defined in layouts/layout.ts:27*

<a id="layout_footer.template-1"></a>

####  template

**● template**: *`string`* =  LAYOUT_TEMPLATE_FOOTER

*Defined in layouts/layout.ts:29*

___
<a id="layout_footer.templatetype-1"></a>

####  templateType

**● templateType**: *`string`* =  LAYOUT_TYPE_ANGULAR

*Defined in layouts/layout.ts:28*

___

___
<a id="layout_header"></a>

### `<Const>` LAYOUT_HEADER

**LAYOUT_HEADER**: *`object`*

*Defined in layouts/layout.ts:22*

<a id="layout_header.template-2"></a>

####  template

**● template**: *`string`* =  LAYOUT_TEMPLATE_HEADER

*Defined in layouts/layout.ts:24*

___
<a id="layout_header.templatetype-2"></a>

####  templateType

**● templateType**: *`string`* =  LAYOUT_TYPE_ANGULAR

*Defined in layouts/layout.ts:23*

___

___
<a id="layout_navigation"></a>

### `<Const>` LAYOUT_NAVIGATION

**LAYOUT_NAVIGATION**: *`object`*

*Defined in layouts/layout.ts:17*

<a id="layout_navigation.template-3"></a>

####  template

**● template**: *`string`* =  LAYOUT_TEMPLATE_NAVIGATION

*Defined in layouts/layout.ts:19*

___
<a id="layout_navigation.templatetype-3"></a>

####  templateType

**● templateType**: *`string`* =  LAYOUT_TYPE_ANGULAR

*Defined in layouts/layout.ts:18*

___

___


<a name="_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["logger/console.logger"](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)

# External module: "logger/console.logger"

## Index

### Variables

* [CONSOLE_ERROR](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* [CONSOLE_INFO](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* [CONSOLE_WARN](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* [_console](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)

### Functions

* [createConsoleLogger](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* [createEmptyLogger](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)

---

## Variables

<a id="console_error"></a>

### `<Const>` CONSOLE_ERROR

**● CONSOLE_ERROR**: *`error`* =  _console.error

*Defined in logger/console.logger.ts:9*

___
<a id="console_info"></a>

### `<Const>` CONSOLE_INFO

**● CONSOLE_INFO**: *`info`* =  _console.info

*Defined in logger/console.logger.ts:8*

___
<a id="console_warn"></a>

### `<Const>` CONSOLE_WARN

**● CONSOLE_WARN**: *`warn`* =  _console.warn

*Defined in logger/console.logger.ts:10*

___
<a id="_console"></a>

### `<Const>` _console

**● _console**: *`Console`* =  console

*Defined in logger/console.logger.ts:7*

___

## Functions

<a id="createconsolelogger"></a>

### `<Const>` createConsoleLogger

▸ **createConsoleLogger**(aName: *`string`*): `object`

*Defined in logger/console.logger.ts:13*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |

**Returns:** `object`

___
<a id="createemptylogger"></a>

### `<Const>` createEmptyLogger

▸ **createEmptyLogger**(aName: *`string`*): `object`

*Defined in logger/console.logger.ts:19*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |

**Returns:** `object`

___


<a name="_98e353213f9cc2221a397c6f11f63e5ce44eb6f9cade1c13cc5caae0f419bb41"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["logger/noop.logger"](#_98e353213f9cc2221a397c6f11f63e5ce44eb6f9cade1c13cc5caae0f419bb41)

# External module: "logger/noop.logger"

## Index

### Object literals

* [NOOP_LOGGER](#_98e353213f9cc2221a397c6f11f63e5ce44eb6f9cade1c13cc5caae0f419bb41)

---

## Object literals

<a id="noop_logger"></a>

### `<Const>` NOOP_LOGGER

**NOOP_LOGGER**: *`object`*

*Defined in logger/noop.logger.ts:7*

Logger that really does not log anything

<a id="noop_logger.error"></a>

####  error

**● error**: *`noop`* =  noop

*Defined in logger/noop.logger.ts:10*

___
<a id="noop_logger.info"></a>

####  info

**● info**: *`noop`* =  noop

*Defined in logger/noop.logger.ts:8*

___
<a id="noop_logger.warn"></a>

####  warn

**● warn**: *`noop`* =  noop

*Defined in logger/noop.logger.ts:9*

___

___


<a name="_cd33d6b69708d7a6c383b5faabace0c44d3cc36d96617836792718f8aff4b154"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["logger/noop.logger.service"](#_cd33d6b69708d7a6c383b5faabace0c44d3cc36d96617836792718f8aff4b154)

# External module: "logger/noop.logger.service"

## Index

### Object literals

* [NOOP_LOGGER_SERVICE](#_cd33d6b69708d7a6c383b5faabace0c44d3cc36d96617836792718f8aff4b154)

---

## Object literals

<a id="noop_logger_service"></a>

### `<Const>` NOOP_LOGGER_SERVICE

**NOOP_LOGGER_SERVICE**: *`object`*

*Defined in logger/noop.logger.service.ts:9*

Fallback logger service that exposes noop loggers
*__returns__*: the service

<a id="noop_logger_service.get"></a>

####  get

▸ **get**(aName: *`string`*): `object`

*Defined in logger/noop.logger.service.ts:10*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |

**Returns:** `object`

___

___


<a name="_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/message.event"](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)

# External module: "messages/message.event"

## Index

### Variables

* [RESPONSE_SUFFIX](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_SUBSCRIPTIONS](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)

### Functions

* [_createMessageHandler](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_createSdkErrorResponse](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_getMessagePort](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_isSdkEvent](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_processMessage](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_registerSubscription](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_sendResponse](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* [_unsubscribe](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)

---

## Variables

<a id="response_suffix"></a>

### `<Const>` RESPONSE_SUFFIX

**● RESPONSE_SUFFIX**: *"Response"* = "Response"

*Defined in messages/message.event.ts:14*

___
<a id="_subscriptions"></a>

### `<Const>` _SUBSCRIPTIONS

**● _SUBSCRIPTIONS**: *`object`*

*Defined in messages/message.event.ts:17*

#### Type declaration

[handle: `string`]: `Subscription`

___

## Functions

<a id="_createmessagehandler"></a>

###  _createMessageHandler

▸ **_createMessageHandler**(aCorsWhitelist: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`PromiseLike`<`string`[]>>*, aMsgHandlers: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`SdkMessageHandler`[]>*, aLogger?: *`Logger`*): `function`

*Defined in messages/message.event.ts:160*

Constructs an event listener that listens for messages

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aCorsWhitelist | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`PromiseLike`<`string`[]>> |  generator that produces a CORS whitelist |
| aMsgHandlers | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`SdkMessageHandler`[]> |  generator that enumerates the set of registered message handlers |
| `Optional` aLogger | `Logger` |

**Returns:** `function`
the listener that can be attached to the window object

___
<a id="_createsdkerrorresponse"></a>

###  _createSdkErrorResponse

▸ **_createSdkErrorResponse**(aEvent: *`SdkMessagePayload`*, aError: *`any`*, aLogger: *`Logger`*): `SdkErrorResponse`

*Defined in messages/message.event.ts:62*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkMessagePayload` |
| aError | `any` |
| aLogger | `Logger` |

**Returns:** `SdkErrorResponse`

___
<a id="_getmessageport"></a>

###  _getMessagePort

▸ **_getMessagePort**(aEvent: *`MessageEvent`*): `MessagePort`

*Defined in messages/message.event.ts:82*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `MessageEvent` |

**Returns:** `MessagePort`

___
<a id="_issdkevent"></a>

###  _isSdkEvent

▸ **_isSdkEvent**(aPayload: *`any`*): `boolean`

*Defined in messages/message.event.ts:49*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `any` |

**Returns:** `boolean`

___
<a id="_processmessage"></a>

###  _processMessage

▸ **_processMessage**(aData: *`SdkMessagePayload`*, aEvent: *`MessageEvent`*, aMsgHandlers: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`SdkMessageHandler`[]>*, aLogger: *`Logger`*):  `PromiseLike`<`SdkMessagePayload`> &#124; `SdkMessagePayload` &#124; `null` &#124; `undefined`

*Defined in messages/message.event.ts:130*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aData | `SdkMessagePayload` |
| aEvent | `MessageEvent` |
| aMsgHandlers | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`SdkMessageHandler`[]> |
| aLogger | `Logger` |

**Returns:**  `PromiseLike`<`SdkMessagePayload`> &#124; `SdkMessagePayload` &#124; `null` &#124; `undefined`

___
<a id="_registersubscription"></a>

###  _registerSubscription

▸ **_registerSubscription**(aSubscription: *`Subscription`*): `string`

*Defined in messages/message.event.ts:36*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aSubscription | `Subscription` |

**Returns:** `string`

___
<a id="_sendresponse"></a>

###  _sendResponse

▸ **_sendResponse**(aResponse: *`any`*, aEvent: *`MessageEvent`*, aLogger: *`Logger`*): `void`

*Defined in messages/message.event.ts:95*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aResponse | `any` |
| aEvent | `MessageEvent` |
| aLogger | `Logger` |

**Returns:** `void`

___
<a id="_unsubscribe"></a>

###  _unsubscribe

▸ **_unsubscribe**(aHandle: *`string`*): `void`

*Defined in messages/message.event.ts:24*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aHandle | `string` |

**Returns:** `void`

___


<a name="_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/navigate.by.path.handler"](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)

# External module: "messages/navigate.by.path.handler"

## Index

### Functions

* [_createSdkNavigateByPathResponse](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)
* [_isSdkNavigateByPathEvent](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)
* [createNavigateByPathHandler](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)

---

## Functions

<a id="_createsdknavigatebypathresponse"></a>

###  _createSdkNavigateByPathResponse

▸ **_createSdkNavigateByPathResponse**(aEvent: *`SdkNavigateByPathEvent`*, aFlag: *`boolean`*, aError?: *`any`*): `SdkNavigateByPathResponse`

*Defined in messages/navigate.by.path.handler.ts:34*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkNavigateByPathEvent` |
| aFlag | `boolean` |
| `Optional` aError | `any` |

**Returns:** `SdkNavigateByPathResponse`

___
<a id="_issdknavigatebypathevent"></a>

###  _isSdkNavigateByPathEvent

▸ **_isSdkNavigateByPathEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/navigate.by.path.handler.ts:20*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createnavigatebypathhandler"></a>

###  createNavigateByPathHandler

▸ **createNavigateByPathHandler**(aNavigate: *`function`*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/navigate.by.path.handler.ts:51*

Executes a navigation event

**Parameters:**

| Param | Type |
| ------ | ------ |
| aNavigate | `function` |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/refresh.handler"](#_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526)

# External module: "messages/refresh.handler"

## Index

### Functions

* [_isSdkRefreshEvent](#_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526)
* [createRefreshHandler](#_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526)

---

## Functions

<a id="_issdkrefreshevent"></a>

###  _isSdkRefreshEvent

▸ **_isSdkRefreshEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/refresh.handler.ts:12*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createrefreshhandler"></a>

###  createRefreshHandler

▸ **createRefreshHandler**(aRefresh: *`function`*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/refresh.handler.ts:20*

Executes a refresh event

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRefresh | `function` |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/set.mode.handler"](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)

# External module: "messages/set.mode.handler"

## Index

### Functions

* [_createSdkSetModeResponse](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)
* [_isProtected](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)
* [_isSdkSetModeEvent](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)
* [createSetModeHandler](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)

---

## Functions

<a id="_createsdksetmoderesponse"></a>

###  _createSdkSetModeResponse

▸ **_createSdkSetModeResponse**(aEvent: *`SdkSetModeEvent`*, aMode: *`SdkMode`*, aError?: *`any`*): `SdkSetModeResponse`

*Defined in messages/set.mode.handler.ts:35*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSetModeEvent` |
| aMode | `SdkMode` |
| `Optional` aError | `any` |

**Returns:** `SdkSetModeResponse`

___
<a id="_isprotected"></a>

###  _isProtected

▸ **_isProtected**(aMode: *`SdkMode`*): `boolean`

*Defined in messages/set.mode.handler.ts:53*

Tests if we need to switch to protected mode

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aMode | `SdkMode` |  the mode |

**Returns:** `boolean`

___
<a id="_issdksetmodeevent"></a>

###  _isSdkSetModeEvent

▸ **_isSdkSetModeEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/set.mode.handler.ts:22*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createsetmodehandler"></a>

###  createSetModeHandler

▸ **createSetModeHandler**(aPublicApiHandler: *[Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`boolean`>*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/set.mode.handler.ts:60*

Executes a navigation event

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPublicApiHandler | [Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`boolean`> |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/subscribe.active.route.handler"](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)

# External module: "messages/subscribe.active.route.handler"

## Index

### Functions

* [_createSdkActiveRouteEvent](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)
* [_createSdkSubscribeActiveRouteEventResponse](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)
* [_isSdkSubscribeActiveRouteEvent](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)
* [createSubscribeActiveRouteHandler](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)

---

## Functions

<a id="_createsdkactiverouteevent"></a>

###  _createSdkActiveRouteEvent

▸ **_createSdkActiveRouteEvent**(aEvent: *`SdkSubscribeActiveRouteEvent`*, aPage?: *`SitePage`*): `SdkActiveRouteEvent`

*Defined in messages/subscribe.active.route.handler.ts:52*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeActiveRouteEvent` |
| `Optional` aPage | `SitePage` |

**Returns:** `SdkActiveRouteEvent`

___
<a id="_createsdksubscribeactiverouteeventresponse"></a>

###  _createSdkSubscribeActiveRouteEventResponse

▸ **_createSdkSubscribeActiveRouteEventResponse**(aEvent: *`SdkSubscribeActiveRouteEvent`*, aHandle: *`string`*): `SdkSubscribeActiveRouteEventResponse`

*Defined in messages/subscribe.active.route.handler.ts:32*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeActiveRouteEvent` |
| aHandle | `string` |

**Returns:** `SdkSubscribeActiveRouteEventResponse`

___
<a id="_issdksubscribeactiverouteevent"></a>

###  _isSdkSubscribeActiveRouteEvent

▸ **_isSdkSubscribeActiveRouteEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/subscribe.active.route.handler.ts:69*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createsubscribeactiveroutehandler"></a>

###  createSubscribeActiveRouteHandler

▸ **createSubscribeActiveRouteHandler**(onActiveRenderingContext: *`Observable`<`RenderingContext`>*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/subscribe.active.route.handler.ts:77*

Subscribes to the active route

**Parameters:**

| Param | Type |
| ------ | ------ |
| onActiveRenderingContext | `Observable`<`RenderingContext`> |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/subscribe.handler"](#_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce)

# External module: "messages/subscribe.handler"

## Index

### Functions

* [_isSdkUnsubscribeEvent](#_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce)
* [createUnsubscribeHandler](#_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce)

---

## Functions

<a id="_issdkunsubscribeevent"></a>

###  _isSdkUnsubscribeEvent

▸ **_isSdkUnsubscribeEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/subscribe.handler.ts:19*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createunsubscribehandler"></a>

###  createUnsubscribeHandler

▸ **createUnsubscribeHandler**(aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/subscribe.handler.ts:27*

Subscribes to a given route

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/subscribe.mode.handler"](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)

# External module: "messages/subscribe.mode.handler"

## Index

### Functions

* [_createSdkModeEvent](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)
* [_createSdkSubscribeModeEventResponse](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)
* [_isSdkSubscribeModeEvent](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)
* [createSubscribeModeHandler](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)

---

## Functions

<a id="_createsdkmodeevent"></a>

###  _createSdkModeEvent

▸ **_createSdkModeEvent**(aEvent: *`SdkSubscribeModeEvent`*, aMode: *`SdkMode`*): `SdkModeEvent`

*Defined in messages/subscribe.mode.handler.ts:50*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeModeEvent` |
| aMode | `SdkMode` |

**Returns:** `SdkModeEvent`

___
<a id="_createsdksubscribemodeeventresponse"></a>

###  _createSdkSubscribeModeEventResponse

▸ **_createSdkSubscribeModeEventResponse**(aEvent: *`SdkSubscribeModeEvent`*, aHandle: *`string`*): `SdkSubscribeModeEventResponse`

*Defined in messages/subscribe.mode.handler.ts:30*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeModeEvent` |
| aHandle | `string` |

**Returns:** `SdkSubscribeModeEventResponse`

___
<a id="_issdksubscribemodeevent"></a>

###  _isSdkSubscribeModeEvent

▸ **_isSdkSubscribeModeEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/subscribe.mode.handler.ts:67*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createsubscribemodehandler"></a>

###  createSubscribeModeHandler

▸ **createSubscribeModeHandler**(onUsePublic: *`Observable`<`boolean`>*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/subscribe.mode.handler.ts:75*

Subscribes to the active route

**Parameters:**

| Param | Type |
| ------ | ------ |
| onUsePublic | `Observable`<`boolean`> |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["messages/subscribe.route.handler"](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)

# External module: "messages/subscribe.route.handler"

## Index

### Functions

* [_createSdkRouteEvent](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)
* [_createSdkSubscribeRouteEventResponse](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)
* [_isSdkSubscribeRouteEvent](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)
* [createSubscribeRouteHandler](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)

---

## Functions

<a id="_createsdkrouteevent"></a>

###  _createSdkRouteEvent

▸ **_createSdkRouteEvent**(aEvent: *`SdkSubscribeRouteEvent`*, aRoute: *`string`*, aPage?: *`SitePage`*): `SdkRouteEvent`

*Defined in messages/subscribe.route.handler.ts:34*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeRouteEvent` |
| aRoute | `string` |
| `Optional` aPage | `SitePage` |

**Returns:** `SdkRouteEvent`

___
<a id="_createsdksubscriberouteeventresponse"></a>

###  _createSdkSubscribeRouteEventResponse

▸ **_createSdkSubscribeRouteEventResponse**(aEvent: *`SdkSubscribeRouteEvent`*, aHandle: *`string`*): `SdkSubscribeRouteEventResponse`

*Defined in messages/subscribe.route.handler.ts:55*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEvent | `SdkSubscribeRouteEvent` |
| aHandle | `string` |

**Returns:** `SdkSubscribeRouteEventResponse`

___
<a id="_issdksubscriberouteevent"></a>

###  _isSdkSubscribeRouteEvent

▸ **_isSdkSubscribeRouteEvent**(aPayload: *`SdkMessagePayload`*): `boolean`

*Defined in messages/subscribe.route.handler.ts:72*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPayload | `SdkMessagePayload` |

**Returns:** `boolean`

___
<a id="createsubscriberoutehandler"></a>

###  createSubscribeRouteHandler

▸ **createSubscribeRouteHandler**(aGetRenderingContextByPath: *`function`*, aLogger?: *`Logger`*): `SdkMessageHandlerCallback`

*Defined in messages/subscribe.route.handler.ts:80*

Subscribes to a given route

**Parameters:**

| Param | Type |
| ------ | ------ |
| aGetRenderingContextByPath | `function` |
| `Optional` aLogger | `Logger` |

**Returns:** `SdkMessageHandlerCallback`

___


<a name="_87db2cbdba9ba53c30678c1ae3b89f921797d847824725865bae172d8e624ed2"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["misc"](#_87db2cbdba9ba53c30678c1ae3b89f921797d847824725865bae172d8e624ed2)

# External module: "misc"

## Index

---


<a name="_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["operators/operators"](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)

# External module: "operators/operators"

## Index

### Variables

* [opBoxLayoutMode](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [opLevels](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)

### Functions

* [deepDistinctUntilChanged](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterArrayOf](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterBoolean](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterNotNil](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterNumber](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterObject](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [filterString](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [pageArrayDistinctUntilChanged](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [pageDistinctUntilChanged](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [pluckApiOrigin](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [pluckCurrentPage](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [pluckDeliveryOrigin](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [shareLast](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* [typedPluck](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)

---

## Variables

<a id="opboxlayoutmode"></a>

### `<Const>` opBoxLayoutMode

**● opBoxLayoutMode**: *`function`* =  map<string, string>(wchBoxLayoutMode)

*Defined in operators/operators.ts:47*

Operator to box the layout mode

#### Type declaration
▸(source: *`T`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| source | `T` |

**Returns:** `R`

___
<a id="oplevels"></a>

### `<Const>` opLevels

**● opLevels**: *`function`* =  map<string | number | null | undefined, number>(aValue => toInteger(aValue, DEFAULT_FETCH_LEVELS))

*Defined in operators/operators.ts:42*

Converts the levels to a valid number value

#### Type declaration
▸(source: *`T`*): `R`

**Parameters:**

| Param | Type |
| ------ | ------ |
| source | `T` |

**Returns:** `R`

___

## Functions

<a id="deepdistinctuntilchanged"></a>

### `<Const>` deepDistinctUntilChanged

▸ **deepDistinctUntilChanged**<`T`>(): `function`

*Defined in operators/operators.ts:16*

**Type parameters:**

#### T 

**Returns:** `function`

___
<a id="filterarrayof"></a>

### `<Const>` filterArrayOf

▸ **filterArrayOf**<`T`>(aPredicate: *[IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`>*): `function`

*Defined in operators/operators.ts:28*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aPredicate | [IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`> |

**Returns:** `function`

___
<a id="filterboolean"></a>

### `<Const>` filterBoolean

▸ **filterBoolean**(): `function`

*Defined in operators/operators.ts:25*

**Returns:** `function`

___
<a id="filternotnil"></a>

### `<Const>` filterNotNil

▸ **filterNotNil**<`T`>(): `function`

*Defined in operators/operators.ts:20*

**Type parameters:**

#### T 

**Returns:** `function`

___
<a id="filternumber"></a>

### `<Const>` filterNumber

▸ **filterNumber**(): `function`

*Defined in operators/operators.ts:26*

**Returns:** `function`

___
<a id="filterobject"></a>

### `<Const>` filterObject

▸ **filterObject**(): `function`

*Defined in operators/operators.ts:27*

**Returns:** `function`

___
<a id="filterstring"></a>

### `<Const>` filterString

▸ **filterString**(): `function`

*Defined in operators/operators.ts:24*

**Returns:** `function`

___
<a id="pagearraydistinctuntilchanged"></a>

### `<Const>` pageArrayDistinctUntilChanged

▸ **pageArrayDistinctUntilChanged**(): `function`

*Defined in operators/operators.ts:18*

**Returns:** `function`

___
<a id="pagedistinctuntilchanged"></a>

### `<Const>` pageDistinctUntilChanged

▸ **pageDistinctUntilChanged**(): `function`

*Defined in operators/operators.ts:17*

**Returns:** `function`

___
<a id="pluckapiorigin"></a>

### `<Const>` pluckApiOrigin

▸ **pluckApiOrigin**(): `function`

*Defined in operators/operators.ts:31*

**Returns:** `function`

___
<a id="pluckcurrentpage"></a>

### `<Const>` pluckCurrentPage

▸ **pluckCurrentPage**(): `function`

*Defined in operators/operators.ts:37*

**Returns:** `function`

___
<a id="pluckdeliveryorigin"></a>

### `<Const>` pluckDeliveryOrigin

▸ **pluckDeliveryOrigin**(): `function`

*Defined in operators/operators.ts:34*

**Returns:** `function`

___
<a id="sharelast"></a>

### `<Const>` shareLast

▸ **shareLast**<`T`>(): `function`

*Defined in operators/operators.ts:19*

**Type parameters:**

#### T 

**Returns:** `function`

___
<a id="typedpluck"></a>

### `<Const>` typedPluck

▸ **typedPluck**<`T`,`K`>(aKey: *`K`*): `function`

*Defined in operators/operators.ts:21*

**Type parameters:**

#### T 
#### K :  `keyof T`
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `K` |

**Returns:** `function`

___


<a name="_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["predicates/predicates"](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)

# External module: "predicates/predicates"

## Index

### Type aliases

* [EqualsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [Predicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)

### Variables

* [EMPTY_PROTOTYPE](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_TO_STRING_FUNCTION](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_TO_STRING_STRING](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_getPrototypeOf](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_toString](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)

### Functions

* [_applyToString](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isAbsoluteUrl](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isArrayOf](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isBoolean](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isDate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isNil](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isNotNil](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isNumber](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isObjectOf](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isObservable](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isParseableAsDate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isPlainObject](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isString](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isStringArray](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* [_isUndefined](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)

---

## Type aliases

<a id="equalspredicate"></a>

###  EqualsPredicate

**Ƭ EqualsPredicate**: *`function`*

*Defined in predicates/predicates.ts:202*

#### Type declaration
▸(aLeft: *`T`*, aRight: *`T`*): `boolean`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `T` |
| aRight | `T` |

**Returns:** `boolean`

___
<a id="ispredicate"></a>

###  IsPredicate

**Ƭ IsPredicate**: *`function`*

*Defined in predicates/predicates.ts:135*

#### Type declaration
▸(aValue: *`any`*): `boolean`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="predicate"></a>

###  Predicate

**Ƭ Predicate**: *`function`*

*Defined in predicates/predicates.ts:200*

#### Type declaration
▸(aValue: *`T`*): `boolean`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `T` |

**Returns:** `boolean`

___

## Variables

<a id="empty_prototype"></a>

### `<Const>` EMPTY_PROTOTYPE

**● EMPTY_PROTOTYPE**: *`any`* =  _getPrototypeOf({})

*Defined in predicates/predicates.ts:104*

___
<a id="_to_string_function"></a>

### `<Const>` _TO_STRING_FUNCTION

**● _TO_STRING_FUNCTION**: *`string`* =  _applyToString(_applyToString)

*Defined in predicates/predicates.ts:31*

___
<a id="_to_string_string"></a>

### `<Const>` _TO_STRING_STRING

**● _TO_STRING_STRING**: *`string`* =  _applyToString('')

*Defined in predicates/predicates.ts:26*

___
<a id="_getprototypeof"></a>

### `<Const>` _getPrototypeOf

**● _getPrototypeOf**: *`getPrototypeOf`* =  Object.getPrototypeOf

*Defined in predicates/predicates.ts:103*

___
<a id="_tostring"></a>

### `<Const>` _toString

**● _toString**: *`toString`* =  Object.prototype.toString

*Defined in predicates/predicates.ts:11*

___

## Functions

<a id="_applytostring"></a>

###  _applyToString

▸ **_applyToString**(aValue: *`any`*): `string`

*Defined in predicates/predicates.ts:19*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `string`

___
<a id="_isabsoluteurl"></a>

###  _isAbsoluteUrl

▸ **_isAbsoluteUrl**(aUrl: *`string`*): `boolean`

*Defined in predicates/predicates.ts:131*

Tests if a URL is an absolute URL

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aUrl | `string` |  the URL string |

**Returns:** `boolean`
true if the URL is absolute, else false

___
<a id="_isarrayof"></a>

###  _isArrayOf

▸ **_isArrayOf**<`T`>(aValue: *`any`*, aPredicate: *[IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`>*): `boolean`

*Defined in predicates/predicates.ts:145*

Tests if all elements of the array are of a particular type

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value to test |
| aPredicate | [IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`> |  the predicate to test each element with |

**Returns:** `boolean`
true if the value is an array and all elements are of the specific type

___
<a id="_isboolean"></a>

###  _isBoolean

▸ **_isBoolean**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:68*

Tests if a value is a boolean value

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value |

**Returns:** `boolean`
true if the value is boolean, else false

___
<a id="_isdate"></a>

###  _isDate

▸ **_isDate**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:58*

Tests if a value is a date

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value |

**Returns:** `boolean`
true if the value is date, else false

___
<a id="_isnil"></a>

###  _isNil

▸ **_isNil**(aObject: *`any`*): `boolean`

*Defined in predicates/predicates.ts:89*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** `boolean`

___
<a id="_isnotnil"></a>

###  _isNotNil

▸ **_isNotNil**(aObject: *`any`*): `boolean`

*Defined in predicates/predicates.ts:99*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** `boolean`

___
<a id="_isnumber"></a>

###  _isNumber

▸ **_isNumber**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:48*

Tests if a value is a number value

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value |

**Returns:** `boolean`
true if the value is number, else false

___
<a id="_isobjectof"></a>

###  _isObjectOf

▸ **_isObjectOf**<`T`>(aValue: *`any`*, aPredicate: *[IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`>*): `boolean`

*Defined in predicates/predicates.ts:170*

Tests if all fields of an object are of a particular type

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value to test |
| aPredicate | [IsPredicate](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)<`T`> |  the predicate to test each element with |

**Returns:** `boolean`
true if the value is an array and all elements are of the specific type

___
<a id="_isobservable"></a>

###  _isObservable

▸ **_isObservable**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:121*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isparseableasdate"></a>

###  _isParseableAsDate

▸ **_isParseableAsDate**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:195*

Tests if all fields of an object are of a particular type

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value to test |

**Returns:** `boolean`
true if the value is an array and all elements are of the specific type

___
<a id="_isplainobject"></a>

###  _isPlainObject

▸ **_isPlainObject**(aObject: *`any`*): `boolean`

*Defined in predicates/predicates.ts:111*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** `boolean`

___
<a id="_isstring"></a>

###  _isString

▸ **_isString**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:38*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:** `boolean`

___
<a id="_isstringarray"></a>

###  _isStringArray

▸ **_isStringArray**(aValue: *`any`*): `boolean`

*Defined in predicates/predicates.ts:158*

Tests if all elements of the array are of type string

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |  the value to test |

**Returns:** `boolean`
true if the value is an array and all elements are of the specific type

___
<a id="_isundefined"></a>

###  _isUndefined

▸ **_isUndefined**(aObject: *`any`*): `boolean`

*Defined in predicates/predicates.ts:78*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aObject | `any` |

**Returns:** `boolean`

___


<a name="_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering"](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)

# External module: "rendering/rendering"

## Index

### Enumerations

* [HandlerKind](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)

### Type aliases

* [ExpressionGetter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [HandlerType](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)

### Variables

* [KEY_EXPRESSION](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [PROPERTY_REGEX](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_ELEMENTS](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_ELEMENT_TYPE](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_EXTRACTORS](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_HANDLERS](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_HANDLER_KEYS](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_VALUE](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_VALUES](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_ignoreElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [categoryConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [dateConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [identityConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [identityExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)

### Functions

* [_addTypings](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_categoryElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_dateElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_decodeExpression](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_extractAndConvert](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_getExpressionFromAccessor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_getExpressionFromProperty](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_groupElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_handleElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_parseCategories](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_parseCategory](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_parseDate](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_pluralize](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_setMultiValue](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_setSingleValue](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_valueValuesElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_valueValuesElements](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_valuesElement](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [_valuesElements](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [groupConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [groupReducer](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [valueValuesExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* [valuesExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)

---

## Type aliases

<a id="expressiongetter"></a>

###  ExpressionGetter

**Ƭ ExpressionGetter**: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`string`>*

*Defined in rendering/rendering.ts:376*

___
<a id="handlertype"></a>

###  HandlerType

**Ƭ HandlerType**: *`function`*

*Defined in rendering/rendering.ts:185*

#### Type declaration
▸(aName: *`string`*, aElement: *`any`*, aRenderingContext: *`any`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |
| aElement | `any` |
| aRenderingContext | `any` |

**Returns:** `void`

___
<a id="valueconverter"></a>

###  ValueConverter

**Ƭ ValueConverter**: *`UnaryFunction`<`T`, `R`>*

*Defined in rendering/rendering.ts:93*

Converts a value

___
<a id="valueextractor"></a>

###  ValueExtractor

**Ƭ ValueExtractor**: *`UnaryFunction`<`any`,  `T` &#124; `T`[] &#124; `null`>*

*Defined in rendering/rendering.ts:34*

Function that extracts a value

___

## Variables

<a id="key_expression"></a>

### `<Const>` KEY_EXPRESSION

**● KEY_EXPRESSION**: *"45b01348-de92-44a0-8103-7b7dc471ad8c"* = "45b01348-de92-44a0-8103-7b7dc471ad8c"

*Defined in rendering/rendering.ts:373*

___
<a id="property_regex"></a>

### `<Const>` PROPERTY_REGEX

**● PROPERTY_REGEX**: *`RegExp`* =  /^([^\[]+)(\[\d+\])?$/

*Defined in rendering/rendering.ts:413*

___
<a id="_elements"></a>

### `<Const>` _ELEMENTS

**● _ELEMENTS**: *"elements"* = "elements"

*Defined in rendering/rendering.ts:26*

___
<a id="_element_type"></a>

### `<Const>` _ELEMENT_TYPE

**● _ELEMENT_TYPE**: *"elementType"* = "elementType"

*Defined in rendering/rendering.ts:29*

___
<a id="_extractors"></a>

### `<Const>` _EXTRACTORS

**● _EXTRACTORS**: *`object`*

*Defined in rendering/rendering.ts:39*

extractors

#### Type declaration

[key: `string`]: [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`any`>

___
<a id="_handlers"></a>

### `<Const>` _HANDLERS

**● _HANDLERS**: *`object`*

*Defined in rendering/rendering.ts:201*

#### Type declaration

[key: `string`]: [HandlerType](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)

___
<a id="_handler_keys"></a>

### `<Const>` _HANDLER_KEYS

**● _HANDLER_KEYS**: *`object`*

*Defined in rendering/rendering.ts:212*

Records the keys of the registered handlers

#### Type declaration

[key: `string`]: [HandlerKind](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)

___
<a id="_value"></a>

### `<Const>` _VALUE

**● _VALUE**: *"value"* = "value"

*Defined in rendering/rendering.ts:28*

___
<a id="_values"></a>

### `<Const>` _VALUES

**● _VALUES**: *"values"* = "values"

*Defined in rendering/rendering.ts:27*

___
<a id="_ignoreelement"></a>

### `<Const>` _ignoreElement

**● _ignoreElement**: *`noop`* =  noop

*Defined in rendering/rendering.ts:300*

___
<a id="categoryconverter"></a>

### `<Const>` categoryConverter

**● categoryConverter**: *[_parseCategories](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)* =  _parseCategories

*Defined in rendering/rendering.ts:108*

Converts a category to a parsed category object

___
<a id="dateconverter"></a>

### `<Const>` dateConverter

**● dateConverter**: *[_parseDate]()* =  _parseDate

*Defined in rendering/rendering.ts:103*

Converts a value to a date object

___
<a id="identityconverter"></a>

### `<Const>` identityConverter

**● identityConverter**: *`identity`* =  identity

*Defined in rendering/rendering.ts:98*

Identity conversion

___
<a id="identityextractor"></a>

### `<Const>` identityExtractor

**● identityExtractor**: *`identity`* =  identity

*Defined in rendering/rendering.ts:68*

Nothing to do for extraction

___

## Functions

<a id="_addtypings"></a>

###  _addTypings

▸ **_addTypings**(aRenderingContext: *`RenderingContext`*): `RenderingContext`

*Defined in rendering/rendering.ts:332*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext` |

**Returns:** `RenderingContext`

___
<a id="_categoryelement"></a>

###  _categoryElement

▸ **_categoryElement**(): `void`

*Defined in rendering/rendering.ts:285*

**Returns:** `void`

___
<a id="_dateelement"></a>

### `<Const>` _dateElement

▸ **_dateElement**(): `void`

*Defined in rendering/rendering.ts:279*

**Returns:** `void`

___
<a id="_decodeexpression"></a>

###  _decodeExpression

▸ **_decodeExpression**(aExpression: *`string`*): `string`

*Defined in rendering/rendering.ts:345*

Decodes the expression back to an expression into elements

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aExpression | `string` |  the original expression |

**Returns:** `string`
the decoded expression

___
<a id="_extractandconvert"></a>

###  _extractAndConvert

▸ **_extractAndConvert**<`T`,`R`>(aExtractor: *[ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`>*, aConverter: *[ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`>*): [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`R`>

*Defined in rendering/rendering.ts:158*

Returns a combined function that extracts a value and converts it

**Type parameters:**

#### T 
#### R 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aExtractor | [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`> |  the extractor function |
| aConverter | [ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`> |  the converter |

**Returns:** [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`R`>
the function

___
<a id="_getexpressionfromaccessor"></a>

###  _getExpressionFromAccessor

▸ **_getExpressionFromAccessor**(aPrototype: *`any`*, aAccessor: *`string`*):  `string` &#124; `undefined`

*Defined in rendering/rendering.ts:423*

Tranlates the accessor to an expression

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aPrototype | `any` |  the object |
| aAccessor | `string` |  the accessor string, possibly indexed |

**Returns:**  `string` &#124; `undefined`

the accessor expression, relative to the rendering context

___
<a id="_getexpressionfromproperty"></a>

###  _getExpressionFromProperty

▸ **_getExpressionFromProperty**(aPrototype: *`any`*, aPropertyKey: *`string`*):  `string` &#124; `null` &#124; `undefined`

*Defined in rendering/rendering.ts:387*

Returns the property binding expression from the getter of a property. A property is always bound to a top level element, NOT to an inner value of a group expression.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aPrototype | `any` |  the prototype object |
| aPropertyKey | `string` |  the property key |

**Returns:**  `string` &#124; `null` &#124; `undefined`

the expression or undefined if it does not exist

___
<a id="_groupelement"></a>

### `<Const>` _groupElement

▸ **_groupElement**(): `void`

*Defined in rendering/rendering.ts:273*

**Returns:** `void`

___
<a id="_handleelement"></a>

###  _handleElement

▸ **_handleElement**<`T`,`R`>(aSingleType: *`string`*, aMultiType: *`string`*, aName: *`string`*, aElement: *`any`*, aRenderingContext: *`any`*, aExtractor: *[ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`>*): `void`

*Defined in rendering/rendering.ts:171*

**Type parameters:**

#### T 
#### R 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aSingleType | `string` |
| aMultiType | `string` |
| aName | `string` |
| aElement | `any` |
| aRenderingContext | `any` |
| aExtractor | [ValueExtractor](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`> |

**Returns:** `void`

___
<a id="_parsecategories"></a>

###  _parseCategories

▸ **_parseCategories**(aCategory: *`any`*): `CategoryElement`

*Defined in rendering/rendering.ts:58*

Parses a category element by adding a parsed value

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aCategory | `any` |  the category |

**Returns:** `CategoryElement`
the augmented category

___
<a id="_parsecategory"></a>

### `<Const>` _parseCategory

▸ **_parseCategory**(aCategory: *`string`*): `string`[]

*Defined in rendering/rendering.ts:50*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aCategory | `string` |

**Returns:** `string`[]

___
<a id="_parsedate"></a>

### `<Const>` _parseDate

▸ **_parseDate**(aValue: * `number` &#124; `string` &#124; `Date`*): `Date`

*Defined in rendering/rendering.ts:47*

Decodes a value into a date object

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue |  `number` &#124; `string` &#124; `Date`|  the value |

**Returns:** `Date`
the object

___
<a id="_pluralize"></a>

###  _pluralize

▸ **_pluralize**(aValue: *`string`*): `string`

*Defined in rendering/rendering.ts:193*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `string` |

**Returns:** `string`

___
<a id="_setmultivalue"></a>

###  _setMultiValue

▸ **_setMultiValue**<`T`>(aName: *`string`*, aValue: *`T`[]*, aSingleType: *`string`*, aMultiType: *`string`*, aRenderingContext: *`any`*): `void`

*Defined in rendering/rendering.ts:141*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |
| aValue | `T`[] |
| aSingleType | `string` |
| aMultiType | `string` |
| aRenderingContext | `any` |

**Returns:** `void`

___
<a id="_setsinglevalue"></a>

###  _setSingleValue

▸ **_setSingleValue**<`T`>(aName: *`string`*, aValue: *`T`*, aSingleType: *`string`*, aMultiType: *`string`*, aRenderingContext: *`any`*): `void`

*Defined in rendering/rendering.ts:125*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aName | `string` |
| aValue | `T` |
| aSingleType | `string` |
| aMultiType | `string` |
| aRenderingContext | `any` |

**Returns:** `void`

___
<a id="_valuevalueselement"></a>

###  _valueValuesElement

▸ **_valueValuesElement**<`T`,`R`>(aType: *`string`*, aConverter: *[ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`>*): `void`

*Defined in rendering/rendering.ts:219*

**Type parameters:**

#### T 
#### R 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aType | `string` |
| aConverter | [ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`> |

**Returns:** `void`

___
<a id="_valuevalueselements"></a>

### `<Const>` _valueValuesElements

▸ **_valueValuesElements**(aTypes: *`string`[]*): `void`

*Defined in rendering/rendering.ts:261*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aTypes | `string`[] |

**Returns:** `void`

___
<a id="_valueselement"></a>

###  _valuesElement

▸ **_valuesElement**<`T`,`R`>(aType: *`string`*, aConverter: *[ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`>*): `void`

*Defined in rendering/rendering.ts:240*

**Type parameters:**

#### T 
#### R 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aType | `string` |
| aConverter | [ValueConverter](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)<`T`, `R`> |

**Returns:** `void`

___
<a id="_valueselements"></a>

### `<Const>` _valuesElements

▸ **_valuesElements**(aTypes: *`string`[]*): `void`

*Defined in rendering/rendering.ts:268*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aTypes | `string`[] |

**Returns:** `void`

___
<a id="groupconverter"></a>

### `<Const>` groupConverter

▸ **groupConverter**(aGroupElement: *`any`*): `any`

*Defined in rendering/rendering.ts:114*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aGroupElement | `any` |

**Returns:** `any`

___
<a id="groupreducer"></a>

### `<Const>` groupReducer

▸ **groupReducer**(res: *`any`*, el: *`any`*, name: *`any`*): `any`

*Defined in rendering/rendering.ts:113*

Converts a group element into a simpler structure

**Parameters:**

| Param | Type |
| ------ | ------ |
| res | `any` |
| el | `any` |
| name | `any` |

**Returns:** `any`

___
<a id="valuevaluesextractor"></a>

###  valueValuesExtractor

▸ **valueValuesExtractor**(aValue: *`any`*):  `any` &#124; `any`[]

*Defined in rendering/rendering.ts:75*

Extracts the 'values' field if it is an array, else the 'value' field

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |   |

**Returns:**  `any` &#124; `any`[]

___
<a id="valuesextractor"></a>

###  valuesExtractor

▸ **valuesExtractor**(aValue: *`any`*):  `any` &#124; `any`[]

*Defined in rendering/rendering.ts:85*

Extracts the 'values' field if it is an array, else the object itself

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aValue | `any` |   |

**Returns:**  `any` &#124; `any`[]

___


<a name="_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rx/rx.utils"](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)

# External module: "rx/rx.utils"

## Index

### Classes

* [IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

### Variables

* [EMPTY_JSON_OBSERVABLE](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [EMPTY_STRING_OBSERVABLE](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [idleFrameScheduler](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)

### Functions

* [_createConsumer](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_createGetter](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_createSetter](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_createSingleSubject](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_generateItem](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_safeUnsubscribe](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_safeUnsubscribeAll](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_thisThenThat](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* [_thisThenThats](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)

---

## Variables

<a id="empty_json_observable"></a>

### `<Const>` EMPTY_JSON_OBSERVABLE

**● EMPTY_JSON_OBSERVABLE**: *`Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>* =  empty()

*Defined in rx/rx.utils.ts:217*

___
<a id="empty_string_observable"></a>

### `<Const>` EMPTY_STRING_OBSERVABLE

**● EMPTY_STRING_OBSERVABLE**: *`Observable`<`string`>* =  empty()

*Defined in rx/rx.utils.ts:212*

___
<a id="idleframescheduler-1"></a>

### `<Const>` idleFrameScheduler

**● idleFrameScheduler**: *`IScheduler`* =  new IdleFrameScheduler(IdleFrameAction)

*Defined in rx/rx.utils.ts:137*

___

## Functions

<a id="_createconsumer"></a>

###  _createConsumer

▸ **_createConsumer**<`T`>(aSubject: * `Subject`<`T`> &#124; `Observer`<`T`>*): [Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`>

*Defined in rx/rx.utils.ts:31*

Binds to the next function of a subject

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSubject |  `Subject`<`T`> &#124; `Observer`<`T`>|  the subject that handles the events |

**Returns:** [Consumer](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)<`T`>
the binding function

___
<a id="_creategetter"></a>

###  _createGetter

▸ **_createGetter**<`T`>(aObservable: *`Observable`<`T`>*, aInitial?: *`T`*): `PropertyDescriptor`

*Defined in rx/rx.utils.ts:56*

Constructs a getter description

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aObservable | `Observable`<`T`> |  the observable that handles the getter events |
| `Optional` aInitial | `T` |  a potential initial value |

**Returns:** `PropertyDescriptor`
the description of the getter

___
<a id="_createsetter"></a>

###  _createSetter

▸ **_createSetter**<`T`>(aSubject: *`Subject`<`T`>*): `PropertyDescriptor`

*Defined in rx/rx.utils.ts:41*

Constructs a setter description

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSubject | `Subject`<`T`> |  the subject that handles the setter events |

**Returns:** `PropertyDescriptor`
the description of the setter

___
<a id="_createsinglesubject"></a>

###  _createSingleSubject

▸ **_createSingleSubject**<`T`>(): `ReplaySubject`<`T`>

*Defined in rx/rx.utils.ts:187*

Constructs a singe replay subject

**Type parameters:**

#### T 

**Returns:** `ReplaySubject`<`T`>
the subject

___
<a id="_generateitem"></a>

###  _generateItem

▸ **_generateItem**<`T`>(aGenerator: *[Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`>*): `Observable`<`T`>

*Defined in rx/rx.utils.ts:198*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aGenerator | [Generator](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)<`T`> |

**Returns:** `Observable`<`T`>

___
<a id="_safeunsubscribe"></a>

###  _safeUnsubscribe

▸ **_safeUnsubscribe**(aSubscription: * `Subscription` &#124; `null` &#124; `undefined`*): `void`

*Defined in rx/rx.utils.ts:223*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aSubscription |  `Subscription` &#124; `null` &#124; `undefined`|

**Returns:** `void`

___
<a id="_safeunsubscribeall"></a>

###  _safeUnsubscribeAll

▸ **_safeUnsubscribeAll**(aSubscriptions: * `Subscription`[] &#124; `null` &#124; `undefined`*): `void`

*Defined in rx/rx.utils.ts:233*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aSubscriptions |  `Subscription`[] &#124; `null` &#124; `undefined`|

**Returns:** `void`

___
<a id="_thisthenthat"></a>

###  _thisThenThat

▸ **_thisThenThat**<`T`>(aFirst: *`Observable`<`T`>*, aNext: *`Observable`<`T`>*): `Observable`<`T`>

*Defined in rx/rx.utils.ts:148*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aFirst | `Observable`<`T`> |
| aNext | `Observable`<`T`> |

**Returns:** `Observable`<`T`>

___
<a id="_thisthenthats"></a>

###  _thisThenThats

▸ **_thisThenThats**<`T`>(...aObservables: *`Observable`<`T`>[]*): `Observable`<`T`>

*Defined in rx/rx.utils.ts:176*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| `Rest` aObservables | `Observable`<`T`>[] |

**Returns:** `Observable`<`T`>

___


<a name="_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["search/search.utils"](#_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311)

# External module: "search/search.utils"

## Index

### Functions

* [_escapeKeyValue](#_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311)
* [_escapeTerm](#_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311)

---

## Functions

<a id="_escapekeyvalue"></a>

###  _escapeKeyValue

▸ **_escapeKeyValue**(aKey: *`string`*, aTerm: *`string`*): `string`

*Defined in search/search.utils.ts:12*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aTerm | `string` |

**Returns:** `string`

___
<a id="_escapeterm"></a>

###  _escapeTerm

▸ **_escapeTerm**(aTerm: *`string`*): `string`

*Defined in search/search.utils.ts:8*

Escapes a term according to lucence syntax

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aTerm | `string` |   |

**Returns:** `string`

___


<a name="_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)

# External module: "site/site.utils"

## Index

### Classes

* [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)
* [SiteInformation](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

### Interfaces

* [AnalysisContext](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)
* [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)
* [SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)

### Type aliases

* [ChangeNotification](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)

### Variables

* [IGNORED_SITE_PAGE_FIELDS](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [LOGGER](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [NO_ID](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [UNKNKOWN_ID](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_assign](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_decodeURIComponent](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_encodeURIComponent](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)

### Functions

* [_cloneSitePage](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_createPartialSiteContextForSitePage](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_createSiteContextFromSearchResult](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_getEncodedPath](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_getPage](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_getSiteURL](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_pageArrayEquals](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_pageEquals](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [_siteContextEquals](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [access](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [analyzeSite](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [cloneSiteInfo](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [dispatchError](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [doDispatchError](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [doMarkComplete](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [doMarkUnused](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [markComplete](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [markUnused](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [registerAsync](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* [registerSync](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)

---

## Type aliases

<a id="changenotification"></a>

###  ChangeNotification

**Ƭ ChangeNotification**: *`function`*

*Defined in site/site.utils.ts:105*

#### Type declaration
▸(): `void`

**Returns:** `void`

___

## Variables

<a id="ignored_site_page_fields"></a>

### `<Const>` IGNORED_SITE_PAGE_FIELDS

**● IGNORED_SITE_PAGE_FIELDS**: *`string`[]* =  ['children']

*Defined in site/site.utils.ts:218*

Listing of fields NOT copy from a site page

___
<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"SiteUtils"* = "SiteUtils"

*Defined in site/site.utils.ts:82*

___
<a id="no_id"></a>

### `<Const>` NO_ID

**● NO_ID**: *`string`* =  null

*Defined in site/site.utils.ts:102*

___
<a id="unknkown_id"></a>

### `<Const>` UNKNKOWN_ID

**● UNKNKOWN_ID**: *`string`* =  undefined

*Defined in site/site.utils.ts:97*

___
<a id="_assign"></a>

### `<Const>` _assign

**● _assign**: *`assign`* =  Object.assign

*Defined in site/site.utils.ts:15*

___
<a id="_decodeuricomponent"></a>

### `<Const>` _decodeURIComponent

**● _decodeURIComponent**: *`decodeURIComponent`* =  decodeURIComponent

*Defined in site/site.utils.ts:13*

___
<a id="_encodeuricomponent"></a>

### `<Const>` _encodeURIComponent

**● _encodeURIComponent**: *`encodeURIComponent`* =  encodeURIComponent

*Defined in site/site.utils.ts:14*

___

## Functions

<a id="_clonesitepage"></a>

###  _cloneSitePage

▸ **_cloneSitePage**(aSitePage: *`SitePage`*): `SitePage`

*Defined in site/site.utils.ts:226*

Performs a shallow clone of a site page

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSitePage | `SitePage` |  the site page |

**Returns:** `SitePage`
the cloned page

___
<a id="_createpartialsitecontextforsitepage"></a>

###  _createPartialSiteContextForSitePage

▸ **_createPartialSiteContextForSitePage**(aPage: *`SitePage`*, aSite: *`Site`*): `SiteContext`

*Defined in site/site.utils.ts:468*

Returns the partial rendering context for a site page

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aPage | `SitePage` |  the site page |
| aSite | `Site` |  the site |

**Returns:** `SiteContext`
the context

___
<a id="_createsitecontextfromsearchresult"></a>

###  _createSiteContextFromSearchResult

▸ **_createSiteContextFromSearchResult**(aPage: *`SitePage`*, aSearchResult: *`SitePage`[]*, aSite: *`Site`*): `SiteContext`

*Defined in site/site.utils.ts:488*

Decomposes a search result into a site context structure

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aPage | `SitePage` |  the page in question |
| aSearchResult | `SitePage`[] |  the search result |
| aSite | `Site` |  the site object |

**Returns:** `SiteContext`
the site context

___
<a id="_getencodedpath"></a>

###  _getEncodedPath

▸ **_getEncodedPath**(aPath: *`string`*): `string`

*Defined in site/site.utils.ts:65*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |

**Returns:** `string`

___
<a id="_getpage"></a>

###  _getPage

▸ **_getPage**(aRenderingContext: *`RenderingContext`*): `SitePage`

*Defined in site/site.utils.ts:23*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext` |

**Returns:** `SitePage`

___
<a id="_getsiteurl"></a>

###  _getSiteURL

▸ **_getSiteURL**(aBaseUrl: *`string`*, aSiteID?: *`string`*): `string`

*Defined in site/site.utils.ts:530*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseUrl | `string` |
| `Optional` aSiteID | `string` |

**Returns:** `string`

___
<a id="_pagearrayequals"></a>

###  _pageArrayEquals

▸ **_pageArrayEquals**(aLeft: *`SitePage`[]*, aRight: *`SitePage`[]*): `boolean`

*Defined in site/site.utils.ts:76*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `SitePage`[] |
| aRight | `SitePage`[] |

**Returns:** `boolean`

___
<a id="_pageequals"></a>

###  _pageEquals

▸ **_pageEquals**(aLeft: *`SitePage`*, aRight: *`SitePage`*): `boolean`

*Defined in site/site.utils.ts:44*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `SitePage` |
| aRight | `SitePage` |

**Returns:** `boolean`

___
<a id="_sitecontextequals"></a>

###  _siteContextEquals

▸ **_siteContextEquals**(aLeft: *`SiteContext`*, aRight: *`SiteContext`*): `boolean`

*Defined in site/site.utils.ts:136*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLeft | `SiteContext` |
| aRight | `SiteContext` |

**Returns:** `boolean`

___
<a id="access"></a>

###  access

▸ **access**<`T`>(aKey: *`string`*, aDefault: * `T` &#124; `null` &#124; `undefined`*, aMapping: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*): `BehaviorSubject`< `T` &#124; `null` &#124; `undefined`>

*Defined in site/site.utils.ts:326*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aDefault |  `T` &#124; `null` &#124; `undefined`|
| aMapping | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |

**Returns:** `BehaviorSubject`< `T` &#124; `null` &#124; `undefined`>

___
<a id="analyzesite"></a>

###  analyzeSite

▸ **analyzeSite**(aBreadcrumb: *`SitePage`[]*, aParentPage: *`SitePage`*, aChildren: *`SiteChild`[]*, aContext: *[AnalysisContext](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)*): `SitePage`[]

*Defined in site/site.utils.ts:244*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBreadcrumb | `SitePage`[] |
| aParentPage | `SitePage` |
| aChildren | `SiteChild`[] |
| aContext | [AnalysisContext](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2) |

**Returns:** `SitePage`[]

___
<a id="clonesiteinfo"></a>

###  cloneSiteInfo

▸ **cloneSiteInfo**(aInfo: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*): [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)

*Defined in site/site.utils.ts:147*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aInfo | [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144) |

**Returns:** [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)

___
<a id="dispatcherror"></a>

###  dispatchError

▸ **dispatchError**(aInfo: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*, aError: *`any`*): `void`

*Defined in site/site.utils.ts:321*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aInfo | [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144) |
| aError | `any` |

**Returns:** `void`

___
<a id="dodispatcherror"></a>

###  doDispatchError

▸ **doDispatchError**<`T`>(aMapping: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*, aError: *`any`*): `void`

*Defined in site/site.utils.ts:313*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aMapping | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |
| aError | `any` |

**Returns:** `void`

___
<a id="domarkcomplete"></a>

###  doMarkComplete

▸ **doMarkComplete**<`T`>(aMapping: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*): `void`

*Defined in site/site.utils.ts:300*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aMapping | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |

**Returns:** `void`

___
<a id="domarkunused"></a>

###  doMarkUnused

▸ **doMarkUnused**<`T`>(aMapping: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*, aValue: * `T` &#124; `null` &#124; `undefined`*): `void`

*Defined in site/site.utils.ts:287*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aMapping | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |
| aValue |  `T` &#124; `null` &#124; `undefined`|

**Returns:** `void`

___
<a id="markcomplete"></a>

###  markComplete

▸ **markComplete**(aInfo: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*): `void`

*Defined in site/site.utils.ts:308*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aInfo | [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144) |

**Returns:** `void`

___
<a id="markunused"></a>

###  markUnused

▸ **markUnused**(aInfo: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*): `void`

*Defined in site/site.utils.ts:295*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aInfo | [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144) |

**Returns:** `void`

___
<a id="registerasync"></a>

###  registerAsync

▸ **registerAsync**<`T`>(aKey: *`string`*, aContext: *`T`*, aOldMap: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*, aNewMap: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`>*, aNotifications: *[ChangeNotification](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)[]*): `void`

*Defined in site/site.utils.ts:167*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aContext | `T` |
| aOldMap | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |
| aNewMap | [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`T`> |
| aNotifications | [ChangeNotification](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)[] |

**Returns:** `void`

___
<a id="registersync"></a>

###  registerSync

▸ **registerSync**<`T`>(aKey: *`string`*, aContext: *`T`*, aOldMap: *[SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)<`T`>*, aNewMap: *[SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)<`T`>*): `void`

*Defined in site/site.utils.ts:206*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aContext | `T` |
| aOldMap | [SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)<`T`> |
| aNewMap | [SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)<`T`> |

**Returns:** `void`

___


<a name="_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/sites.constants"](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)

# External module: "site/sites.constants"

## Index

### Variables

* [_DEFAULT_SITE](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)
* [_EMPTY_SITE](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)
* [_EMPTY_SITE_CONTEXT](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)
* [_UNDEFINED_SITE_CONTEXT](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)

---

## Variables

<a id="_default_site"></a>

### `<Const>` _DEFAULT_SITE

**● _DEFAULT_SITE**: *"default"* = "default"

*Defined in site/sites.constants.ts:5*

___
<a id="_empty_site"></a>

### `<Const>` _EMPTY_SITE

**● _EMPTY_SITE**: *`Site`* =  freezeDeep({
    pages: [],
    id: null
})

*Defined in site/sites.constants.ts:7*

___
<a id="_empty_site_context"></a>

### `<Const>` _EMPTY_SITE_CONTEXT

**● _EMPTY_SITE_CONTEXT**: *`SiteContext`* =  freezeDeep({
    parent: undefined,
    sibling: [],
    breadcrumb: [],
    children: [],
    site: _EMPTY_SITE
})

*Defined in site/sites.constants.ts:12*

___
<a id="_undefined_site_context"></a>

### `<Const>` _UNDEFINED_SITE_CONTEXT

**● _UNDEFINED_SITE_CONTEXT**: *`SiteContext`* =  freezeDeep({
    parent: undefined,
    sibling: [],
    breadcrumb: [],
    children: [],
    site: undefined
})

*Defined in site/sites.constants.ts:20*

___


<a name="_e8a27f1e14373c14869782e771b6d002ee138a12c4dc32d803dddb985812df86"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["static/static.resources"](#_e8a27f1e14373c14869782e771b6d002ee138a12c4dc32d803dddb985812df86)

# External module: "static/static.resources"

## Index

### Classes

* [StaticResources](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

---


<a name="_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)

# External module: "storage/clientstorage"

## Index

### Classes

* [ClientStorageOnLocalStorage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)
* [EmptyClientStorage](#_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f)

### Interfaces

* [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

### Functions

* [clientStorageFromStorage](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)
* [clientStorageFromWindow](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)
* [createKey](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)
* [isQuotaExceeded](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)

---

## Functions

<a id="clientstoragefromstorage"></a>

###  clientStorageFromStorage

▸ **clientStorageFromStorage**(aStorage: * `Storage` &#124; `null` &#124; `undefined`*, aScope: *`string`*): [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

*Defined in storage/clientstorage.ts:98*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aStorage |  `Storage` &#124; `null` &#124; `undefined`|
| aScope | `string` |

**Returns:** [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

___
<a id="clientstoragefromwindow"></a>

###  clientStorageFromWindow

▸ **clientStorageFromWindow**(aScope: *`string`*, aWindow?: *`Window`*): [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

*Defined in storage/clientstorage.ts:109*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aScope | `string` |
| `Optional` aWindow | `Window` |

**Returns:** [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

___
<a id="createkey"></a>

###  createKey

▸ **createKey**(aKey: *`string`*, aPrefix: *`string`*, aSuffix: *`string`*): `string`

*Defined in storage/clientstorage.ts:23*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aPrefix | `string` |
| aSuffix | `string` |

**Returns:** `string`

___
<a id="isquotaexceeded"></a>

###  isQuotaExceeded

▸ **isQuotaExceeded**(e: *`any`*): `boolean`

*Defined in storage/clientstorage.ts:27*

**Parameters:**

| Param | Type |
| ------ | ------ |
| e | `any` |

**Returns:** `boolean`

___


<a name="_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/storage.service"](#_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf)

# External module: "storage/storage.service"

## Index

### Classes

* [ClientStorageService](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

### Variables

* [LOGGER](#_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf)

---

## Variables

<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"ClientStorageService"* = "ClientStorageService"

*Defined in storage/storage.service.ts:9*

___


<a name="_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["url/url.utils"](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)

# External module: "url/url.utils"

## Index

### Interfaces

* [ParsedQuery](#_8dfda0277b1152e2dccd4cc16b1eab35a9eeadded16a393fc277df810c9815b9)

### Variables

* [PARSE_HOST](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [PARSE_URL](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [decode](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [encode](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)

### Functions

* [_buildQueryString](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_cloneURL](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_decodeQueryArg](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_ensureStartingAndTrailingSlash](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_ensureTrailingSlash](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_fallbackToEmpty](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_getBaseUrlFromDocument](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_getBaseUrlFromWindow](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_getPathForSearch](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_parseQuery](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_parseURL](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_parseUrlString](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_push](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* [_urlToString](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)

---

## Variables

<a id="parse_host"></a>

### `<Const>` PARSE_HOST

**● PARSE_HOST**: *`RegExp`* =  /^([^:]+)(?:\:(\d+))?$/

*Defined in url/url.utils.ts:38*

___
<a id="parse_url"></a>

### `<Const>` PARSE_URL

**● PARSE_URL**: *`RegExp`* =  /^(((?:[^:\/?#]+):)?(?:\/\/([^\/?#]*))?)([^?#]*)(\?(?:[^#]*))?(#(?:.*))?$/

*Defined in url/url.utils.ts:36*

Regular expression to parse a URL according to

[https://tools.ietf.org/html/rfc3986#appendix-B](https://tools.ietf.org/html/rfc3986#appendix-B)

___
<a id="decode"></a>

### `<Const>` decode

**● decode**: *`decodeURIComponent`* =  decodeURIComponent

*Defined in url/url.utils.ts:109*

___
<a id="encode"></a>

### `<Const>` encode

**● encode**: *`encodeURIComponent`* =  encodeURIComponent

*Defined in url/url.utils.ts:108*

___

## Functions

<a id="_buildquerystring"></a>

###  _buildQueryString

▸ **_buildQueryString**(aValue: *`any`*):  `string` &#124; `null` &#124; `undefined`

*Defined in url/url.utils.ts:128*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `any` |

**Returns:**  `string` &#124; `null` &#124; `undefined`

___
<a id="_cloneurl"></a>

###  _cloneURL

▸ **_cloneURL**(aURL: *`URL`*): `URL`

*Defined in url/url.utils.ts:90*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL | `URL` |

**Returns:** `URL`

___
<a id="_decodequeryarg"></a>

###  _decodeQueryArg

▸ **_decodeQueryArg**(aValue: *`string`*): `string`

*Defined in url/url.utils.ts:173*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `string` |

**Returns:** `string`

___
<a id="_ensurestartingandtrailingslash"></a>

###  _ensureStartingAndTrailingSlash

▸ **_ensureStartingAndTrailingSlash**(aUrl?: *`string`*): `string`

*Defined in url/url.utils.ts:11*

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aUrl | `string` |

**Returns:** `string`

___
<a id="_ensuretrailingslash"></a>

###  _ensureTrailingSlash

▸ **_ensureTrailingSlash**(aUrl: *`string`*): `string`

*Defined in url/url.utils.ts:27*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |

**Returns:** `string`

___
<a id="_fallbacktoempty"></a>

###  _fallbackToEmpty

▸ **_fallbackToEmpty**(aValue: * `string` &#124; `undefined`*): `string`

*Defined in url/url.utils.ts:41*

Fallback to an empty string if the value is not defined

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue |  `string` &#124; `undefined`|

**Returns:** `string`

___
<a id="_getbaseurlfromdocument"></a>

###  _getBaseUrlFromDocument

▸ **_getBaseUrlFromDocument**(aDoc: *`Document`*):  `string` &#124; `undefined`

*Defined in url/url.utils.ts:231*

Extracts the base URL from the current document
*__see__*: [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base)

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aDoc | `Document` |  the document |

**Returns:**  `string` &#124; `undefined`

the URL

___
<a id="_getbaseurlfromwindow"></a>

###  _getBaseUrlFromWindow

▸ **_getBaseUrlFromWindow**(aWindow?: *`Window`*):  `string` &#124; `undefined`

*Defined in url/url.utils.ts:246*

Extracts the base URL from the window

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aWindow | `Window` |

**Returns:**  `string` &#124; `undefined`

the URL

___
<a id="_getpathforsearch"></a>

###  _getPathForSearch

▸ **_getPathForSearch**(aPath: *`string`*): `string`

*Defined in url/url.utils.ts:261*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |

**Returns:** `string`

___
<a id="_parsequery"></a>

###  _parseQuery

▸ **_parseQuery**(aQuery: *`string`*): [ParsedQuery](#_8dfda0277b1152e2dccd4cc16b1eab35a9eeadded16a393fc277df810c9815b9)

*Defined in url/url.utils.ts:183*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aQuery | `string` |

**Returns:** [ParsedQuery](#_8dfda0277b1152e2dccd4cc16b1eab35a9eeadded16a393fc277df810c9815b9)

___
<a id="_parseurl"></a>

###  _parseURL

▸ **_parseURL**(aURL: * `URL` &#124; `string` &#124; `null` &#124; `undefined`*):  `URL` &#124; `null` &#124; `undefined`

*Defined in url/url.utils.ts:79*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL |  `URL` &#124; `string` &#124; `null` &#124; `undefined`|

**Returns:**  `URL` &#124; `null` &#124; `undefined`

___
<a id="_parseurlstring"></a>

###  _parseUrlString

▸ **_parseUrlString**(aUrl: *`string`*): `URL`

*Defined in url/url.utils.ts:52*

Parses the URL string by applying a regular expression. Avoiding the use of the URL constructor which is not available on some platforms, notably not on Angular universal.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aUrl | `string` |  the URL string |

**Returns:** `URL`
the URL object

___
<a id="_push"></a>

###  _push

▸ **_push**(aEncodedKey: *`string`*, aValue: *`any`*, aArray: *`string`[]*): `void`

*Defined in url/url.utils.ts:118*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aEncodedKey | `string` |
| aValue | `any` |
| aArray | `string`[] |

**Returns:** `void`

___
<a id="_urltostring"></a>

###  _urlToString

▸ **_urlToString**(aURL: * `URL` &#124; `string`*): `string`

*Defined in url/url.utils.ts:257*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aURL |  `URL` &#124; `string`|

**Returns:** `string`

___


<a name="_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

# External module: "wch/wch.service"

## Index

### Classes

* [InternalWchService](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

### Variables

* [BFF_PUBLIC_URL](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [BFF_SECURE_URL](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [DEFAULT_CYCLE_HANDLING](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_PAGE_SEARCH_RESULT](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_RENDERING_CONTEXTS](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_RENDERING_CONTEXTS_SEQUENCE](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_RENDERING_CONTEXT_SEARCH_RESULT](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_SITE_PAGES_SEQUENCE](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [LOGGER](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [NO_RENDERING_CONTEXT](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [UNKNOWN_RENDERING_CONTEXT](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [_Subject](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [_assign](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

### Functions

* [_getPathFromUrlSegments](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [_pluckDocument](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [_pluckSiteId](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

### Object literals

* [EMPTY_RENDERING_QUERY](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* [EMPTY_SITE_PAGES_QUERY](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)

---

## Variables

<a id="bff_public_url"></a>

### `<Const>` BFF_PUBLIC_URL

**● BFF_PUBLIC_URL**: *"delivery/v1/rendering/"* = "delivery/v1/rendering/"

*Defined in wch/wch.service.ts:136*

___
<a id="bff_secure_url"></a>

### `<Const>` BFF_SECURE_URL

**● BFF_SECURE_URL**: *"mydelivery/v1/rendering/"* = "mydelivery/v1/rendering/"

*Defined in wch/wch.service.ts:137*

___
<a id="default_cycle_handling"></a>

### `<Const>` DEFAULT_CYCLE_HANDLING

**● DEFAULT_CYCLE_HANDLING**: *`BREAK`* =  CYCLE_HANDLING.BREAK

*Defined in wch/wch.service.ts:101*

___
<a id="empty_page_search_result"></a>

### `<Const>` EMPTY_PAGE_SEARCH_RESULT

**● EMPTY_PAGE_SEARCH_RESULT**: *`PageSearchResult`[]* =  []

*Defined in wch/wch.service.ts:82*

___
<a id="empty_rendering_contexts"></a>

### `<Const>` EMPTY_RENDERING_CONTEXTS

**● EMPTY_RENDERING_CONTEXTS**: *`RenderingContext`[]* =  []

*Defined in wch/wch.service.ts:83*

___
<a id="empty_rendering_contexts_sequence"></a>

### `<Const>` EMPTY_RENDERING_CONTEXTS_SEQUENCE

**● EMPTY_RENDERING_CONTEXTS_SEQUENCE**: *`Observable`<`RenderingContextQueryResult`>* =  of(EMPTY_RENDERING_QUERY)

*Defined in wch/wch.service.ts:89*

___
<a id="empty_rendering_context_search_result"></a>

### `<Const>` EMPTY_RENDERING_CONTEXT_SEARCH_RESULT

**● EMPTY_RENDERING_CONTEXT_SEARCH_RESULT**: *`RenderingContextSearchResult`[]* =  []

*Defined in wch/wch.service.ts:81*

___
<a id="empty_site_pages_sequence"></a>

### `<Const>` EMPTY_SITE_PAGES_SEQUENCE

**● EMPTY_SITE_PAGES_SEQUENCE**: *`Observable`<`SitePagesQueryResult`>* =  of(EMPTY_SITE_PAGES_QUERY)

*Defined in wch/wch.service.ts:90*

___
<a id="logger"></a>

### `<Const>` LOGGER

**● LOGGER**: *"WchService"* = "WchService"

*Defined in wch/wch.service.ts:97*

___
<a id="no_rendering_context"></a>

### `<Const>` NO_RENDERING_CONTEXT

**● NO_RENDERING_CONTEXT**: *`Observable`<`RenderingContext`>* =  of(EMPTY_RENDERING_CONTEXT).pipe(
  map(cloneDeep)
)

*Defined in wch/wch.service.ts:92*

___
<a id="unknown_rendering_context"></a>

### `<Const>` UNKNOWN_RENDERING_CONTEXT

**● UNKNOWN_RENDERING_CONTEXT**: *`Observable`<`RenderingContext`>* =  of(undefined)

*Defined in wch/wch.service.ts:95*

___
<a id="_subject"></a>

### `<Const>` _Subject

**● _Subject**: *`Subject`* =  Subject

*Defined in wch/wch.service.ts:98*

___
<a id="_assign"></a>

### `<Const>` _assign

**● _assign**: *`assign`* =  Object.assign

*Defined in wch/wch.service.ts:134*

___

## Functions

<a id="_getpathfromurlsegments"></a>

###  _getPathFromUrlSegments

▸ **_getPathFromUrlSegments**(aSegments: *`string`[]*): `string`

*Defined in wch/wch.service.ts:129*

Constructs the URL path based on the segemnets

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSegments | `string`[] |  the segments |

**Returns:** `string`
the path

___
<a id="_pluckdocument"></a>

###  _pluckDocument

▸ **_pluckDocument**<`T`>(aSearchResult: *`SearchResult`<`T`>*): `T`

*Defined in wch/wch.service.ts:109*

Extracts the document element from a search result

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSearchResult | `SearchResult`<`T`> |  the result |

**Returns:** `T`
the document

___
<a id="_plucksiteid"></a>

###  _pluckSiteId

▸ **_pluckSiteId**(aSite: *`Site`*): `string`

*Defined in wch/wch.service.ts:119*

Extracts the site ID from the site

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aSite | `Site` |  the site |

**Returns:** `string`
the document

___

## Object literals

<a id="empty_rendering_query"></a>

### `<Const>` EMPTY_RENDERING_QUERY

**EMPTY_RENDERING_QUERY**: *`object`*

*Defined in wch/wch.service.ts:84*

<a id="empty_rendering_query.numfound"></a>

####  numFound

**● numFound**: *`number`* = 0

*Defined in wch/wch.service.ts:84*

___
<a id="empty_rendering_query.renderingcontexts"></a>

####  renderingContexts

**● renderingContexts**: *`RenderingContext`[]* =  EMPTY_RENDERING_CONTEXTS

*Defined in wch/wch.service.ts:84*

___

___
<a id="empty_site_pages_query"></a>

### `<Const>` EMPTY_SITE_PAGES_QUERY

**EMPTY_SITE_PAGES_QUERY**: *`object`*

*Defined in wch/wch.service.ts:85*

<a id="empty_site_pages_query.numfound-1"></a>

####  numFound

**● numFound**: *`number`* = 0

*Defined in wch/wch.service.ts:85*

___
<a id="empty_site_pages_query.sitepages"></a>

####  sitePages

**● sitePages**: *`undefined`[]* =  []

*Defined in wch/wch.service.ts:85*

___

___


<a name="_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.utils"](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

# External module: "wch/wch.utils"

## Index

### Interfaces

* [RenderingContextMap](#_ae489d707a461c08b4db274344571e7e3ff8c999c2a9c978f568a778b39785ec)
* [WchDebug](#_220f8318cc12ae68df240c6187df837104ff12fc3e08793db88bcfe7040e65bc)

### Type aliases

* [RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

### Variables

* [HEX_REGEXP_STRING](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [HOST_REGEXP_STRING](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_CYCLE](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_LAYOUT_MODE](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_LEVELS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_REFERENCE](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_RENDERING_CONTEXT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [KEY_RENDERING_CONTEXT_MAP](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [PREVIEW_HOST_REGEXP](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [PREVIEW_HOST_REGEXP_STRING](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [PREVIEW_INDICATOR](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [PREVIEW_ORIGIN_REGEXP](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [PREVIEW_ORIGIN_REGEXP_STRING](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [TENANT_BASED_URL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [TENANT_BASED_URL_REGEXP](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [UUID_V4_REGEXP_STRING](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [VALUE_ROOT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_ALL_FETCH_LEVELS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_DEFAULT_FETCH_LEVELS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_FQ_SITE_ID](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_FIELD_LIST](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_PATHS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_ROWS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_SEARCH_FQ](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_SEARCH_Q](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_KEY_SORT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_PREFIX_SEARCH_CLASSIFICATION](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_FIELD_LIST](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_MAX_ROWS](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_ONE_ROW](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_SEARCH_FQ_CONTENT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_SEARCH_FQ_PAGE](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_VALUE_SEARCH_Q](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

### Functions

* [_addDebug](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_adjustRenderingContextSearchQuery](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_adjustSearchQuery](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_adjustSitePagesSearchQuery](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_boxFetchLevels](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_boxLayoutMode](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_forEachRenderingContext](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_forEachRenderingContexts](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_fqValuePush](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_fromHubInfoUrlProvider](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getApiUrlFromDeliveryURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getChildrenExpression](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getCycleHandling](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getDeliveryUrlFromApiURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getHubInfoFromBaseURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getLayout](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getPageSearchURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getParentExpression](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getParentPageURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getRenderingContextURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getSearchURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getSiblingsExpression](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getSiteContextExpression](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getSiteContextURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_getSiteURL](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_internalForEachRenderingContext](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_internalForEachRenderingContexts](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_isPreviewMode](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_isPreviewOrigin](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_isSearchClassification](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [_resolveRenderingContext](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

### Object literals

* [EMPTY_RENDERING_CONTEXT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [UNDEFINED_HUB_INFO](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)
* [UNDEFINED_RENDERING_CONTEXT](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

---

## Type aliases

<a id="renderingcontextcallback"></a>

###  RenderingContextCallback

**Ƭ RenderingContextCallback**: *`function`*

*Defined in wch/wch.utils.ts:482*

#### Type declaration
▸(rc: *`RenderingContext`*, parent?: *`RenderingContext`*, path?: *`string`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| rc | `RenderingContext` |
| `Optional` parent | `RenderingContext` |
| `Optional` path | `string` |

**Returns:** `void`

___

## Variables

<a id="hex_regexp_string"></a>

### `<Const>` HEX_REGEXP_STRING

**● HEX_REGEXP_STRING**: *"[0-9a-fA-F]"* = "[0-9a-fA-F]"

*Defined in wch/wch.utils.ts:44*

___
<a id="host_regexp_string"></a>

### `<Const>` HOST_REGEXP_STRING

**● HOST_REGEXP_STRING**: *"[^\.\:]"* = "[^\.\:]"

*Defined in wch/wch.utils.ts:45*

___
<a id="key_cycle"></a>

### `<Const>` KEY_CYCLE

**● KEY_CYCLE**: *"$$CYCLE"* = "$$CYCLE"

*Defined in wch/wch.utils.ts:24*

___
<a id="key_layout_mode"></a>

### `<Const>` KEY_LAYOUT_MODE

**● KEY_LAYOUT_MODE**: *"layoutMode"* = "layoutMode"

*Defined in wch/wch.utils.ts:203*

___
<a id="key_levels"></a>

### `<Const>` KEY_LEVELS

**● KEY_LEVELS**: *"levels"* = "levels"

*Defined in wch/wch.utils.ts:204*

___
<a id="key_reference"></a>

### `<Const>` KEY_REFERENCE

**● KEY_REFERENCE**: *"$$REF"* = "$$REF"

*Defined in wch/wch.utils.ts:25*

___
<a id="key_rendering_context"></a>

### `<Const>` KEY_RENDERING_CONTEXT

**● KEY_RENDERING_CONTEXT**: *"renderingContext"* = "renderingContext"

*Defined in wch/wch.utils.ts:202*

___
<a id="key_rendering_context_map"></a>

### `<Const>` KEY_RENDERING_CONTEXT_MAP

**● KEY_RENDERING_CONTEXT_MAP**: *`unique symbol`* =  Symbol('RenderingContextMap')

*Defined in wch/wch.utils.ts:22*

___
<a id="preview_host_regexp"></a>

### `<Const>` PREVIEW_HOST_REGEXP

**● PREVIEW_HOST_REGEXP**: *`RegExp`* =  new RegExp(PREVIEW_HOST_REGEXP_STRING)

*Defined in wch/wch.utils.ts:54*

___
<a id="preview_host_regexp_string"></a>

### `<Const>` PREVIEW_HOST_REGEXP_STRING

**● PREVIEW_HOST_REGEXP_STRING**: *`string`* =  `^(?:(${HOST_REGEXP_STRING}+)${PREVIEW_INDICATOR})((?:\\.${HOST_REGEXP_STRING}+)+)$`

*Defined in wch/wch.utils.ts:53*

___
<a id="preview_indicator"></a>

### `<Const>` PREVIEW_INDICATOR

**● PREVIEW_INDICATOR**: *"(?:-preview|-preview-stage)"* = "(?:-preview|-preview-stage)"

*Defined in wch/wch.utils.ts:52*

___
<a id="preview_origin_regexp"></a>

### `<Const>` PREVIEW_ORIGIN_REGEXP

**● PREVIEW_ORIGIN_REGEXP**: *`RegExp`* =  new RegExp(PREVIEW_ORIGIN_REGEXP_STRING)

*Defined in wch/wch.utils.ts:58*

___
<a id="preview_origin_regexp_string"></a>

### `<Const>` PREVIEW_ORIGIN_REGEXP_STRING

**● PREVIEW_ORIGIN_REGEXP_STRING**: *`string`* =  `^http[s]?:\\/\\/(?:(${HOST_REGEXP_STRING}+)${PREVIEW_INDICATOR})((?:\\.${HOST_REGEXP_STRING}+)+)(:\\d+)?$`

*Defined in wch/wch.utils.ts:57*

___
<a id="tenant_based_url"></a>

### `<Const>` TENANT_BASED_URL

**● TENANT_BASED_URL**: *`string`* =  `^(?:\\/api)?\\/(${UUID_V4_REGEXP_STRING})(?:\\/)?(?:.*)$`

*Defined in wch/wch.utils.ts:48*

___
<a id="tenant_based_url_regexp"></a>

### `<Const>` TENANT_BASED_URL_REGEXP

**● TENANT_BASED_URL_REGEXP**: *`RegExp`* =  new RegExp(TENANT_BASED_URL)

*Defined in wch/wch.utils.ts:49*

___
<a id="uuid_v4_regexp_string"></a>

### `<Const>` UUID_V4_REGEXP_STRING

**● UUID_V4_REGEXP_STRING**: *`string`* = 
  `${HEX_REGEXP_STRING}{8}-${HEX_REGEXP_STRING}{4}-4${HEX_REGEXP_STRING}{3}-[89abAB]${HEX_REGEXP_STRING}{3}-${HEX_REGEXP_STRING}{12}`

*Defined in wch/wch.utils.ts:46*

___
<a id="value_root"></a>

### `<Const>` VALUE_ROOT

**● VALUE_ROOT**: *"$"* = "$"

*Defined in wch/wch.utils.ts:480*

___
<a id="_all_fetch_levels"></a>

### `<Const>` _ALL_FETCH_LEVELS

**● _ALL_FETCH_LEVELS**: *`-1`* =  -1

*Defined in wch/wch.utils.ts:60*

___
<a id="_default_fetch_levels"></a>

### `<Const>` _DEFAULT_FETCH_LEVELS

**● _DEFAULT_FETCH_LEVELS**: *`-1`* =  _ALL_FETCH_LEVELS

*Defined in wch/wch.utils.ts:61*

___
<a id="_fq_site_id"></a>

### `<Const>` _FQ_SITE_ID

**● _FQ_SITE_ID**: *"siteId"* = "siteId"

*Defined in wch/wch.utils.ts:220*

___
<a id="_key_field_list"></a>

### `<Const>` _KEY_FIELD_LIST

**● _KEY_FIELD_LIST**: *"fl"* = "fl"

*Defined in wch/wch.utils.ts:209*

___
<a id="_key_paths"></a>

### `<Const>` _KEY_PATHS

**● _KEY_PATHS**: *"paths"* = "paths"

*Defined in wch/wch.utils.ts:212*

___
<a id="_key_rows"></a>

### `<Const>` _KEY_ROWS

**● _KEY_ROWS**: *"rows"* = "rows"

*Defined in wch/wch.utils.ts:211*

___
<a id="_key_search_fq"></a>

### `<Const>` _KEY_SEARCH_FQ

**● _KEY_SEARCH_FQ**: *"fq"* = "fq"

*Defined in wch/wch.utils.ts:216*

___
<a id="_key_search_q"></a>

### `<Const>` _KEY_SEARCH_Q

**● _KEY_SEARCH_Q**: *"q"* = "q"

*Defined in wch/wch.utils.ts:207*

___
<a id="_key_sort"></a>

### `<Const>` _KEY_SORT

**● _KEY_SORT**: *"sort"* = "sort"

*Defined in wch/wch.utils.ts:210*

___
<a id="_prefix_search_classification"></a>

### `<Const>` _PREFIX_SEARCH_CLASSIFICATION

**● _PREFIX_SEARCH_CLASSIFICATION**: *"classification"* = "classification"

*Defined in wch/wch.utils.ts:219*

___
<a id="_value_field_list"></a>

### `<Const>` _VALUE_FIELD_LIST

**● _VALUE_FIELD_LIST**: *"document:[json]"* = "document:[json]"

*Defined in wch/wch.utils.ts:215*

___
<a id="_value_max_rows"></a>

### `<Const>` _VALUE_MAX_ROWS

**● _VALUE_MAX_ROWS**: *`string`* =  anyToString(0x7FFFFFFF)

*Defined in wch/wch.utils.ts:214*

___
<a id="_value_one_row"></a>

### `<Const>` _VALUE_ONE_ROW

**● _VALUE_ONE_ROW**: *"1"* = "1"

*Defined in wch/wch.utils.ts:213*

___
<a id="_value_search_fq_content"></a>

### `<Const>` _VALUE_SEARCH_FQ_CONTENT

**● _VALUE_SEARCH_FQ_CONTENT**: *"classification:(content)"* = "classification:(content)"

*Defined in wch/wch.utils.ts:217*

___
<a id="_value_search_fq_page"></a>

### `<Const>` _VALUE_SEARCH_FQ_PAGE

**● _VALUE_SEARCH_FQ_PAGE**: *"classification:(page)"* = "classification:(page)"

*Defined in wch/wch.utils.ts:218*

___
<a id="_value_search_q"></a>

### `<Const>` _VALUE_SEARCH_Q

**● _VALUE_SEARCH_Q**: *"*:*"* = "*:*"

*Defined in wch/wch.utils.ts:208*

___

## Functions

<a id="_adddebug"></a>

###  _addDebug

▸ **_addDebug**(aPath: *`string`*, aRenderingContext: *`RenderingContext`*): `RenderingContext`

*Defined in wch/wch.utils.ts:423*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |
| aRenderingContext | `RenderingContext` |

**Returns:** `RenderingContext`

___
<a id="_adjustrenderingcontextsearchquery"></a>

###  _adjustRenderingContextSearchQuery

▸ **_adjustRenderingContextSearchQuery**(aQuery: *`string`*): `string`

*Defined in wch/wch.utils.ts:298*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aQuery | `string` |

**Returns:** `string`

___
<a id="_adjustsearchquery"></a>

###  _adjustSearchQuery

▸ **_adjustSearchQuery**(aQuery: *`string`*, aFieldQueries: *`string`[]*): `string`

*Defined in wch/wch.utils.ts:251*

Generically adjust the search query

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aQuery | `string` |  the query |
| aFieldQueries | `string`[] |

**Returns:** `string`
the new query string

___
<a id="_adjustsitepagessearchquery"></a>

###  _adjustSitePagesSearchQuery

▸ **_adjustSitePagesSearchQuery**(aQuery: *`string`*, aSiteId: *`string`*): `string`

*Defined in wch/wch.utils.ts:309*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aQuery | `string` |
| aSiteId | `string` |

**Returns:** `string`

___
<a id="_boxfetchlevels"></a>

###  _boxFetchLevels

▸ **_boxFetchLevels**(aLevels: * `number` &#124; `null` &#124; `undefined`*, aDefault?: *`number`*): `number`

*Defined in wch/wch.utils.ts:182*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLevels |  `number` &#124; `null` &#124; `undefined`|
| `Optional` aDefault | `number` |

**Returns:** `number`

___
<a id="_boxlayoutmode"></a>

###  _boxLayoutMode

▸ **_boxLayoutMode**(aMode: * `string` &#124; `null` &#124; `undefined`*): `string`

*Defined in wch/wch.utils.ts:69*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aMode |  `string` &#124; `null` &#124; `undefined`|

**Returns:** `string`

___
<a id="_foreachrenderingcontext"></a>

###  _forEachRenderingContext

▸ **_forEachRenderingContext**(aRenderingContext: *`RenderingContext`*, aCallback: *[RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)*): `void`

*Defined in wch/wch.utils.ts:568*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext` |
| aCallback | [RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) |

**Returns:** `void`

___
<a id="_foreachrenderingcontexts"></a>

###  _forEachRenderingContexts

▸ **_forEachRenderingContexts**(aRenderingContext: *`RenderingContext`[]*, aCallback: *[RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)*): `void`

*Defined in wch/wch.utils.ts:555*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext`[] |
| aCallback | [RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) |

**Returns:** `void`

___
<a id="_fqvaluepush"></a>

###  _fqValuePush

▸ **_fqValuePush**(aValue: *`string`*, aArray: *`string`[]*): `string`[]

*Defined in wch/wch.utils.ts:238*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `string` |
| aArray | `string`[] |

**Returns:** `string`[]

___
<a id="_fromhubinfourlprovider"></a>

###  _fromHubInfoUrlProvider

▸ **_fromHubInfoUrlProvider**(aProvider: *`HubInfoUrlProvider`*):  `URL` &#124; `null` &#124; `undefined`

*Defined in wch/wch.utils.ts:192*

Converts the provider into a URL

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aProvider | `HubInfoUrlProvider` |  the provider |

**Returns:**  `URL` &#124; `null` &#124; `undefined`

the URL if available

___
<a id="_getapiurlfromdeliveryurl"></a>

###  _getApiUrlFromDeliveryURL

▸ **_getApiUrlFromDeliveryURL**(aDeliveryURL: *`URL`*): `URL`

*Defined in wch/wch.utils.ts:171*

Computes the API URL given the delivery URL

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aDeliveryURL | `URL` |  the delivery URL |

**Returns:** `URL`
the API URL

___
<a id="_getchildrenexpression"></a>

###  _getChildrenExpression

▸ **_getChildrenExpression**(aPageId: *`string`*): `string`

*Defined in wch/wch.utils.ts:331*

Returns the search expression that finds the children of a page

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aPageId | `string` |  Id of the page |

**Returns:** `string`
the string

___
<a id="_getcyclehandling"></a>

###  _getCycleHandling

▸ **_getCycleHandling**(aCycle?: * `CYCLE_HANDLING` &#124; `string`*): `CYCLE_HANDLING`

*Defined in wch/wch.utils.ts:197*

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aCycle |  `CYCLE_HANDLING` &#124; `string`|

**Returns:** `CYCLE_HANDLING`

___
<a id="_getdeliveryurlfromapiurl"></a>

###  _getDeliveryUrlFromApiURL

▸ **_getDeliveryUrlFromApiURL**(aApiURL: *`URL`*): `URL`

*Defined in wch/wch.utils.ts:160*

Computes the delivery URL given the API URL

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aApiURL | `URL` |  the API URL |

**Returns:** `URL`
the delivery URL

___
<a id="_gethubinfofrombaseurl"></a>

###  _getHubInfoFromBaseURL

▸ **_getHubInfoFromBaseURL**(aBaseURL: *`URL`*): `HubInfo`

*Defined in wch/wch.utils.ts:120*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseURL | `URL` |

**Returns:** `HubInfo`

___
<a id="_getlayout"></a>

###  _getLayout

▸ **_getLayout**(aLayoutMode: * `string` &#124; `undefined`*, aContext: * `RenderingContext` &#124; `undefined`*):  `Layout` &#124; `undefined`

*Defined in wch/wch.utils.ts:79*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aLayoutMode |  `string` &#124; `undefined`|
| aContext |  `RenderingContext` &#124; `undefined`|

**Returns:**  `Layout` &#124; `undefined`

___
<a id="_getpagesearchurl"></a>

###  _getPageSearchURL

▸ **_getPageSearchURL**(aPath: *`string`*, aSiteId: *`string`*): `Observable`<`string`>

*Defined in wch/wch.utils.ts:374*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |
| aSiteId | `string` |

**Returns:** `Observable`<`string`>

___
<a id="_getparentexpression"></a>

###  _getParentExpression

▸ **_getParentExpression**(aParentId: *`string`*): `string`

*Defined in wch/wch.utils.ts:342*

Returns the parent of a page

**Parameters:**

| Param | Type |
| ------ | ------ |
| aParentId | `string` |

**Returns:** `string`
the string

___
<a id="_getparentpageurl"></a>

###  _getParentPageURL

▸ **_getParentPageURL**(aParentId: *`string`*, aSiteId: *`string`*): `Observable`<`string`>

*Defined in wch/wch.utils.ts:411*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aParentId | `string` |
| aSiteId | `string` |

**Returns:** `Observable`<`string`>

___
<a id="_getrenderingcontexturl"></a>

###  _getRenderingContextURL

▸ **_getRenderingContextURL**(aBaseUrl: *`string`*, aID: *`string`*): `string`

*Defined in wch/wch.utils.ts:583*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseUrl | `string` |
| aID | `string` |

**Returns:** `string`

___
<a id="_getsearchurl"></a>

###  _getSearchURL

▸ **_getSearchURL**(aQueryString: *`string`*): `Observable`<`string`>

*Defined in wch/wch.utils.ts:363*

Builds the search query string

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aQueryString | `string` |  the query string |

**Returns:** `Observable`<`string`>
the result

___
<a id="_getsiblingsexpression"></a>

###  _getSiblingsExpression

▸ **_getSiblingsExpression**(aParentId: *`string`*): `string`

*Defined in wch/wch.utils.ts:320*

Returns the search expression that finds the siblings of a page

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aParentId | `string` |  id of the parent page |

**Returns:** `string`
the string

___
<a id="_getsitecontextexpression"></a>

###  _getSiteContextExpression

▸ **_getSiteContextExpression**(aParentId: * `string` &#124; `null` &#124; `undefined`*, aPageId: *`string`*): `string`

*Defined in wch/wch.utils.ts:353*

Returns the expression to get the complete site context in one call

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| aParentId |  `string` &#124; `null` &#124; `undefined`|  the parent ID |
| aPageId | `string` |  the page ID |

**Returns:** `string`
the expression

___
<a id="_getsitecontexturl"></a>

###  _getSiteContextURL

▸ **_getSiteContextURL**(aParentId: * `string` &#124; `null` &#124; `undefined`*, aPageId: *`string`*, aSiteId: *`string`*): `Observable`<`string`>

*Defined in wch/wch.utils.ts:392*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aParentId |  `string` &#124; `null` &#124; `undefined`|
| aPageId | `string` |
| aSiteId | `string` |

**Returns:** `Observable`<`string`>

___
<a id="_getsiteurl"></a>

###  _getSiteURL

▸ **_getSiteURL**(aBaseUrl: *`string`*, aSiteID?: *`string`*): `string`

*Defined in wch/wch.utils.ts:592*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseUrl | `string` |
| `Optional` aSiteID | `string` |

**Returns:** `string`

___
<a id="_internalforeachrenderingcontext"></a>

###  _internalForEachRenderingContext

▸ **_internalForEachRenderingContext**(aRenderingContext: *`RenderingContext`*, aParent: * `RenderingContext` &#124; `undefined`*, aPath: *`string`*, aCallback: *[RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)*): `void`

*Defined in wch/wch.utils.ts:511*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext` |
| aParent |  `RenderingContext` &#124; `undefined`|
| aPath | `string` |
| aCallback | [RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) |

**Returns:** `void`

___
<a id="_internalforeachrenderingcontexts"></a>

###  _internalForEachRenderingContexts

▸ **_internalForEachRenderingContexts**(aRenderingContext: *`RenderingContext`[]*, aParent: * `RenderingContext` &#124; `undefined`*, aPath: *`string`*, aCallback: *[RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)*): `void`

*Defined in wch/wch.utils.ts:490*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext | `RenderingContext`[] |
| aParent |  `RenderingContext` &#124; `undefined`|
| aPath | `string` |
| aCallback | [RenderingContextCallback](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) |

**Returns:** `void`

___
<a id="_ispreviewmode"></a>

###  _isPreviewMode

▸ **_isPreviewMode**(aBaseURL: *`URL`*): `boolean`

*Defined in wch/wch.utils.ts:96*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseURL | `URL` |

**Returns:** `boolean`

___
<a id="_isprevieworigin"></a>

###  _isPreviewOrigin

▸ **_isPreviewOrigin**(aOrigin: *`string`*): `boolean`

*Defined in wch/wch.utils.ts:106*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aOrigin | `string` |

**Returns:** `boolean`

___
<a id="_issearchclassification"></a>

###  _isSearchClassification

▸ **_isSearchClassification**(aValue: *`string`*): `boolean`

*Defined in wch/wch.utils.ts:228*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aValue | `string` |

**Returns:** `boolean`

___
<a id="_resolverenderingcontext"></a>

###  _resolveRenderingContext

▸ **_resolveRenderingContext**(aRenderingContext: * `RenderingContext` &#124; `null` &#124; `undefined`*, aStrategy: *`CYCLE_HANDLING`*, aRenderingContextById: *`function`*, aLogger?: *`Logger`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

*Defined in wch/wch.utils.ts:432*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aRenderingContext |  `RenderingContext` &#124; `null` &#124; `undefined`|
| aStrategy | `CYCLE_HANDLING` |
| aRenderingContextById | `function` |
| `Optional` aLogger | `Logger` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___

## Object literals

<a id="empty_rendering_context"></a>

### `<Const>` EMPTY_RENDERING_CONTEXT

**EMPTY_RENDERING_CONTEXT**: *`object`*

*Defined in wch/wch.utils.ts:27*

<a id="empty_rendering_context.context"></a>

####  context

**● context**: *`SiteContext`* =  EMPTY_SITE_CONTEXT

*Defined in wch/wch.utils.ts:32*

___
<a id="empty_rendering_context.elements"></a>

####  elements

**● elements**: *`object`*

*Defined in wch/wch.utils.ts:29*

#### Type declaration

___
<a id="empty_rendering_context.id"></a>

####  id

**● id**: *`null`* =  null

*Defined in wch/wch.utils.ts:28*

___
<a id="empty_rendering_context.layouts"></a>

####  layouts

**● layouts**: *`object`* =  DEFAULT_LAYOUT_MAPPING

*Defined in wch/wch.utils.ts:30*

#### Type declaration

[layoutMode: `string`]: `Layout`

___
<a id="empty_rendering_context.markups"></a>

####  markups

**● markups**: *`object`*

*Defined in wch/wch.utils.ts:31*

#### Type declaration

___

___
<a id="undefined_hub_info"></a>

### `<Const>` UNDEFINED_HUB_INFO

**UNDEFINED_HUB_INFO**: *`object`*

*Defined in wch/wch.utils.ts:112*

<a id="undefined_hub_info.apiurl"></a>

####  apiUrl

**● apiUrl**: *`undefined`* =  undefined

*Defined in wch/wch.utils.ts:113*

___
<a id="undefined_hub_info.deliveryurl"></a>

####  deliveryUrl

**● deliveryUrl**: *`undefined`* =  undefined

*Defined in wch/wch.utils.ts:114*

___

___
<a id="undefined_rendering_context"></a>

### `<Const>` UNDEFINED_RENDERING_CONTEXT

**UNDEFINED_RENDERING_CONTEXT**: *`object`*

*Defined in wch/wch.utils.ts:35*

<a id="undefined_rendering_context.context-1"></a>

####  context

**● context**: *`SiteContext`* =  EMPTY_SITE_CONTEXT

*Defined in wch/wch.utils.ts:40*

___
<a id="undefined_rendering_context.elements-1"></a>

####  elements

**● elements**: *`object`*

*Defined in wch/wch.utils.ts:37*

#### Type declaration

___
<a id="undefined_rendering_context.id-1"></a>

####  id

**● id**: *`undefined`* =  undefined

*Defined in wch/wch.utils.ts:36*

___
<a id="undefined_rendering_context.layouts-1"></a>

####  layouts

**● layouts**: *`object`* =  DEFAULT_LAYOUT_MAPPING

*Defined in wch/wch.utils.ts:38*

#### Type declaration

[layoutMode: `string`]: `Layout`

___
<a id="undefined_rendering_context.markups-1"></a>

####  markups

**● markups**: *`object`*

*Defined in wch/wch.utils.ts:39*

#### Type declaration

___

___


<a name="_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0"></a>

Utils
=====

TBD

## Index

### External modules

* ["cache/cache.utils"](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a)
* ["categories/categories"](#_6ef573db579410052240872183feb1248a890ed1b2fad6c3f8446d371be0652a)
* ["consumers/consumer"](#_fb15e4b30da6b553299ae3064790fac25351bdfc987281c9bf0a617d7f96e5f0)
* ["cors/cors.utils"](#_4998f1b43e30a7925591fe0619c16edd8a5e573599722ad1e9440b3b68ca3435)
* ["debug/debug.utils"](#_a9b4fb380dad79d6b56c2e91d8b545d027422bd7eaede299ac3a08f431baf0c0)
* ["elements/element"](#_1d72094e6c18ae5af4eb0fb3f7b17bfae7323891e9e55cb9813069d4587b5694)
* ["error/error"](#_4410fb8e64cb7359fd126243eba5ac43323fc1ad53e8a0ed5444a22f1d782c37)
* ["generators/generator"](#_d69d68c57c30107752b064505ad0f7fae17a0d48412a53fd82c328cc95dc4b55)
* ["generators/lazy.generator"](#_db0d7cc88f59eaa9805726888c3ff94c1889f2e2533723c90cffdefcdb8b55b6)
* ["hash/hash.utils"](#_f7a9f82bc926f2b4d2981efe2966eda6ccbd9cb2d15764357fe5c0dd7dac2816)
* ["http/http.utils"](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547)
* ["idle/idle"](#_98d1c3ec91e6b2599d3cdd2de96d17e19fd44bd4455fc3a0d5dfc2077fa3675d)
* ["index"](#_d53838c3180bb9a0e5494e993ceb8942c9866e807f2cfe89645b7e36005a0cf8)
* ["js/js.utils"](#_e4e3e3bb1922cafb033e87bd3c6348f560b0e9f30d662d3355c35d150b95091f)
* ["json/json.utils"](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
* ["layouts/layout"](#_97941b4787f392851d9df1d53bf3ca09e0c1ba4fe0df48e1f6bdb08db30a7c80)
* ["logger/console.logger"](#_3bff58e4580d9efb8c4fe62098ee9332860cb35a16be89cb5dddb2db1aeefb4d)
* ["logger/noop.logger"](#_98e353213f9cc2221a397c6f11f63e5ce44eb6f9cade1c13cc5caae0f419bb41)
* ["logger/noop.logger.service"](#_cd33d6b69708d7a6c383b5faabace0c44d3cc36d96617836792718f8aff4b154)
* ["messages/message.event"](#_940ab2bdc53b8f6f6a715eb3833fb2e97b88e04b90d6356f13573c80c54caa3a)
* ["messages/navigate.by.path.handler"](#_3acc9a6df7591e4df3930d6f7cd3ea1f812683c2b4d0ae76c12c4deab92df784)
* ["messages/refresh.handler"](#_ada61457119bada75d55cec24428b3538901c156eebc33e1a87d592583a2f526)
* ["messages/set.mode.handler"](#_e309135659b12cf6970673aa7eb414ed26e3b3a3422c6c6a1dd0578b33899e51)
* ["messages/subscribe.active.route.handler"](#_edd9d3f166f449a12924122a8de848d71d607e3174054673c15ee8d0625e2af6)
* ["messages/subscribe.handler"](#_e11907f07e45917850d3fe7f730d169ae1c970ac6ba8b2ccf6d5c5014ed300ce)
* ["messages/subscribe.mode.handler"](#_169992e40a133fc488cd57b5485cdc3ef48a7698fbf7335d49892e9ca649e762)
* ["messages/subscribe.route.handler"](#_9195176e7adea610cc95c3d5d69d7fec1b6897c8af2092a30921db588b8a2b43)
* ["misc"](#_87db2cbdba9ba53c30678c1ae3b89f921797d847824725865bae172d8e624ed2)
* ["operators/operators"](#_6448b4dd429a35d426901673465e8fa409e3bac470381da4c6ee0ca281e156d8)
* ["predicates/predicates"](#_99b629e2e57035ffccc2febcbbde0c9acc0d8d56a28a2a556880673b08669325)
* ["rendering/rendering"](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1)
* ["rx/rx.utils"](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d)
* ["search/search.utils"](#_9bd2b00c9ca149e493950c1a8a2124a779dedba0d113ced4231259a15a03e311)
* ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)
* ["site/sites.constants"](#_f30cda291cb2e5feefc62cd41b243c2630244ea84f42b00aad8b84c5861ab4c3)
* ["static/static.resources"](#_e8a27f1e14373c14869782e771b6d002ee138a12c4dc32d803dddb985812df86)
* ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb)
* ["storage/storage.service"](#_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf)
* ["url/url.utils"](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43)
* ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d)
* ["wch/wch.utils"](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba)

---


<a name="_7f7e46578096800d809ec39521155bff7d5fece796e2914c49a794151c0ffb51"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["cache/cache.utils"](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a) > [CacheImpl](#_7f7e46578096800d809ec39521155bff7d5fece796e2914c49a794151c0ffb51)

# Interface: CacheImpl

## Type parameters
#### V 
## Hierarchy

**CacheImpl**

## Indexable

\[key: `string`\]:&nbsp;[CacheValue](#_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6)<`V`>
## Index

---


<a name="_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["cache/cache.utils"](#_3b2c419b0b3a4f2b1ee3f3d90ee1741957909e63753f389711cf8b45c69d7f7a) > [CacheValue](#_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6)

# Interface: CacheValue

## Type parameters
#### V 
## Hierarchy

**CacheValue**

## Index

### Properties

* [isDirty](#_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6)
* [value](#_014397d7315c176fabc2d9bd268d6d2327b66b4f877f0d0f2da40908c05f77f6)

---

## Properties

<a id="isdirty"></a>

###  isDirty

**● isDirty**: *`boolean`*

*Defined in cache/cache.utils.ts:17*

___
<a id="value"></a>

###  value

**● value**: *`V`*

*Defined in cache/cache.utils.ts:15*

___


<a name="_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["http/http.utils"](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547) > [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)

# Interface: HttpOptions

## Hierarchy

**HttpOptions**

## Index

### Properties

* [dispatchError](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)
* [withCredentials](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)

---

## Properties

<a id="dispatcherror"></a>

### `<Optional>` dispatchError

**● dispatchError**: *`boolean`*

*Defined in http/http.utils.ts:38*

___
<a id="withcredentials"></a>

###  withCredentials

**● withCredentials**: *`boolean`*

*Defined in http/http.utils.ts:36*

___


<a name="_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["http/http.utils"](#_6550589ec93c3e3917bddad3ec47f1acd0ef0920191fc007cef12f1b69c0e547) > [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)

# Interface: HttpService

## Hierarchy

**HttpService**

## Index

### Methods

* [getJson](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)
* [getText](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)

---

## Methods

<a id="getjson"></a>

###  getJson

▸ **getJson**<`T`>(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*): `Observable`<`T`>

*Defined in http/http.utils.ts:42*

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |

**Returns:** `Observable`<`T`>

___
<a id="gettext"></a>

###  getText

▸ **getText**(aUrl: *`string`*, aOptions: *[HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f)*): `Observable`<`string`>

*Defined in http/http.utils.ts:43*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| aOptions | [HttpOptions](#_77ef69279f4add0992bff9637a4e7e61f8cffab3d3018e6341dc92e2a6a5f78f) |

**Returns:** `Observable`<`string`>

___


<a name="_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["json/json.utils"](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) > [JsonArray](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)

# Interface: JsonArray

## Hierarchy

 `Array`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

**↳ JsonArray**

## Indexable

\[n: `number`\]:&nbsp;[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
## Index

### Properties

* [Array](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [length](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)

### Methods

* [__@iterator](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [__@unscopables](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [concat](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [copyWithin](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [entries](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [every](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [fill](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [filter](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [find](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [findIndex](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [forEach](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [includes](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [indexOf](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [join](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [keys](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [lastIndexOf](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [map](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [pop](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [push](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [reduce](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [reduceRight](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [reverse](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [shift](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [slice](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [some](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [sort](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [splice](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [toLocaleString](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [toString](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [unshift](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)
* [values](#_924d062de7f05703b0cf4498935f78fbdfa09d82f3caaa45ccafd7a0bc14938e)

---

## Properties

<a id="array"></a>

###  Array

**● Array**: *`ArrayConstructor`*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280*

___
<a id="length"></a>

###  length

**● length**: *`number`*

*Inherited from Array.length*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1121*

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

___

## Methods

<a id="___iterator"></a>

###  __@iterator

▸ **__@iterator**(): `IterableIterator`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

*Inherited from Array.[Symbol.iterator]*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52*

Iterator

**Returns:** `IterableIterator`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

___
<a id="___unscopables"></a>

###  __@unscopables

▸ **__@unscopables**(): `object`

*Inherited from Array.[Symbol.unscopables]*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94*

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

**Returns:** `object`

___
<a id="concat"></a>

###  concat

▸ **concat**(...items: *`ConcatArray`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>[]*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

▸ **concat**(...items: *( `T` &#124; `ConcatArray`<`T`>)[]*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.concat*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1143*

Combines two or more arrays.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Rest` items | `ConcatArray`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>[] |  Additional items to add to the end of array1. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.concat*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1148*

Combines two or more arrays.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Rest` items | ( `T` &#124; `ConcatArray`<`T`>)[] |  Additional items to add to the end of array1. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

___
<a id="copywithin"></a>

###  copyWithin

▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`number`*): `this`

*Inherited from Array.copyWithin*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:66*

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| target | `number` |  If target is negative, it is treated as length+target where length is the length of the array. |
| start | `number` |  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. |
| `Optional` end | `number` |  If not specified, length of the this object is used as its default value. |

**Returns:** `this`

___
<a id="entries"></a>

###  entries

▸ **entries**(): `IterableIterator`<[`number`, [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)]>

*Inherited from Array.entries*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57*

Returns an iterable of key, value pairs for every entry in the array

**Returns:** `IterableIterator`<[`number`, [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)]>

___
<a id="every"></a>

###  every

▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean`

*Inherited from Array.every*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1208*

Determines whether all the members of an array satisfy the specified test.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** `boolean`

___
<a id="fill"></a>

###  fill

▸ **fill**(value: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*, start?: *`number`*, end?: *`number`*): `this`

*Inherited from Array.fill*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:55*

Returns the this object after filling the section identified by start and end with value

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| value | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |  value to fill array section with |
| `Optional` start | `number` |  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. |
| `Optional` end | `number` |  index to stop filling the array at. If end is negative, it is treated as length+end. |

**Returns:** `this`

___
<a id="filter"></a>

###  filter

▸ **filter**<`S`>(callbackfn: *`function`*, thisArg?: *`any`*): `S`[]

▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.filter*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1232*

Returns the elements of an array that meet the condition specified in a callback function.

**Type parameters:**

#### S :  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** `S`[]

*Inherited from Array.filter*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1238*

Returns the elements of an array that meet the condition specified in a callback function.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

___
<a id="find"></a>

###  find

▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*):  `S` &#124; `undefined`

▸ **find**(predicate: *`function`*, thisArg?: *`any`*):  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

*Inherited from Array.find*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:33*

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

**Type parameters:**

#### S :  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| predicate | `function` |  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. |
| `Optional` thisArg | `any` |  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |

**Returns:**  `S` &#124; `undefined`

*Inherited from Array.find*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:34*

**Parameters:**

| Param | Type |
| ------ | ------ |
| predicate | `function` |
| `Optional` thisArg | `any` |

**Returns:**  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

___
<a id="findindex"></a>

###  findIndex

▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number`

*Inherited from Array.findIndex*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:45*

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| predicate | `function` |  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. |
| `Optional` thisArg | `any` |  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |

**Returns:** `number`

___
<a id="foreach"></a>

###  forEach

▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void`

*Inherited from Array.forEach*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1220*

Performs the specified action for each element in an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** `void`

___
<a id="includes"></a>

###  includes

▸ **includes**(searchElement: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*, fromIndex?: *`number`*): `boolean`

*Inherited from Array.includes*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27*

Determines whether an array includes a certain element, returning true or false as appropriate.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| searchElement | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |  The element to search for. |
| `Optional` fromIndex | `number` |  The position in this array at which to begin searching for searchElement. |

**Returns:** `boolean`

___
<a id="indexof"></a>

###  indexOf

▸ **indexOf**(searchElement: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*, fromIndex?: *`number`*): `number`

*Inherited from Array.indexOf*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1196*

Returns the index of the first occurrence of a value in an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| searchElement | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |  The value to locate in the array. |
| `Optional` fromIndex | `number` |  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |

**Returns:** `number`

___
<a id="join"></a>

###  join

▸ **join**(separator?: *`string`*): `string`

*Inherited from Array.join*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1153*

Adds all the elements of an array separated by the specified separator string.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` separator | `string` |  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. |

**Returns:** `string`

___
<a id="keys"></a>

###  keys

▸ **keys**(): `IterableIterator`<`number`>

*Inherited from Array.keys*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62*

Returns an iterable of keys in the array

**Returns:** `IterableIterator`<`number`>

___
<a id="lastindexof"></a>

###  lastIndexOf

▸ **lastIndexOf**(searchElement: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*, fromIndex?: *`number`*): `number`

*Inherited from Array.lastIndexOf*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1202*

Returns the index of the last occurrence of a specified value in an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| searchElement | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |  The value to locate in the array. |
| `Optional` fromIndex | `number` |  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. |

**Returns:** `number`

___
<a id="map"></a>

###  map

▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `U`[]

*Inherited from Array.map*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226*

Calls a defined callback function on each element of an array, and returns an array that contains the results.

**Type parameters:**

#### U 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** `U`[]

___
<a id="pop"></a>

###  pop

▸ **pop**():  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

*Inherited from Array.pop*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1138*

Removes the last element from an array and returns it.

**Returns:**  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

___
<a id="push"></a>

###  push

▸ **push**(...items: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]*): `number`

*Inherited from Array.push*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1134*

Appends new elements to an array, and returns the new length of the array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Rest` items | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[] |  New elements of the Array. |

**Returns:** `number`

___
<a id="reduce"></a>

###  reduce

▸ **reduce**(callbackfn: *`function`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

▸ **reduce**(callbackfn: *`function`*, initialValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U`

*Inherited from Array.reduce*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1244*

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Inherited from Array.reduce*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245*

**Parameters:**

| Param | Type |
| ------ | ------ |
| callbackfn | `function` |
| initialValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Inherited from Array.reduce*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1251*

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

**Type parameters:**

#### U 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
| initialValue | `U` |  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |

**Returns:** `U`

___
<a id="reduceright"></a>

###  reduceRight

▸ **reduceRight**(callbackfn: *`function`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U`

*Inherited from Array.reduceRight*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1257*

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Inherited from Array.reduceRight*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1258*

**Parameters:**

| Param | Type |
| ------ | ------ |
| callbackfn | `function` |
| initialValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Inherited from Array.reduceRight*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1264*

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

**Type parameters:**

#### U 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
| initialValue | `U` |  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |

**Returns:** `U`

___
<a id="reverse"></a>

###  reverse

▸ **reverse**(): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.reverse*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1157*

Reverses the elements in an Array.

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

___
<a id="shift"></a>

###  shift

▸ **shift**():  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

*Inherited from Array.shift*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1161*

Removes the first element from an array and returns it.

**Returns:**  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `undefined`

___
<a id="slice"></a>

###  slice

▸ **slice**(start?: *`number`*, end?: *`number`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.slice*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1167*

Returns a section of an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` start | `number` |  The beginning of the specified portion of the array. |
| `Optional` end | `number` |  The end of the specified portion of the array. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

___
<a id="some"></a>

###  some

▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean`

*Inherited from Array.some*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1214*

Determines whether the specified callback function returns true for any element of an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| callbackfn | `function` |  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. |
| `Optional` thisArg | `any` |  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

**Returns:** `boolean`

___
<a id="sort"></a>

###  sort

▸ **sort**(compareFn?: *`function`*): `this`

*Inherited from Array.sort*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1172*

Sorts an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Optional` compareFn | `function` |  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. |

**Returns:** `this`

___
<a id="splice"></a>

###  splice

▸ **splice**(start: *`number`*, deleteCount?: *`number`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.splice*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1178*

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| start | `number` |  The zero-based location in the array from which to start removing elements. |
| `Optional` deleteCount | `number` |  The number of elements to remove. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

*Inherited from Array.splice*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1185*

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| start | `number` |  The zero-based location in the array from which to start removing elements. |
| deleteCount | `number` |  The number of elements to remove. |
| `Rest` items | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[] |  Elements to insert into the array in place of the deleted elements. |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]

___
<a id="tolocalestring"></a>

###  toLocaleString

▸ **toLocaleString**(): `string`

*Inherited from Array.toLocaleString*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1129*

Returns a string representation of an array. The elements are converted to string using thier toLocalString methods.

**Returns:** `string`

___
<a id="tostring"></a>

###  toString

▸ **toString**(): `string`

*Inherited from Array.toString*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1125*

Returns a string representation of an array.

**Returns:** `string`

___
<a id="unshift"></a>

###  unshift

▸ **unshift**(...items: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[]*): `number`

*Inherited from Array.unshift*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1190*

Inserts new elements at the start of an array.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| `Rest` items | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)[] |  Elements to insert at the start of the Array. |

**Returns:** `number`

___
<a id="values"></a>

###  values

▸ **values**(): `IterableIterator`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

*Inherited from Array.values*

*Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67*

Returns an iterable of values in the array

**Returns:** `IterableIterator`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

___


<a name="_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rendering/rendering"](#_1a1a62a747944816d72f800ba41dffe081ea6cc4333e07e046ab76b985c07cd1) > [HandlerKind](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)

# Enumeration: HandlerKind

## Index

### Enumeration members

* [MULTI_VALUES](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)
* [SINGLE](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)
* [SINGLE_VALUE](#_dbb33b051fbfceeba959f17526214eafe52b4567f0b320a348e2917d8b740ef1)

---

## Enumeration members

<a id="multi_values"></a>

###  MULTI_VALUES

**MULTI_VALUES**: 

*Defined in rendering/rendering.ts:205*

___
<a id="single"></a>

###  SINGLE

**SINGLE**: 

*Defined in rendering/rendering.ts:206*

___
<a id="single_value"></a>

###  SINGLE_VALUE

**SINGLE_VALUE**:  = 1

*Defined in rendering/rendering.ts:204*

___


<a name="_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rx/rx.utils"](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d) > [IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

# Class: IdleFrameAction

## Type parameters
#### T 
## Hierarchy

 `AsyncAction`<`T`>

**↳ IdleFrameAction**

## Implements

* `ISubscription`

## Index

### Constructors

* [constructor](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

### Properties

* [_parent](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [_parents](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [closed](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [delay](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [id](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [pending](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [scheduler](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [state](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [work](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [EMPTY](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

### Methods

* [_execute](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [_unsubscribe](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [add](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [execute](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [recycleAsyncId](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [remove](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [requestAsyncId](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [schedule](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)
* [unsubscribe](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new IdleFrameAction**(scheduler: *[IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)*, work: *`function`*): [IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

*Overrides AsyncAction.__constructor*

*Defined in rx/rx.utils.ts:98*

**Parameters:**

| Param | Type |
| ------ | ------ |
| scheduler | [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1) |
| work | `function` |

**Returns:** [IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)

___

## Properties

<a id="_parent"></a>

### `<Protected>` _parent

**● _parent**: *`Subscription`*

*Inherited from Subscription._parent*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:28*

___
<a id="_parents"></a>

### `<Protected>` _parents

**● _parents**: *`Subscription`[]*

*Inherited from Subscription._parents*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:29*

___
<a id="closed"></a>

###  closed

**● closed**: *`boolean`*

*Inherited from Subscription.closed*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:27*

A flag to indicate whether this Subscription has already been unsubscribed.
*__type__*: {boolean}

___
<a id="delay"></a>

###  delay

**● delay**: *`number`*

*Inherited from AsyncAction.delay*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:13*

___
<a id="id"></a>

###  id

**● id**: *`any`*

*Inherited from AsyncAction.id*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:11*

___
<a id="pending"></a>

### `<Protected>` pending

**● pending**: *`boolean`*

*Inherited from AsyncAction.pending*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:14*

___
<a id="scheduler"></a>

### `<Protected>` scheduler

**● scheduler**: *[IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)*

*Overrides AsyncAction.scheduler*

*Defined in rx/rx.utils.ts:100*

___
<a id="state"></a>

###  state

**● state**: *`T`*

*Inherited from AsyncAction.state*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:12*

___
<a id="work"></a>

### `<Protected>` work

**● work**: *`function`*

*Overrides AsyncAction.work*

*Defined in rx/rx.utils.ts:101*

#### Type declaration
▸(this: *[IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)<`T`>*, state?: *`T`*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| this | [IdleFrameAction](#_49fd54a33f641dafbc4b57f0bfe84e07a147fd20531c8caa6afb7f35e19ed951)<`T`> |
| `Optional` state | `T` |

**Returns:** `void`

___
<a id="empty"></a>

### `<Static>` EMPTY

**● EMPTY**: *`Subscription`*

*Inherited from Subscription.EMPTY*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:22*

___

## Methods

<a id="_execute"></a>

### `<Protected>` _execute

▸ **_execute**(state: *`T`*, delay: *`number`*): `any`

*Inherited from AsyncAction._execute*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:25*

**Parameters:**

| Param | Type |
| ------ | ------ |
| state | `T` |
| delay | `number` |

**Returns:** `any`

___
<a id="_unsubscribe"></a>

###  _unsubscribe

▸ **_unsubscribe**(): `void`

*Inherited from AsyncAction._unsubscribe*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:26*

*__deprecated__*: internal use only

**Returns:** `void`

___
<a id="add"></a>

###  add

▸ **add**(teardown: *`TeardownLogic`*): `Subscription`

*Inherited from Subscription.add*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:61*

Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference `add` is being called on, or is `Subscription.EMPTY`, it will not be added.

If this subscription is already in an `closed` state, the passed tear down logic will be executed immediately.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| teardown | `TeardownLogic` |  The additional logic to execute on teardown. |

**Returns:** `Subscription`
Returns the Subscription used or created to be
added to the inner subscriptions list. This Subscription can be used with
`remove()` to remove the passed teardown logic from the inner subscriptions
list.

___
<a id="execute"></a>

###  execute

▸ **execute**(state: *`T`*, delay: *`number`*): `any`

*Inherited from AsyncAction.execute*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:24*

Immediately executes this action and the `work` it contains.

**Parameters:**

| Param | Type |
| ------ | ------ |
| state | `T` |
| delay | `number` |

**Returns:** `any`

___
<a id="recycleasyncid"></a>

### `<Protected>` recycleAsyncId

▸ **recycleAsyncId**(scheduler: *[IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)*, id?: *`any`*, delay?: *`number`*): `any`

*Overrides AsyncAction.recycleAsyncId*

*Defined in rx/rx.utils.ts:118*

**Parameters:**

| Param | Type | Default value |
| ------ | ------ | ------ |
| scheduler | [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1) | - |
| `Optional` id | `any` | - |
| `Default value` delay | `number` | 0 |

**Returns:** `any`

___
<a id="remove"></a>

###  remove

▸ **remove**(subscription: *`Subscription`*): `void`

*Inherited from Subscription.remove*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:68*

Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| subscription | `Subscription` |  The subscription to remove. |

**Returns:** `void`

___
<a id="requestasyncid"></a>

### `<Protected>` requestAsyncId

▸ **requestAsyncId**(scheduler: *[IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)*, id?: *`any`*, delay?: *`number`*): `any`

*Overrides AsyncAction.requestAsyncId*

*Defined in rx/rx.utils.ts:105*

**Parameters:**

| Param | Type | Default value |
| ------ | ------ | ------ |
| scheduler | [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1) | - |
| `Optional` id | `any` | - |
| `Default value` delay | `number` | 0 |

**Returns:** `any`

___
<a id="schedule"></a>

###  schedule

▸ **schedule**(state?: *`T`*, delay?: *`number`*): `Subscription`

*Inherited from AsyncAction.schedule*

*Overrides Action.schedule*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:17*

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` state | `T` |
| `Optional` delay | `number` |

**Returns:** `Subscription`

___
<a id="unsubscribe"></a>

###  unsubscribe

▸ **unsubscribe**(): `void`

*Inherited from Subscription.unsubscribe*

*Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:42*

Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

**Returns:** `void`

___


<a name="_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["rx/rx.utils"](#_cbb4805d26ab842e398b40a1d2a4ddaac7ce0b0831d5f6b13f6441348facb43d) > [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

# Class: IdleFrameScheduler

## Hierarchy

 `AsyncScheduler`

**↳ IdleFrameScheduler**

## Implements

* `IScheduler`

## Index

### Constructors

* [constructor](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

### Properties

* [actions](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)
* [active](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)
* [now](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)
* [scheduled](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)
* [now](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

### Methods

* [flush](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)
* [schedule](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new IdleFrameScheduler**(SchedulerAction: *`Action`*, now?: *`function`*): [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

*Inherited from Scheduler.__constructor*

*Defined in /usr/build/node_modules/rxjs/Scheduler.d.ts:25*

**Parameters:**

| Param | Type |
| ------ | ------ |
| SchedulerAction | `Action` |
| `Optional` now | `function` |

**Returns:** [IdleFrameScheduler](#_13ab4cfcd27682dddf8eff3614bdc9f612252b325bb5263c047523d01104f5c1)

___

## Properties

<a id="actions"></a>

###  actions

**● actions**: *`Array`<`AsyncAction`<`any`>>*

*Inherited from AsyncScheduler.actions*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncScheduler.d.ts:4*

___
<a id="active"></a>

###  active

**● active**: *`boolean`*

*Inherited from AsyncScheduler.active*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncScheduler.d.ts:10*

A flag to indicate whether the Scheduler is currently executing a batch of queued actions.
*__type__*: {boolean}

___
<a id="now"></a>

###  now

**● now**: *`function`*

*Inherited from Scheduler.now*

*Defined in /usr/build/node_modules/rxjs/Scheduler.d.ts:35*

A getter method that returns a number representing the current time (at the time this function was called) according to the scheduler's own internal clock.
*__returns__*: A number that represents the current time. May or may not have a relation to wall-clock time. May or may not refer to a time unit (e.g. milliseconds).

#### Type declaration
▸(): `number`

**Returns:** `number`

___
<a id="scheduled"></a>

###  scheduled

**● scheduled**: *`any`*

*Inherited from AsyncScheduler.scheduled*

*Defined in /usr/build/node_modules/rxjs/scheduler/AsyncScheduler.d.ts:17*

An internal ID used to track the latest asynchronous task such as those coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and others.
*__type__*: {any}

___
<a id="now-1"></a>

### `<Static>` now

**● now**: *`function`*

*Inherited from Scheduler.now*

*Defined in /usr/build/node_modules/rxjs/Scheduler.d.ts:25*

#### Type declaration
▸(): `number`

**Returns:** `number`

___

## Methods

<a id="flush"></a>

###  flush

▸ **flush**(action?: *`AsyncAction`<`any`>*): `void`

*Overrides AsyncScheduler.flush*

*Defined in rx/rx.utils.ts:70*

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` action | `AsyncAction`<`any`> |

**Returns:** `void`

___
<a id="schedule"></a>

###  schedule

▸ **schedule**<`T`>(work: *`function`*, delay?: *`number`*, state?: *`T`*): `Subscription`

*Inherited from Scheduler.schedule*

*Defined in /usr/build/node_modules/rxjs/Scheduler.d.ts:53*

Schedules a function, `work`, for execution. May happen at some point in the future, according to the `delay` parameter, if specified. May be passed some context object, `state`, which will be passed to the `work` function.

The given arguments will be processed an stored as an Action object in a queue of actions.

**Type parameters:**

#### T 
**Parameters:**

| Param | Type | Description |
| ------ | ------ | ------ |
| work | `function` |  A function representing a task, or some unit of work to be executed by the Scheduler. |
| `Optional` delay | `number` |
| `Optional` state | `T` |

**Returns:** `Subscription`
A subscription in order to be able to unsubscribe
the scheduled work.

___


<a name="_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923) > [InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)

# Class: InternalSiteInformation

## Hierarchy

**InternalSiteInformation**

## Index

### Properties

* [_idToContext](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)
* [_pathToId](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)
* [_siteContext](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)

---

## Properties

<a id="_idtocontext"></a>

###  _idToContext

**● _idToContext**: *[SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)<`SiteContext`>*

*Defined in site/site.utils.ts:114*

___
<a id="_pathtoid"></a>

###  _pathToId

**● _pathToId**: *[AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)<`string`>*

*Defined in site/site.utils.ts:111*

___
<a id="_sitecontext"></a>

###  _siteContext

**● _siteContext**: *`SiteContext`* =  cloneDeep(UNDEFINED_SITE_CONTEXT)

*Defined in site/site.utils.ts:117*

___


<a name="_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923) > [SiteInformation](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

# Class: SiteInformation

## Hierarchy

**SiteInformation**

## Index

### Constructors

* [constructor](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

### Properties

* [bInitialized](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)
* [observer](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)
* [siteInfo](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)
* [siteSubject](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

### Accessors

* [site](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

### Methods

* [clear](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)
* [getIdByPath](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)
* [getSiteContextById](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new SiteInformation**(): [SiteInformation](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

*Defined in site/site.utils.ts:354*

**Returns:** [SiteInformation](#_e8048a5d7b79c4eb95f037e739ad4bbc1bba4b6235e4d8465c46de0bf951c842)

___

## Properties

<a id="binitialized"></a>

### `<Private>` bInitialized

**● bInitialized**: *`boolean`* = false

*Defined in site/site.utils.ts:342*

___
<a id="observer"></a>

###  observer

**● observer**: *`Observer`<`Site`>*

*Defined in site/site.utils.ts:354*

___
<a id="siteinfo"></a>

### `<Private>` siteInfo

**● siteInfo**: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)* =  new InternalSiteInformation()

*Defined in site/site.utils.ts:352*

___
<a id="sitesubject"></a>

### `<Private>` siteSubject

**● siteSubject**: *`ReplaySubject`<`Site`>* =  new ReplaySubject<Site>(1)

*Defined in site/site.utils.ts:347*

___

## Accessors

<a id="site"></a>

###  site

getsite(): `Observable`<`Site`>

*Defined in site/site.utils.ts:456*

**Returns:** `Observable`<`Site`>

___

## Methods

<a id="clear"></a>

### `<Private>` clear

▸ **clear**(): `void`

*Defined in site/site.utils.ts:411*

**Returns:** `void`

___
<a id="getidbypath"></a>

###  getIdByPath

▸ **getIdByPath**(path: *`string`*): `Observable`< `string` &#124; `null` &#124; `undefined`>

*Defined in site/site.utils.ts:431*

**Parameters:**

| Param | Type |
| ------ | ------ |
| path | `string` |

**Returns:** `Observable`< `string` &#124; `null` &#124; `undefined`>

___
<a id="getsitecontextbyid"></a>

###  getSiteContextById

▸ **getSiteContextById**(aID: * `string` &#124; `null`*): `SiteContext`

*Defined in site/site.utils.ts:446*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aID |  `string` &#124; `null`|

**Returns:** `SiteContext`

___


<a name="_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923) > [AnalysisContext](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)

# Interface: AnalysisContext

## Hierarchy

**AnalysisContext**

## Index

### Properties

* [_newInfo](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)
* [_notifications](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)
* [_oldInfo](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)
* [_site](#_5319ac6f4d011901cd2661583ce8b172c1f1b6d3488dd8b44f6a12847d9732d2)

---

## Properties

<a id="_newinfo"></a>

###  _newInfo

**● _newInfo**: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*

*Defined in site/site.utils.ts:124*

___
<a id="_notifications"></a>

###  _notifications

**● _notifications**: *[ChangeNotification](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923)[]*

*Defined in site/site.utils.ts:126*

___
<a id="_oldinfo"></a>

###  _oldInfo

**● _oldInfo**: *[InternalSiteInformation](#_9226024465b1a559832feb8a4680bbde9e430ec69534b7bb8c00e53bb9b9a144)*

*Defined in site/site.utils.ts:123*

___
<a id="_site"></a>

###  _site

**● _site**: *`Site`*

*Defined in site/site.utils.ts:122*

___


<a name="_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923) > [AsyncMapping](#_43ad7a04241a7fe89551fd02fb62602a85750874bd0d02ac71c7cd48b851994d)

# Interface: AsyncMapping

## Type parameters
#### T 
## Hierarchy

**AsyncMapping**

## Indexable

\[key: `string`\]:&nbsp;`BehaviorSubject`<`T`>
## Index

---


<a name="_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["site/site.utils"](#_bc26489a9a55ed420f647a6db5563c493b77f49a9a526dbd9294eff6285b8923) > [SyncMapping](#_af3df183b1a90084178857789fd2067ae0ae74f3364968197e9ad29dcb2f2d3c)

# Interface: SyncMapping

## Type parameters
#### T 
## Hierarchy

**SyncMapping**

## Indexable

\[key: `string`\]:&nbsp;`T`
## Index

---


<a name="_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["static/static.resources"](#_e8a27f1e14373c14869782e771b6d002ee138a12c4dc32d803dddb985812df86) > [StaticResources](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

# Class: StaticResources

## Hierarchy

**StaticResources**

## Index

### Constructors

* [constructor](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

### Properties

* [base](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)
* [http](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

### Methods

* [get](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new StaticResources**(aBaseUrl: * `URL` &#124; `undefined`*, http: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*): [StaticResources](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

*Defined in static/static.resources.ts:17*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aBaseUrl |  `URL` &#124; `undefined`|
| http | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |

**Returns:** [StaticResources](#_abcae26ba75618e221b85c704ec328baa2093a926625689bfef36c574eda0af0)

___

## Properties

<a id="base"></a>

### `<Private>` base

**● base**: *`string`*

*Defined in static/static.resources.ts:17*

___
<a id="http"></a>

### `<Private>` http

**● http**: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*

*Defined in static/static.resources.ts:20*

___

## Methods

<a id="get"></a>

###  get

▸ **get**(aKey: *`string`*): `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

*Defined in static/static.resources.ts:31*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |

**Returns:** `Observable`<[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)>

___


<a name="_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb) > [ClientStorageOnLocalStorage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

# Class: ClientStorageOnLocalStorage

## Hierarchy

**ClientStorageOnLocalStorage**

## Implements

* [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

## Index

### Constructors

* [constructor](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

### Properties

* [prefix](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)
* [storage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)
* [suffix](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

### Methods

* [get](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)
* [put](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new ClientStorageOnLocalStorage**(storage: *`Storage`*, scope: *`string`*): [ClientStorageOnLocalStorage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

*Defined in storage/clientstorage.ts:54*

**Parameters:**

| Param | Type |
| ------ | ------ |
| storage | `Storage` |
| scope | `string` |

**Returns:** [ClientStorageOnLocalStorage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)

___

## Properties

<a id="prefix"></a>

### `<Private>` prefix

**● prefix**: *`string`*

*Defined in storage/clientstorage.ts:53*

___
<a id="storage"></a>

### `<Private>` storage

**● storage**: *`Storage`*

*Defined in storage/clientstorage.ts:56*

___
<a id="suffix"></a>

### `<Private>` suffix

**● suffix**: *`string`*

*Defined in storage/clientstorage.ts:54*

___

## Methods

<a id="get"></a>

###  get

▸ **get**(aKey: *`string`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[get](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/clientstorage.ts:63*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

___
<a id="put"></a>

###  put

▸ **put**(aKey: *`string`*, aValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): `void`

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[put](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/clientstorage.ts:73*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** `void`

___


<a name="_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb) > [EmptyClientStorage](#_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f)

# Class: EmptyClientStorage

## Hierarchy

**EmptyClientStorage**

## Implements

* [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

## Index

### Methods

* [get](#_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f)
* [put](#_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f)

---

## Methods

<a id="get"></a>

###  get

▸ **get**(aKey: *`string`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[get](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/clientstorage.ts:83*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

___
<a id="put"></a>

###  put

▸ **put**(aKey: *`string`*, aValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): `void`

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[put](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/clientstorage.ts:87*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** `void`

___


<a name="_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/clientstorage"](#_c3354752de3affa5542a013d0c75421708bae6d25c90eb8843f9332e0720b2eb) > [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

# Interface: ClientStorage

## Hierarchy

**ClientStorage**

## Implemented by

* [ClientStorageOnLocalStorage](#_5af17eecf4be95624c7f1a406d1990ca2d53bf42814dee2454fe84cc8a9d9ac6)
* [ClientStorageService](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)
* [EmptyClientStorage](#_1850d2116d5426b03c6f15c2954a623a1b982a79f165b9ed07b8a62132fcf60f)

## Index

### Methods

* [get](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)
* [put](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

---

## Methods

<a id="get"></a>

###  get

▸ **get**(aKey: *`string`*):  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `null` &#124; `undefined`

*Defined in storage/clientstorage.ts:10*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |

**Returns:**  [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) &#124; `null` &#124; `undefined`

___
<a id="put"></a>

###  put

▸ **put**(aKey: *`string`*, aValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): `any`

*Defined in storage/clientstorage.ts:12*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** `any`

___


<a name="_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["storage/storage.service"](#_d093805380864fde7fb6e81449d9839a8d78b38f749bd2e0dab1047ce3310ccf) > [ClientStorageService](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

# Class: ClientStorageService

## Hierarchy

**ClientStorageService**

## Implements

* [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)

## Index

### Constructors

* [constructor](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

### Properties

* [get](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)
* [put](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new ClientStorageService**(aUrlsService: *`UrlConfig`*, aWindow?: *`Window`*): [ClientStorageService](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

*Defined in storage/storage.service.ts:15*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrlsService | `UrlConfig` |
| `Optional` aWindow | `Window` |

**Returns:** [ClientStorageService](#_5700f947edd6d0b4e1e4c9128d935cab576288dce270ce2ad0fdf8eb86d18907)

___

## Properties

<a id="get"></a>

###  get

**● get**: *`function`*

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[get](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/storage.service.ts:14*

#### Type declaration
▸(aKey: *`string`*): [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |

**Returns:** [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)

___
<a id="put"></a>

###  put

**● put**: *`function`*

*Implementation of [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3).[put](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*

*Defined in storage/storage.service.ts:15*

#### Type declaration
▸(aKey: *`string`*, aValue: *[AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4)*): `void`

**Parameters:**

| Param | Type |
| ------ | ------ |
| aKey | `string` |
| aValue | [AnyJson](#_35803eb08bd18c9eb79b7e634819f1d369df7d4c2422f53d5e780c4425978fd4) |

**Returns:** `void`

___


<a name="_8dfda0277b1152e2dccd4cc16b1eab35a9eeadded16a393fc277df810c9815b9"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["url/url.utils"](#_a34ba51d46be84695b44bf63c56076e92b958dd8c4e9b5c93cac83a9b96bab43) > [ParsedQuery](#_8dfda0277b1152e2dccd4cc16b1eab35a9eeadded16a393fc277df810c9815b9)

# Interface: ParsedQuery

## Hierarchy

**ParsedQuery**

## Indexable

\[key: `string`\]:&nbsp; `string` &#124; `string`[]

## Index

---


<a name="_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.service"](#_c195babe71d6fb1f216c06a35041fde3330da06995e3f4e1da58ba329d05900d) > [InternalWchService](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

# Class: InternalWchService

## Hierarchy

**InternalWchService**

## Index

### Constructors

* [constructor](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

### Properties

* [createPollingTrigger](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [dispose](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getApiUrl](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getCorsWhitelist](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getDeliverOrigin](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getDeliveryUrl](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getJsonResource](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextById](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextByPage](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextByPath](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextByUrlSegments](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextForAppConfig](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getRenderingContextsByQuery](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getSitePagesByQuery](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [getTextResource](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [isPreviewMode](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [resolveRenderingContext](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)
* [triggerRefresh](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

---

## Constructors

<a id="constructor"></a>

###  constructor

⊕ **new InternalWchService**(aHttp: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, aJsonp: *[HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c)*, wchConfig: *`HubInfoConfig`*, aUrlService: *`UrlConfig`*, clientStorage: *[ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3)*, usePublicUrl: *`Observable`<`boolean`>*, aLogger?: *`Logger`*): [InternalWchService](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

*Defined in wch/wch.service.ts:162*

**Parameters:**

| Param | Type |
| ------ | ------ |
| aHttp | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| aJsonp | [HttpService](#_5c662a0ff5d2f06c7ca3d6ef221baba56e0e15086ef2d5c7aea477b6ec43551c) |
| wchConfig | `HubInfoConfig` |
| aUrlService | `UrlConfig` |
| clientStorage | [ClientStorage](#_56c1396cf0f5d503fcb88d3b91f709dadd8c18db4cb5d45d62dd78ce568b5eb3) |
| usePublicUrl | `Observable`<`boolean`> |
| `Optional` aLogger | `Logger` |

**Returns:** [InternalWchService](#_362048b7429a05e47de9098c1b24508575e4b372d5d35bb6a87e3f83a891b83c)

___

## Properties

<a id="createpollingtrigger"></a>

### `<Protected>` createPollingTrigger

**● createPollingTrigger**: *`function`*

*Defined in wch/wch.service.ts:162*

#### Type declaration
▸(aOptions?: *`HttpResourceOptions`*): `Observable`<`any`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`any`>

___
<a id="dispose"></a>

###  dispose

**● dispose**: *`function`*

*Defined in wch/wch.service.ts:142*

#### Type declaration
▸(): `void`

**Returns:** `void`

___
<a id="getapiurl"></a>

###  getApiUrl

**● getApiUrl**: *`function`*

*Defined in wch/wch.service.ts:144*

#### Type declaration
▸(): `URL`

**Returns:** `URL`

___
<a id="getcorswhitelist"></a>

###  getCorsWhitelist

**● getCorsWhitelist**: *`function`*

*Defined in wch/wch.service.ts:155*

#### Type declaration
▸(): `Observable`<`string`[]>

**Returns:** `Observable`<`string`[]>

___
<a id="getdeliverorigin"></a>

###  getDeliverOrigin

**● getDeliverOrigin**: *`function`*

*Defined in wch/wch.service.ts:147*

#### Type declaration
▸(): `string`

**Returns:** `string`

___
<a id="getdeliveryurl"></a>

###  getDeliveryUrl

**● getDeliveryUrl**: *`function`*

*Defined in wch/wch.service.ts:145*

#### Type declaration
▸(): `URL`

**Returns:** `URL`

___
<a id="getjsonresource"></a>

###  getJsonResource

**● getJsonResource**: *`function`*

*Defined in wch/wch.service.ts:156*

#### Type declaration
▸<`T`>(aUrl: *`string`*, aOptions?: *`HttpResourceOptions`*): `Observable`<`T`>

**Type parameters:**

#### T 
**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`T`>

___
<a id="getrenderingcontextbyid"></a>

###  getRenderingContextById

**● getRenderingContextById**: *`function`*

*Defined in wch/wch.service.ts:148*

#### Type declaration
▸(aID: * `string` &#124; `null` &#124; `undefined`*, aLevels?: *`number`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aID |  `string` &#124; `null` &#124; `undefined`|
| `Optional` aLevels | `number` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___
<a id="getrenderingcontextbypage"></a>

###  getRenderingContextByPage

**● getRenderingContextByPage**: *`function`*

*Defined in wch/wch.service.ts:151*

#### Type declaration
▸(aPage: *`SitePage`*, aLevels?: *`number`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPage | `SitePage` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___
<a id="getrenderingcontextbypath"></a>

###  getRenderingContextByPath

**● getRenderingContextByPath**: *`function`*

*Defined in wch/wch.service.ts:150*

#### Type declaration
▸(aPath: *`string`*, aLevels?: *`number`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aPath | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___
<a id="getrenderingcontextbyurlsegments"></a>

###  getRenderingContextByUrlSegments

**● getRenderingContextByUrlSegments**: *`function`*

*Defined in wch/wch.service.ts:149*

#### Type declaration
▸(aSegments: *`string`[]*, aLevels?: *`number`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aSegments | `string`[] |
| `Optional` aLevels | `number` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___
<a id="getrenderingcontextforappconfig"></a>

###  getRenderingContextForAppConfig

**● getRenderingContextForAppConfig**: *`function`*

*Defined in wch/wch.service.ts:152*

#### Type declaration
▸(aLevels?: *`number`*): `Observable`<`RenderingContext`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContext`>

___
<a id="getrenderingcontextsbyquery"></a>

###  getRenderingContextsByQuery

**● getRenderingContextsByQuery**: *`function`*

*Defined in wch/wch.service.ts:153*

#### Type declaration
▸(aQuery: *`string`*, aLevels?: *`number`*): `Observable`<`RenderingContextQueryResult`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aQuery | `string` |
| `Optional` aLevels | `number` |

**Returns:** `Observable`<`RenderingContextQueryResult`>

___
<a id="getsitepagesbyquery"></a>

###  getSitePagesByQuery

**● getSitePagesByQuery**: *`function`*

*Defined in wch/wch.service.ts:154*

#### Type declaration
▸(aQuery: *`string`*): `Observable`<`SitePagesQueryResult`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aQuery | `string` |

**Returns:** `Observable`<`SitePagesQueryResult`>

___
<a id="gettextresource"></a>

###  getTextResource

**● getTextResource**: *`function`*

*Defined in wch/wch.service.ts:157*

#### Type declaration
▸(aUrl: *`string`*, aOptions?: *`HttpResourceOptions`*): `Observable`<`string`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| aUrl | `string` |
| `Optional` aOptions | `HttpResourceOptions` |

**Returns:** `Observable`<`string`>

___
<a id="ispreviewmode"></a>

###  isPreviewMode

**● isPreviewMode**: *`function`*

*Defined in wch/wch.service.ts:146*

#### Type declaration
▸(): `boolean`

**Returns:** `boolean`

___
<a id="resolverenderingcontext"></a>

###  resolveRenderingContext

**● resolveRenderingContext**: *`function`*

*Defined in wch/wch.service.ts:158*

#### Type declaration
▸(aRenderingContext?: *`RenderingContext`*, aStrategy?: *`CYCLE_HANDLING`*): `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

**Parameters:**

| Param | Type |
| ------ | ------ |
| `Optional` aRenderingContext | `RenderingContext` |
| `Optional` aStrategy | `CYCLE_HANDLING` |

**Returns:** `Observable`< `RenderingContext` &#124; `null` &#124; `undefined`>

___
<a id="triggerrefresh"></a>

###  triggerRefresh

**● triggerRefresh**: *`function`*

*Defined in wch/wch.service.ts:143*

#### Type declaration
▸(): `void`

**Returns:** `void`

___


<a name="_ae489d707a461c08b4db274344571e7e3ff8c999c2a9c978f568a778b39785ec"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.utils"](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) > [RenderingContextMap](#_ae489d707a461c08b4db274344571e7e3ff8c999c2a9c978f568a778b39785ec)

# Interface: RenderingContextMap

## Hierarchy

**RenderingContextMap**

## Indexable

\[id: `string`\]:&nbsp;`RenderingContext`
## Index

---


<a name="_220f8318cc12ae68df240c6187df837104ff12fc3e08793db88bcfe7040e65bc"></a>
[ibm-wch-sdk-utils](#_96fdf8c61d5bb26367a408e8d5dba5da59ddf12345ac319ff3123e2c56e986f0) > ["wch/wch.utils"](#_ba234dbec2cde604523b1e76e3ecf91e4d57b8f6798b9509b7201d77709384ba) > [WchDebug](#_220f8318cc12ae68df240c6187df837104ff12fc3e08793db88bcfe7040e65bc)

# Interface: WchDebug

## Hierarchy

**WchDebug**

## Index

### Properties

* [path](#_220f8318cc12ae68df240c6187df837104ff12fc3e08793db88bcfe7040e65bc)

---

## Properties

<a id="path"></a>

###  path

**● path**: *`string`*

*Defined in wch/wch.utils.ts:15*

___

---
_Source: https://npm.io/package/ibm-wch-sdk-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
