ibm-wch-sdk-utils

Exposes framework independent APIs to support the implementation of ibm-wch-sdk-ng and similar SDK.

Details

Refer to the documentation.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

Utils

TBD

Changelog

Current

Added

Added typecheck methods for the new group element type
New getCategoryLeaf helper function
Initial version

Utils

TBD

Index

External modules

"cache/cache.utils"
"categories/categories"
"consumers/consumer"
"cors/cors.utils"
"debug/debug.utils"
"elements/element"
"error/error"
"generators/generator"
"generators/lazy.generator"
"hash/hash.utils"
"http/http.utils"
"idle/idle"
"index"
"js/js.utils"
"json/json.utils"
"layouts/layout"
"logger/console.logger"
"logger/noop.logger"
"logger/noop.logger.service"
"messages/message.event"
"messages/navigate.by.path.handler"
"messages/refresh.handler"
"messages/set.mode.handler"
"messages/subscribe.active.route.handler"
"messages/subscribe.handler"
"messages/subscribe.mode.handler"
"messages/subscribe.route.handler"
"misc"
"operators/operators"
"predicates/predicates"
"rendering/rendering"
"rx/rx.utils"
"search/search.utils"
"site/site.utils"
"site/sites.constants"
"static/static.resources"
"storage/clientstorage"
"storage/storage.service"
"url/url.utils"
"wch/wch.service"
"wch/wch.utils"

ibm-wch-sdk-utils > "cache/cache.utils"

External module: "cache/cache.utils"

Index

Type aliases

CacheAccessor

Ƭ CacheAccessor: BiFunction<string, CacheCallback<V>, V>

Defined in cache/cache.utils.ts:11

CacheCallback

Ƭ CacheCallback: UnaryFunction<string, V>

Defined in cache/cache.utils.ts:10

Variables

`<Const>` DEFAULT_MAXCOUNT

● DEFAULT_MAXCOUNT: 100 = 100

Defined in cache/cache.utils.ts:28

`<Const>` DEFAULT_TIMEOUT

● DEFAULT_TIMEOUT: number = 30 * 1000

Defined in cache/cache.utils.ts:25

Functions

`<Const>` _createCache

▸ _createCache<V>(aTimeout?: number, aMaxValues?: number, aLogger?: Logger): CacheAccessor<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<V> the accessor function

ibm-wch-sdk-utils > "categories/categories"

External module: "categories/categories"

Index

Functions

getCategoryLeaf

Functions

`<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

ibm-wch-sdk-utils > "consumers/consumer"

External module: "consumers/consumer"

Index

Type aliases

BiConsumer

Ƭ BiConsumer: BiFunction<T1, T2, any>

Defined in consumers/consumer.ts:5

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

Consumer

Ƭ Consumer: UnaryFunction<T, any>

Defined in consumers/consumer.ts:3

ibm-wch-sdk-utils > "cors/cors.utils"

External module: "cors/cors.utils"

Index

Variables

NULL_ORIGIN
_ALL_ORIGINS

Functions

_testOrigin

Variables

`<Const>` NULL_ORIGIN

● NULL_ORIGIN: "null" = "null"

Defined in cors/cors.utils.ts:11

`<Const>` _ALL_ORIGINS

● _ALL_ORIGINS: ""* = "*"

Defined in cors/cors.utils.ts:8

Functions

_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

ibm-wch-sdk-utils > "debug/debug.utils"

External module: "debug/debug.utils"

Index

Type aliases

AddDebugCallback

Variables

COUNTER
_isFrozen

Functions

_addDebugInfo
_addSourceCallback
_addSourceDebug
_getCounter

Type aliases

AddDebugCallback

Ƭ AddDebugCallback: function

Defined in debug/debug.utils.ts:13

Type declaration

▸(aDbg: any): void

Parameters:

Param	Type
aDbg	`any`

Returns: void

Variables

`<Let>` COUNTER

● COUNTER: number = 0

Defined in debug/debug.utils.ts:5

`<Const>` _isFrozen

● _isFrozen: isFrozen = Object.isFrozen

Defined in debug/debug.utils.ts:11

Functions

_addDebugInfo

▸ _addDebugInfo<T>(aCallback: AddDebugCallback, 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
aObject	`T`	the object

Returns: T the object

_addSourceCallback

▸ _addSourceCallback(aSource: string): AddDebugCallback

Defined in debug/debug.utils.ts:18

Adds source information

Parameters:

Param	Type
aSource	`string`

Returns: AddDebugCallback

_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

_getCounter

▸ _getCounter(): number

Defined in debug/debug.utils.ts:7

Returns: number

ibm-wch-sdk-utils > "elements/element"

External module: "elements/element"

Index

Variables

_PROP_ID
_PROP_SELECTION
_PROP_TYPE
_PROP_TYPE_REF
_PROP_VALUE
_PROP_VALUES

Functions

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

Object literals

HANDLERS

Variables

`<Const>` _PROP_ID

● _PROP_ID: "id" = "id"

Defined in elements/element.ts:82

`<Const>` _PROP_SELECTION

● _PROP_SELECTION: "selection" = "selection"

Defined in elements/element.ts:80

`<Const>` _PROP_TYPE

● _PROP_TYPE: "elementType" = "elementType"

Defined in elements/element.ts:77

`<Const>` _PROP_TYPE_REF

● _PROP_TYPE_REF: "typeRef" = "typeRef"

Defined in elements/element.ts:81

`<Const>` _PROP_VALUE

● _PROP_VALUE: "value" = "value"

Defined in elements/element.ts:78

`<Const>` _PROP_VALUES

● _PROP_VALUES: "values" = "values"

Defined in elements/element.ts:79

Functions

`<Const>` _falseHandler

▸ _falseHandler(): boolean

Defined in elements/element.ts:570

Returns: boolean

`<Const>` _getHandler

▸ _getHandler(aElementType: string): Predicate<any>

Defined in elements/element.ts:572

Parameters:

Param	Type
aElementType	`string`

Returns: Predicate<any>

_isCategoryElement

▸ _isCategoryElement(aValue: any): boolean

Defined in elements/element.ts:332

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isDateElement

▸ _isDateElement(aValue: any): boolean

Defined in elements/element.ts:322

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_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

_isFile

▸ _isFile(aValue: any): boolean

Defined in elements/element.ts:346

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isFileElement

▸ _isFileElement(aValue: any): boolean

Defined in elements/element.ts:342

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isFormattedTextElement

▸ _isFormattedTextElement(aValue: any): boolean

Defined in elements/element.ts:222

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_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

_isGroupElement

▸ _isGroupElement(aValue: any): boolean

Defined in elements/element.ts:182

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isImage

▸ _isImage(aValue: any): boolean

Defined in elements/element.ts:358

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isImageElement

▸ _isImageElement(aValue: any): boolean

Defined in elements/element.ts:398

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isLink

▸ _isLink(aValue: any): boolean

Defined in elements/element.ts:354

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isLinkElement

▸ _isLinkElement(aValue: any): boolean

Defined in elements/element.ts:312

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isLocationElement

▸ _isLocationElement(aValue: any): boolean

Defined in elements/element.ts:498

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiDateElement

▸ _isMultiDateElement(aValue: any): boolean

Defined in elements/element.ts:172

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiFileElement

▸ _isMultiFileElement(aValue: any): boolean

Defined in elements/element.ts:378

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiFormattedTextElement

▸ _isMultiFormattedTextElement(aValue: any): boolean

Defined in elements/element.ts:242

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiGroupElement

▸ _isMultiGroupElement(aValue: any): boolean

Defined in elements/element.ts:212

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiImageElement

▸ _isMultiImageElement(aValue: any): boolean

Defined in elements/element.ts:418

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiLinkElement

▸ _isMultiLinkElement(aValue: any): boolean

Defined in elements/element.ts:458

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiNumberElement

▸ _isMultiNumberElement(aValue: any): boolean

Defined in elements/element.ts:272

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiOptionSelectionElement

▸ _isMultiOptionSelectionElement(aValue: any): boolean

Defined in elements/element.ts:122

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiReferenceElement

▸ _isMultiReferenceElement(aValue: any): boolean

Defined in elements/element.ts:488

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiTextElement

▸ _isMultiTextElement(aValue: any): boolean

Defined in elements/element.ts:152

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiToggleElement

▸ _isMultiToggleElement(aValue: any): boolean

Defined in elements/element.ts:302

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isMultiVideoElement

▸ _isMultiVideoElement(aValue: any): boolean

Defined in elements/element.ts:438

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isNumberElement

▸ _isNumberElement(aValue: any): boolean

Defined in elements/element.ts:252

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isOptionSelection

▸ _isOptionSelection(aValue: any): boolean

Defined in elements/element.ts:102

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isOptionSelectionElement

▸ _isOptionSelectionElement(aValue: any): boolean

Defined in elements/element.ts:98

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isReferenceElement

▸ _isReferenceElement(aValue: any): boolean

Defined in elements/element.ts:468

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleDateElement

▸ _isSingleDateElement(aValue: any): boolean

Defined in elements/element.ts:162

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleFileElement

▸ _isSingleFileElement(aValue: any): boolean

Defined in elements/element.ts:368

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleFormattedTextElement

▸ _isSingleFormattedTextElement(aValue: any): boolean

Defined in elements/element.ts:232

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleGroupElement

▸ _isSingleGroupElement(aValue: any): boolean

Defined in elements/element.ts:202

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleImageElement

▸ _isSingleImageElement(aValue: any): boolean

Defined in elements/element.ts:408

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleLinkElement

▸ _isSingleLinkElement(aValue: any): boolean

Defined in elements/element.ts:448

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleNumberElement

▸ _isSingleNumberElement(aValue: any): boolean

Defined in elements/element.ts:262

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleOptionSelectionElement

▸ _isSingleOptionSelectionElement(aValue: any): boolean

Defined in elements/element.ts:112

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleReferenceElement

▸ _isSingleReferenceElement(aValue: any): boolean

Defined in elements/element.ts:478

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleTextElement

▸ _isSingleTextElement(aValue: any): boolean

Defined in elements/element.ts:142

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleToggleElement

▸ _isSingleToggleElement(aValue: any): boolean

Defined in elements/element.ts:292

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSingleVideoElement

▸ _isSingleVideoElement(aValue: any): boolean

Defined in elements/element.ts:428

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeDateElement

▸ _isSomeDateElement(aValue: any): boolean

Defined in elements/element.ts:502

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeFileElement

▸ _isSomeFileElement(aValue: any): boolean

Defined in elements/element.ts:506

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeFormattedTextElement

▸ _isSomeFormattedTextElement(aValue: any): boolean

Defined in elements/element.ts:510

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeGroupElement

▸ _isSomeGroupElement(aValue: any): boolean

Defined in elements/element.ts:514

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeImageElement

▸ _isSomeImageElement(aValue: any): boolean

Defined in elements/element.ts:518

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeLinkElement

▸ _isSomeLinkElement(aValue: any): boolean

Defined in elements/element.ts:522

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeNumberElement

▸ _isSomeNumberElement(aValue: any): boolean

Defined in elements/element.ts:526

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeOptionSelectionElement

▸ _isSomeOptionSelectionElement(aValue: any): boolean

Defined in elements/element.ts:530

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeReferenceElement

▸ _isSomeReferenceElement(aValue: any): boolean

Defined in elements/element.ts:534

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeTextElement

▸ _isSomeTextElement(aValue: any): boolean

Defined in elements/element.ts:538

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeToggleElement

▸ _isSomeToggleElement(aValue: any): boolean

Defined in elements/element.ts:542

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isSomeVideoElement

▸ _isSomeVideoElement(aValue: any): boolean

Defined in elements/element.ts:546

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isTextElement

▸ _isTextElement(aValue: any): boolean

Defined in elements/element.ts:132

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isToggleElement

▸ _isToggleElement(aValue: any): boolean

Defined in elements/element.ts:282

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isType

▸ _isType(aType: string, aValue: * any | null | undefined*): boolean

Defined in elements/element.ts:84

Parameters:

Param	Type
aType	`string`
aValue	`any` \| `null` \| `undefined`

Returns: boolean

_isTypeRef

▸ _isTypeRef(aValue: any): boolean

Defined in elements/element.ts:88

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isVideo

▸ _isVideo(aValue: any): boolean

Defined in elements/element.ts:350

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_isVideoElement

▸ _isVideoElement(aValue: any): boolean

Defined in elements/element.ts:388

Parameters:

Param	Type
aValue	`any`

Returns: boolean

Object literals

`<Const>` HANDLERS

HANDLERS: object

Defined in elements/element.ts:553

Maps from element type to handler function

__computed

● __computed: _isSomeVideoElement = _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

ibm-wch-sdk-utils > "error/error"

External module: "error/error"

Index

Functions

isErrorResponse

Functions

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

ibm-wch-sdk-utils > "generators/generator"

External module: "generators/generator"

Index

Type aliases

Generator

Functions

_arrayGenerator
_objectGenerator

Type aliases

Generator

Ƭ Generator: function

Defined in generators/generator.ts:3

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

Functions

`<Const>` _arrayGenerator

▸ _arrayGenerator<T>(): T[]

Defined in generators/generator.ts:5

Type parameters:

T

Returns: T[]

`<Const>` _objectGenerator

▸ _objectGenerator(): any

Defined in generators/generator.ts:6

Returns: any

ibm-wch-sdk-utils > "generators/lazy.generator"

External module: "generators/lazy.generator"

Index

Functions

_lazyGenerator

Functions

_lazyGenerator

▸ _lazyGenerator<T>(aGenerator: Generator<T>): Generator<T>

Defined in generators/lazy.generator.ts:10

Creates a lazy generator for the value

Type parameters:

T

Parameters:

Param	Type	Description
aGenerator	Generator<`T`>	the generator

Returns: Generator<T> the generator

ibm-wch-sdk-utils > "hash/hash.utils"

External module: "hash/hash.utils"

Index

Variables

GOLDEN_RATIO_64
HASH_SEED_64
_DIGITS
_FIRST_LETTERS
_FIRST_LETTERS_LENGTH
_LOWERCASE
_MAX_INT
_NEXT_LETTERS
_NEXT_LETTERS_LENGTH
_START
_UPPERCASE
_abs
_floor
_random
_trunc

Functions

_hashString
_hashStringSegment
_hashToIdentifier
_longCombine
_longHash
_randomIdentifier

Variables

`<Const>` GOLDEN_RATIO_64

● GOLDEN_RATIO_64: 1140071481932319900 = 1140071481932319900

Defined in hash/hash.utils.ts:8

`<Const>` HASH_SEED_64

● HASH_SEED_64: 5177618702824568000 = 5177618702824568000

Defined in hash/hash.utils.ts:11

`<Const>` _DIGITS

● _DIGITS: "0123456789" = "0123456789"

Defined in hash/hash.utils.ts:41

`<Const>` _FIRST_LETTERS

● _FIRST_LETTERS: string = _START + _LOWERCASE + _UPPERCASE

Defined in hash/hash.utils.ts:46

`<Const>` _FIRST_LETTERS_LENGTH

● _FIRST_LETTERS_LENGTH: number = _FIRST_LETTERS.length

Defined in hash/hash.utils.ts:48

`<Const>` _LOWERCASE

● _LOWERCASE: "abcdefghijklmnopqrstuvwxyz" = "abcdefghijklmnopqrstuvwxyz"

Defined in hash/hash.utils.ts:42

`<Const>` _MAX_INT

● _MAX_INT: number = Number.MAX_SAFE_INTEGER

Defined in hash/hash.utils.ts:78

`<Const>` _NEXT_LETTERS

● _NEXT_LETTERS: string = _FIRST_LETTERS + _DIGITS

Defined in hash/hash.utils.ts:47

`<Const>` _NEXT_LETTERS_LENGTH

● _NEXT_LETTERS_LENGTH: number = _NEXT_LETTERS.length

Defined in hash/hash.utils.ts:49

`<Const>` _START

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

Defined in hash/hash.utils.ts:40

`<Const>` _UPPERCASE

● _UPPERCASE: string = _LOWERCASE.toUpperCase()

Defined in hash/hash.utils.ts:43

`<Const>` _abs

● _abs: abs = Math.abs

Defined in hash/hash.utils.ts:52

`<Const>` _floor

● _floor: floor = Math.floor

Defined in hash/hash.utils.ts:53

`<Const>` _random

● _random: random = Math.random

Defined in hash/hash.utils.ts:76

`<Const>` _trunc

● _trunc: trunc = Math.trunc

Defined in hash/hash.utils.ts:77

Functions

_hashString

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

Defined in hash/hash.utils.ts:35

Parameters:

Param	Type
oldHash	`number`
s	`string`

Returns: number

_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

_hashToIdentifier

▸ _hashToIdentifier(aHash: number): string

Defined in hash/hash.utils.ts:61

Parameters:

Param	Type
aHash	`number`

Returns: string

_longCombine

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

Defined in hash/hash.utils.ts:22

Parameters:

Param	Type
oldHash	`number`
data	`number`

Returns: number

_longHash

▸ _longHash(): number

Defined in hash/hash.utils.ts:18

Returns: number

_randomIdentifier

▸ _randomIdentifier(): string

Defined in hash/hash.utils.ts:85

Returns: string

ibm-wch-sdk-utils > "http/http.utils"

External module: "http/http.utils"

Index

Interfaces

HttpOptions
HttpService

Type aliases

Request

Variables

DEFAULT_POLL_TIME
DEFAULT_POLL_TIME_VARIATION
DEFAULT_RETRIES
DEFAULT_USE_API
DEFAULT_USE_BOOTSTRAP
DEFAULT_USE_JSONP
DEFAULT_USE_LOCAL_STORAGE
DEFAULT_USE_POLLING
DEFAULT_USE_STATIC_RESOURCES
ID
LOGGER
MAX_POLL_TIME
MAX_POLL_TIME_VARIATION
MIN_POLL_TIME
MIN_POLL_TIME_VARIATION
_addDebugSource
_privateUrlJsonCache
_privateUrlStringCache
_publicUrlJsonCache
_publicUrlStringCache

Functions

_addDebug
_clip
_createJsonResource
_createStringResource
_createTimer
_getErrorResponse
_getJsonResource
_getStringResource
_sendJsonRequest
_sendRequest
_sendTextRequest

Object literals

DEFAULT_HTTP_RESOURCE_OPTIONS

Type aliases

Request

Ƭ Request: function

Defined in http/http.utils.ts:49

Type declaration

▸(aUrl: string, aOptions: HttpOptions): Observable<T>

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions

Returns: Observable<T>

Variables

`<Const>` DEFAULT_POLL_TIME

● DEFAULT_POLL_TIME: number = 10 * 1000

Defined in http/http.utils.ts:160

`<Const>` DEFAULT_POLL_TIME_VARIATION

● DEFAULT_POLL_TIME_VARIATION: 0.15 = 0.15

Defined in http/http.utils.ts:155

`<Const>` DEFAULT_RETRIES

● DEFAULT_RETRIES: 10 = 10

Defined in http/http.utils.ts:165

`<Const>` DEFAULT_USE_API

● DEFAULT_USE_API: true = true

Defined in http/http.utils.ts:175

`<Const>` DEFAULT_USE_BOOTSTRAP

● DEFAULT_USE_BOOTSTRAP: true = true

Defined in http/http.utils.ts:185

`<Const>` DEFAULT_USE_JSONP

● DEFAULT_USE_JSONP: true = true

Defined in http/http.utils.ts:190

`<Const>` DEFAULT_USE_LOCAL_STORAGE

● DEFAULT_USE_LOCAL_STORAGE: true = true

Defined in http/http.utils.ts:170

`<Const>` DEFAULT_USE_POLLING

● DEFAULT_USE_POLLING: true = true

Defined in http/http.utils.ts:195

`<Const>` DEFAULT_USE_STATIC_RESOURCES

● DEFAULT_USE_STATIC_RESOURCES: true = true

Defined in http/http.utils.ts:180

`<Let>` ID

● ID: number = 0

Defined in http/http.utils.ts:46

`<Const>` LOGGER

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

Defined in http/http.utils.ts:31

`<Const>` MAX_POLL_TIME

● MAX_POLL_TIME: number = Number.MAX_SAFE_INTEGER

Defined in http/http.utils.ts:199

`<Const>` MAX_POLL_TIME_VARIATION

● MAX_POLL_TIME_VARIATION: 0.5 = 0.5

Defined in http/http.utils.ts:203

`<Const>` MIN_POLL_TIME

● MIN_POLL_TIME: 1000 = 1000

Defined in http/http.utils.ts:198

`<Const>` MIN_POLL_TIME_VARIATION

Param	Type
t1	`T1`
t2	`T2`

Returns: R

Functions

_addDebug

▸ _addDebug(aUrl: string, aResult: JsonMap): JsonMap

Defined in http/http.utils.ts:276

Add debugging information to the result

Parameters:

Param	Type	Description
aUrl	`string`	the URL
aResult	JsonMap	the result

Returns: JsonMap

_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

_createJsonResource

▸ _createJsonResource(aURL: string, aHttpService: HttpService, aWithCredentials: boolean, aTrigger: Observable<any>, aOptions: HttpResourceOptions, aLogger?: Logger): Observable<AnyJson>

Defined in http/http.utils.ts:286

Parameters:

Param	Type
aURL	`string`
aHttpService	HttpService
aWithCredentials	`boolean`
aTrigger	`Observable`<`any`>
aOptions	`HttpResourceOptions`
`Optional` aLogger	`Logger`

Returns: Observable<AnyJson>

_createStringResource

▸ _createStringResource(aURL: string, aHttpService: HttpService, 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
aWithCredentials	`boolean`
aTrigger	`Observable`<`any`>
aOptions	`HttpResourceOptions`
`Optional` aLogger	`Logger`

Returns: Observable<string>

_createTimer

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

Defined in http/http.utils.ts:242

Parameters:

Param	Type
`Optional` aOptions	`HttpResourceOptions`

Returns: Observable<any>

_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

_getJsonResource

▸ _getJsonResource(aURL: string, aHttpService: HttpService, aWithCredentials: boolean, aTrigger: Observable<any>, aOptions?: HttpResourceOptions, aLogger?: Logger): Observable<AnyJson>

Defined in http/http.utils.ts:354

Parameters:

Param	Type
aURL	`string`
aHttpService	HttpService
aWithCredentials	`boolean`
aTrigger	`Observable`<`any`>
`Optional` aOptions	`HttpResourceOptions`
`Optional` aLogger	`Logger`

Returns: Observable<AnyJson>

_getStringResource

▸ _getStringResource(aURL: string, aHttpService: HttpService, 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
aWithCredentials	`boolean`
aTrigger	`Observable`<`any`>
aOptions	`HttpResourceOptions`
`Optional` aLogger	`Logger`

Returns: Observable<string>

_sendJsonRequest

▸ _sendJsonRequest<T>(aUrl: string, aOptions: HttpOptions, aTrigger: Observable<any>, aHttpService: HttpService, aLogger?: Logger): Observable<T>

Defined in http/http.utils.ts:130

Type parameters:

T

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions
aTrigger	`Observable`<`any`>
aHttpService	HttpService
`Optional` aLogger	`Logger`

Returns: Observable<T>

_sendRequest

▸ _sendRequest<T>(aUrl: string, aOptions: HttpOptions, aTrigger: Observable<any>, aRequest: Request<T>, aLogger: Logger): Observable<T>

Defined in http/http.utils.ts:84

Type parameters:

T

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions
aTrigger	`Observable`<`any`>
aRequest	Request<`T`>
aLogger	`Logger`

Returns: Observable<T>

_sendTextRequest

▸ _sendTextRequest(aUrl: string, aOptions: HttpOptions, aTrigger: Observable<any>, aHttpService: HttpService, aLogger?: Logger): Observable<string>

Defined in http/http.utils.ts:146

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions
aTrigger	`Observable`<`any`>
aHttpService	HttpService
`Optional` aLogger	`Logger`

Returns: Observable<string>

Object literals

`<Const>` DEFAULT_HTTP_RESOURCE_OPTIONS

DEFAULT_HTTP_RESOURCE_OPTIONS: object

Defined in http/http.utils.ts:216

pollTime

● pollTime: number = DEFAULT_POLL_TIME

Defined in http/http.utils.ts:218

pollTimeVariation

● pollTimeVariation: number = DEFAULT_POLL_TIME_VARIATION

Defined in http/http.utils.ts:217

retries

● retries: number = DEFAULT_RETRIES

Defined in http/http.utils.ts:219

useApi

● useApi: true = DEFAULT_USE_API

Defined in http/http.utils.ts:225

useBootstrap

● useBootstrap: true = DEFAULT_USE_BOOTSTRAP

Defined in http/http.utils.ts:221

useJsonP

● useJsonP: true = DEFAULT_USE_JSONP

Defined in http/http.utils.ts:223

useLocalStorage

● useLocalStorage: true = DEFAULT_USE_LOCAL_STORAGE

Defined in http/http.utils.ts:220

usePolling

● usePolling: true = DEFAULT_USE_POLLING

Defined in http/http.utils.ts:224

useStaticResources

● useStaticResources: true = DEFAULT_USE_STATIC_RESOURCES

Defined in http/http.utils.ts:222

ibm-wch-sdk-utils > "idle/idle"

External module: "idle/idle"

Index

Variables

_cancelCallback
_setCallback
cancelIdleCallback
requestIdleCallback

Variables

`<Let>` _cancelCallback

● _cancelCallback: function

Defined in idle/idle.ts:5

Type declaration

▸(aHandle: number): void

Parameters:

Param	Type
aHandle	`number`

Returns: void

`<Let>` _setCallback

● _setCallback: function

Defined in idle/idle.ts:4

Type declaration

▸(aFct: Function): number

Parameters:

Param	Type
aFct	`Function`

Returns: number

cancelIdleCallback

● cancelIdleCallback: function

Defined in idle/idle.ts:8

Type declaration

▸(aHandle: number): void

Parameters:

Param	Type
aHandle	`number`

Returns: void

requestIdleCallback

● requestIdleCallback: function

Defined in idle/idle.ts:7

Type declaration

▸(aCallback: Function): number

Parameters:

Param	Type
aCallback	`Function`

Returns: number

ibm-wch-sdk-utils > "index"

External module: "index"

Index

ibm-wch-sdk-utils > "js/js.utils"

External module: "js/js.utils"

Index

Variables

KEY_DEBUG
_FUNCTION_TYPE
_UNDEFINED_TYPE
_freeze
_isFrozen
_keys

Functions

_anyToString
_arrayEquals
_assertArray
_assertFromGenerator
_assertObject
_cloneDeep
_createGetter
_deepEquals
_forEach
_forIn
_freezeDeep
_lastElement
_objectAssign
_objectEquals
_push
_random
_reduceForIn
_toInteger

Variables

`<Const>` KEY_DEBUG

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

Defined in js/js.utils.ts:5

`<Const>` _FUNCTION_TYPE

= typeof _keys

Defined in js/js.utils.ts:173

`<Const>` _UNDEFINED_TYPE

= typeof undefined

Defined in js/js.utils.ts:172

`<Const>` _freeze

● _freeze: freeze = Object.freeze

Defined in js/js.utils.ts:12

`<Const>` _isFrozen

● _isFrozen: isFrozen = Object.isFrozen

Defined in js/js.utils.ts:13

`<Const>` _keys

● _keys: keys = Object.keys

Defined in js/js.utils.ts:10

Functions

`<Const>` _anyToString

▸ _anyToString(aValue: any): string

Defined in js/js.utils.ts:101

Parameters:

Param	Type
aValue	`any`

Returns: string

`<Const>` _arrayEquals

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

Defined in js/js.utils.ts:22

Type parameters:

T

Parameters:

Param	Type
aLeft	`T`[]
aRight	`T`[]
aPredicate	EqualsPredicate<`T`>

Returns: boolean

`<Const>` _assertArray

▸ _assertArray<T>(aKey: * number | string | symbol*, aObject: any): T[]

Defined in js/js.utils.ts:146

Type parameters:

T

Parameters:

Param	Type
aKey	`number` \| `string` \| `symbol`
aObject	`any`

Returns: T[]

`<Const>` _assertFromGenerator

▸ _assertFromGenerator<T>(aKey: * number | string | symbol*, aObject: any, aGenerator: Generator<T>): T

Defined in js/js.utils.ts:142

Type parameters:

T

Parameters:

Param	Type
aKey	`number` \| `string` \| `symbol`
aObject	`any`
aGenerator	Generator<`T`>

Returns: T

`<Const>` _assertObject

▸ _assertObject<T>(aKey: * number | string | symbol*, aObject: any): T

Defined in js/js.utils.ts:144

Type parameters:

T

Parameters:

Param	Type
aKey	`number` \| `string` \| `symbol`
aObject	`any`

Returns: T

_cloneDeep

▸ _cloneDeep(aValue: any): any

Defined in js/js.utils.ts:123

Parameters:

Param	Type
aValue	`any`

Returns: any

_createGetter

▸ _createGetter<T>(aGetter: Generator<T>): PropertyDescriptor

Defined in js/js.utils.ts:224

Constructs a getter description

Type parameters:

T

Parameters:

Param	Type	Description
aGetter	Generator<`T`>	the getter

Returns: PropertyDescriptor the description of the getter

`<Const>` _deepEquals

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

Defined in js/js.utils.ts:84

Parameters:

Param	Type
aLeft	`any`
aRight	`any`

Returns: boolean

_forEach

▸ _forEach<T>(aArray: T[], aConsumer: Consumer<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<`T`>	consumer callback

Returns: void

_forIn

▸ _forIn<T>(aObject: object, aConsumer: BiConsumer<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<`T`, `string`>	consumer callback

Returns: void

_freezeDeep

▸ _freezeDeep(aValue: any): any

Defined in js/js.utils.ts:181

Parameters:

Param	Type
aValue	`any`

Returns: any

`<Const>` _lastElement

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

Defined in js/js.utils.ts:148

Type parameters:

T

Parameters:

Param	Type
aArray	`T`[]

Returns: T

`<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

`<Const>` _objectEquals

▸ _objectEquals(aLeft: any, aRight: any, aPredicate: EqualsPredicate<any>): boolean

Defined in js/js.utils.ts:52

Parameters:

Param	Type
aLeft	`any`
aRight	`any`
aPredicate	EqualsPredicate<`any`>

Returns: boolean

`<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[]

_random

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

Defined in js/js.utils.ts:214

Parameters:

Param	Type
aMin	`number`
aMax	`number`

Returns: number

_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

_toInteger

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

Defined in js/js.utils.ts:156

Parameters:

Param	Type
aValue	`any`
aDefault	`number`

Returns: number

ibm-wch-sdk-utils > "json/json.utils"

External module: "json/json.utils"

Index

Interfaces

JsonArray

Type aliases

AnyJson
JsonMap

Functions

_jsonParse
_jsonStringify

Type aliases

AnyJson

Defined in json/json.utils.ts:3

JsonMap

Ƭ JsonMap: any

Defined in json/json.utils.ts:4

Functions

`<Const>` _jsonParse

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

Defined in json/json.utils.ts:7

Type parameters:

T

Parameters:

Param	Type
aValue	`string`

Returns: T

`<Const>` _jsonStringify

▸ _jsonStringify(aValue: AnyJson): string

Defined in json/json.utils.ts:8

Parameters:

Param	Type
aValue	AnyJson

Returns: string

ibm-wch-sdk-utils > "layouts/layout"

External module: "layouts/layout"

Index

Variables

DEFAULT_LAYOUT_MAPPING
DEFAULT_LAYOUT_MODE
LAYOUT_MODE_ERROR
LAYOUT_MODE_FOOTER
LAYOUT_MODE_HEADER
LAYOUT_MODE_NAVIGATION
LAYOUT_TEMPLATE_ERROR
LAYOUT_TEMPLATE_FOOTER
LAYOUT_TEMPLATE_HEADER
LAYOUT_TEMPLATE_NAVIGATION
LAYOUT_TYPE_ANGULAR

Object literals

LAYOUT_ERROR
LAYOUT_FOOTER
LAYOUT_HEADER
LAYOUT_NAVIGATION

Variables

`<Const>` DEFAULT_LAYOUT_MAPPING

● DEFAULT_LAYOUT_MAPPING: object

Defined in layouts/layout.ts:37

Type declaration

`<Const>` DEFAULT_LAYOUT_MODE

● DEFAULT_LAYOUT_MODE: "default" = "default"

Defined in layouts/layout.ts:4

`<Const>` LAYOUT_MODE_ERROR

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

Defined in layouts/layout.ts:10

`<Const>` LAYOUT_MODE_FOOTER

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

Defined in layouts/layout.ts:9

`<Const>` LAYOUT_MODE_HEADER

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

Defined in layouts/layout.ts:8

`<Const>` LAYOUT_MODE_NAVIGATION

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

Defined in layouts/layout.ts:7

`<Const>` LAYOUT_TEMPLATE_ERROR

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

Defined in layouts/layout.ts:15

`<Const>` LAYOUT_TEMPLATE_FOOTER

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

Defined in layouts/layout.ts:14

`<Const>` LAYOUT_TEMPLATE_HEADER

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

Defined in layouts/layout.ts:13

`<Const>` LAYOUT_TEMPLATE_NAVIGATION

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

Defined in layouts/layout.ts:12

`<Const>` LAYOUT_TYPE_ANGULAR

● LAYOUT_TYPE_ANGULAR: "angular" = "angular"

● templateType: string = LAYOUT_TYPE_ANGULAR

Defined in layouts/layout.ts:18

ibm-wch-sdk-utils > "logger/console.logger"

External module: "logger/console.logger"

Index

Variables

CONSOLE_ERROR
CONSOLE_INFO
CONSOLE_WARN
_console

Functions

createConsoleLogger
createEmptyLogger

Variables

`<Const>` CONSOLE_ERROR

● CONSOLE_ERROR: error = _console.error

Defined in logger/console.logger.ts:9

`<Const>` CONSOLE_INFO

● CONSOLE_INFO: info = _console.info

Defined in logger/console.logger.ts:8

`<Const>` CONSOLE_WARN

● CONSOLE_WARN: warn = _console.warn

Defined in logger/console.logger.ts:10

`<Const>` _console

● _console: Console = console

Defined in logger/console.logger.ts:7

Functions

`<Const>` createConsoleLogger

▸ createConsoleLogger(aName: string): object

Defined in logger/console.logger.ts:13

Parameters:

Param	Type
aName	`string`

Returns: object

`<Const>` createEmptyLogger

▸ createEmptyLogger(aName: string): object

Defined in logger/console.logger.ts:19

Parameters:

Param	Type
aName	`string`

Returns: object

ibm-wch-sdk-utils > "logger/noop.logger"

External module: "logger/noop.logger"

Index

Object literals

NOOP_LOGGER

Object literals

`<Const>` NOOP_LOGGER

NOOP_LOGGER: object

Defined in logger/noop.logger.ts:7

Logger that really does not log anything

error

● error: noop = noop

Defined in logger/noop.logger.ts:10

info

● info: noop = noop

Defined in logger/noop.logger.ts:8

warn

● warn: noop = noop

Defined in logger/noop.logger.ts:9

ibm-wch-sdk-utils > "logger/noop.logger.service"

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

Index

Object literals

NOOP_LOGGER_SERVICE

Object literals

`<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

get

▸ get(aName: string): object

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

Parameters:

Param	Type
aName	`string`

Returns: object

ibm-wch-sdk-utils > "messages/message.event"

External module: "messages/message.event"

Index

Variables

RESPONSE_SUFFIX
_SUBSCRIPTIONS

Functions

_createMessageHandler
_createSdkErrorResponse
_getMessagePort
_isSdkEvent
_processMessage
_registerSubscription
_sendResponse
_unsubscribe

Variables

`<Const>` RESPONSE_SUFFIX

● RESPONSE_SUFFIX: "Response" = "Response"

Defined in messages/message.event.ts:14

`<Const>` _SUBSCRIPTIONS

● _SUBSCRIPTIONS: object

Defined in messages/message.event.ts:17

Type declaration

Functions

_createMessageHandler

▸ _createMessageHandler(aCorsWhitelist: Generator<PromiseLike<string[]>>, aMsgHandlers: Generator<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<`PromiseLike`<`string`[]>>	generator that produces a CORS whitelist
aMsgHandlers	Generator<`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

_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

_getMessagePort

▸ _getMessagePort(aEvent: MessageEvent): MessagePort

Defined in messages/message.event.ts:82

Parameters:

Param	Type
aEvent	`MessageEvent`

Returns: MessagePort

_isSdkEvent

▸ _isSdkEvent(aPayload: any): boolean

Defined in messages/message.event.ts:49

Parameters:

Param	Type
aPayload	`any`

Returns: boolean

_processMessage

▸ _processMessage(aData: SdkMessagePayload, aEvent: MessageEvent, aMsgHandlers: Generator<SdkMessageHandler[]>, aLogger: Logger): PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined

Defined in messages/message.event.ts:130

Parameters:

Param	Type
aData	`SdkMessagePayload`
aEvent	`MessageEvent`
aMsgHandlers	Generator<`SdkMessageHandler`[]>
aLogger	`Logger`

Returns: PromiseLike<SdkMessagePayload> | SdkMessagePayload | null | undefined

_registerSubscription

▸ _registerSubscription(aSubscription: Subscription): string

Defined in messages/message.event.ts:36

Parameters:

Param	Type
aSubscription	`Subscription`

Returns: string

_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

_unsubscribe

▸ _unsubscribe(aHandle: string): void

Defined in messages/message.event.ts:24

Parameters:

Param	Type
aHandle	`string`

Returns: void

ibm-wch-sdk-utils > "messages/navigate.by.path.handler"

External module: "messages/navigate.by.path.handler"

Index

Functions

_createSdkNavigateByPathResponse
_isSdkNavigateByPathEvent
createNavigateByPathHandler

Functions

_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

_isSdkNavigateByPathEvent

▸ _isSdkNavigateByPathEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/navigate.by.path.handler.ts:20

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "messages/refresh.handler"

External module: "messages/refresh.handler"

Index

Functions

_isSdkRefreshEvent
createRefreshHandler

Functions

_isSdkRefreshEvent

▸ _isSdkRefreshEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/refresh.handler.ts:12

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "messages/set.mode.handler"

External module: "messages/set.mode.handler"

Index

Functions

_createSdkSetModeResponse
_isProtected
_isSdkSetModeEvent
createSetModeHandler

Functions

_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

_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

_isSdkSetModeEvent

▸ _isSdkSetModeEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/set.mode.handler.ts:22

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

createSetModeHandler

▸ createSetModeHandler(aPublicApiHandler: Consumer<boolean>, aLogger?: Logger): SdkMessageHandlerCallback

Defined in messages/set.mode.handler.ts:60

Executes a navigation event

Parameters:

Param	Type
aPublicApiHandler	Consumer<`boolean`>
`Optional` aLogger	`Logger`

Returns: SdkMessageHandlerCallback

ibm-wch-sdk-utils > "messages/subscribe.active.route.handler"

External module: "messages/subscribe.active.route.handler"

Index

Functions

_createSdkActiveRouteEvent
_createSdkSubscribeActiveRouteEventResponse
_isSdkSubscribeActiveRouteEvent
createSubscribeActiveRouteHandler

Functions

_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

_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

_isSdkSubscribeActiveRouteEvent

▸ _isSdkSubscribeActiveRouteEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/subscribe.active.route.handler.ts:69

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "messages/subscribe.handler"

External module: "messages/subscribe.handler"

Index

Functions

_isSdkUnsubscribeEvent
createUnsubscribeHandler

Functions

_isSdkUnsubscribeEvent

▸ _isSdkUnsubscribeEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/subscribe.handler.ts:19

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "messages/subscribe.mode.handler"

External module: "messages/subscribe.mode.handler"

Index

Functions

_createSdkModeEvent
_createSdkSubscribeModeEventResponse
_isSdkSubscribeModeEvent
createSubscribeModeHandler

Functions

_createSdkModeEvent

▸ _createSdkModeEvent(aEvent: SdkSubscribeModeEvent, aMode: SdkMode): SdkModeEvent

Defined in messages/subscribe.mode.handler.ts:50

Parameters:

Param	Type
aEvent	`SdkSubscribeModeEvent`
aMode	`SdkMode`

Returns: SdkModeEvent

_createSdkSubscribeModeEventResponse

▸ _createSdkSubscribeModeEventResponse(aEvent: SdkSubscribeModeEvent, aHandle: string): SdkSubscribeModeEventResponse

Defined in messages/subscribe.mode.handler.ts:30

Parameters:

Param	Type
aEvent	`SdkSubscribeModeEvent`
aHandle	`string`

Returns: SdkSubscribeModeEventResponse

_isSdkSubscribeModeEvent

▸ _isSdkSubscribeModeEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/subscribe.mode.handler.ts:67

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "messages/subscribe.route.handler"

External module: "messages/subscribe.route.handler"

Index

Functions

_createSdkRouteEvent
_createSdkSubscribeRouteEventResponse
_isSdkSubscribeRouteEvent
createSubscribeRouteHandler

Functions

_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

_createSdkSubscribeRouteEventResponse

▸ _createSdkSubscribeRouteEventResponse(aEvent: SdkSubscribeRouteEvent, aHandle: string): SdkSubscribeRouteEventResponse

Defined in messages/subscribe.route.handler.ts:55

Parameters:

Param	Type
aEvent	`SdkSubscribeRouteEvent`
aHandle	`string`

Returns: SdkSubscribeRouteEventResponse

_isSdkSubscribeRouteEvent

▸ _isSdkSubscribeRouteEvent(aPayload: SdkMessagePayload): boolean

Defined in messages/subscribe.route.handler.ts:72

Parameters:

Param	Type
aPayload	`SdkMessagePayload`

Returns: boolean

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

ibm-wch-sdk-utils > "misc"

External module: "misc"

Index

ibm-wch-sdk-utils > "operators/operators"

External module: "operators/operators"

Index

Variables

opBoxLayoutMode
opLevels

Functions

deepDistinctUntilChanged
filterArrayOf
filterBoolean
filterNotNil
filterNumber
filterObject
filterString
pageArrayDistinctUntilChanged
pageDistinctUntilChanged
pluckApiOrigin
pluckCurrentPage
pluckDeliveryOrigin
shareLast
typedPluck

Variables

`<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

`<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

`<Const>` deepDistinctUntilChanged

▸ deepDistinctUntilChanged<T>(): function

Defined in operators/operators.ts:16

Type parameters:

T

Returns: function

`<Const>` filterArrayOf

▸ filterArrayOf<T>(aPredicate: IsPredicate<T>): function

Defined in operators/operators.ts:28

Type parameters:

T

Parameters:

Param	Type
aPredicate	IsPredicate<`T`>

Returns: function

`<Const>` filterBoolean

▸ filterBoolean(): function

Defined in operators/operators.ts:25

Returns: function

`<Const>` filterNotNil

▸ filterNotNil<T>(): function

Defined in operators/operators.ts:20

Returns: function

`<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

ibm-wch-sdk-utils > "predicates/predicates"

External module: "predicates/predicates"

Index

Type aliases

EqualsPredicate
IsPredicate
Predicate

Variables

EMPTY_PROTOTYPE
_TO_STRING_FUNCTION
_TO_STRING_STRING
_getPrototypeOf
_toString

Functions

_applyToString
_isAbsoluteUrl
_isArrayOf
_isBoolean
_isDate
_isNil
_isNotNil
_isNumber
_isObjectOf
_isObservable
_isParseableAsDate
_isPlainObject
_isString
_isStringArray
_isUndefined

Type aliases

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

IsPredicate

Ƭ IsPredicate: function

Defined in predicates/predicates.ts:135

Type declaration

▸(aValue: any): boolean

Parameters:

Param	Type
aValue	`any`

Returns: boolean

Predicate

Ƭ Predicate: function

Defined in predicates/predicates.ts:200

Type declaration

▸(aValue: T): boolean

Parameters:

Param	Type
aValue	`T`

Returns: boolean

Variables

`<Const>` EMPTY_PROTOTYPE

● EMPTY_PROTOTYPE: any = _getPrototypeOf({})

Defined in predicates/predicates.ts:104

`<Const>` _TO_STRING_FUNCTION

● _TO_STRING_FUNCTION: string = _applyToString(_applyToString)

Defined in predicates/predicates.ts:31

`<Const>` _TO_STRING_STRING

● _TO_STRING_STRING: string = _applyToString('')

Defined in predicates/predicates.ts:26

`<Const>` _getPrototypeOf

● _getPrototypeOf: getPrototypeOf = Object.getPrototypeOf

Defined in predicates/predicates.ts:103

`<Const>` _toString

● _toString: toString = Object.prototype.toString

Defined in predicates/predicates.ts:11

Functions

_applyToString

▸ _applyToString(aValue: any): string

Defined in predicates/predicates.ts:19

Parameters:

Param	Type
aValue	`any`

Returns: string

_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

_isArrayOf

▸ _isArrayOf<T>(aValue: any, aPredicate: IsPredicate<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<`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

_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

_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

_isNil

▸ _isNil(aObject: any): boolean

Defined in predicates/predicates.ts:89

Parameters:

Param	Type
aObject	`any`

Returns: boolean

_isNotNil

▸ _isNotNil(aObject: any): boolean

Defined in predicates/predicates.ts:99

Parameters:

Param	Type
aObject	`any`

Returns: boolean

_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

_isObjectOf

▸ _isObjectOf<T>(aValue: any, aPredicate: IsPredicate<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<`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

_isObservable

▸ _isObservable(aValue: any): boolean

Defined in predicates/predicates.ts:121

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_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

_isPlainObject

▸ _isPlainObject(aObject: any): boolean

Defined in predicates/predicates.ts:111

Parameters:

Param	Type
aObject	`any`

Returns: boolean

_isString

▸ _isString(aValue: any): boolean

Defined in predicates/predicates.ts:38

Parameters:

Param	Type
aValue	`any`

Returns: boolean

_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

_isUndefined

▸ _isUndefined(aObject: any): boolean

Defined in predicates/predicates.ts:78

Parameters:

Param	Type
aObject	`any`

Returns: boolean

ibm-wch-sdk-utils > "rendering/rendering"

External module: "rendering/rendering"

Index

Enumerations

HandlerKind

Type aliases

ExpressionGetter
HandlerType
ValueConverter
ValueExtractor

Variables

KEY_EXPRESSION
PROPERTY_REGEX
_ELEMENTS
_ELEMENT_TYPE
_EXTRACTORS
_HANDLERS
_HANDLER_KEYS
_VALUE
_VALUES
_ignoreElement
categoryConverter
dateConverter
identityConverter
identityExtractor

Functions

_addTypings
_categoryElement
_dateElement
_decodeExpression
_extractAndConvert
_getExpressionFromAccessor
_getExpressionFromProperty
_groupElement
_handleElement
_parseCategories
_parseCategory
_parseDate
_pluralize
_setMultiValue
_setSingleValue
_valueValuesElement
_valueValuesElements
_valuesElement
_valuesElements
groupConverter
groupReducer
valueValuesExtractor
valuesExtractor

Type aliases

ExpressionGetter

Ƭ ExpressionGetter: Generator<string>

Defined in rendering/rendering.ts:376

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

ValueConverter

Ƭ ValueConverter: UnaryFunction<T, R>

Defined in rendering/rendering.ts:93

Converts a value

ValueExtractor

Ƭ ValueExtractor: UnaryFunction<any, T | T[] | null>

Defined in rendering/rendering.ts:34

Function that extracts a value

Variables

`<Const>` KEY_EXPRESSION

● KEY_EXPRESSION: "45b01348-de92-44a0-8103-7b7dc471ad8c" = "45b01348-de92-44a0-8103-7b7dc471ad8c"

Defined in rendering/rendering.ts:373

`<Const>` PROPERTY_REGEX

● PROPERTY_REGEX: RegExp = /^([^[]+)([\d+])?$/

Defined in rendering/rendering.ts:413

`<Const>` _ELEMENTS

● _ELEMENTS: "elements" = "elements"

Defined in rendering/rendering.ts:26

`<Const>` _ELEMENT_TYPE

● _ELEMENT_TYPE: "elementType" = "elementType"

Defined in rendering/rendering.ts:29

`<Const>` _EXTRACTORS

● _EXTRACTORS: object

Defined in rendering/rendering.ts:39

extractors

Type declaration

`<Const>` _HANDLERS

● _HANDLERS: object

Defined in rendering/rendering.ts:201

Type declaration

`<Const>` _HANDLER_KEYS

● _HANDLER_KEYS: object

Defined in rendering/rendering.ts:212

Records the keys of the registered handlers

Type declaration

`<Const>` _VALUE

● _VALUE: "value" = "value"

Defined in rendering/rendering.ts:28

`<Const>` _VALUES

● _VALUES: "values" = "values"

Defined in rendering/rendering.ts:27

`<Const>` _ignoreElement

● _ignoreElement: noop = noop

Defined in rendering/rendering.ts:300

`<Const>` categoryConverter

● categoryConverter: _parseCategories = _parseCategories

Defined in rendering/rendering.ts:108

Converts a category to a parsed category object

`<Const>` dateConverter

● dateConverter: _parseDate = _parseDate

Defined in rendering/rendering.ts:103

Converts a value to a date object

`<Const>` identityConverter

● identityConverter: identity = identity

Defined in rendering/rendering.ts:98

Identity conversion

`<Const>` identityExtractor

● identityExtractor: identity = identity

Defined in rendering/rendering.ts:68

Nothing to do for extraction

Functions

_addTypings

▸ _addTypings(aRenderingContext: RenderingContext): RenderingContext

Defined in rendering/rendering.ts:332

Parameters:

Param	Type
aRenderingContext	`RenderingContext`

Returns: RenderingContext

_categoryElement

▸ _categoryElement(): void

Defined in rendering/rendering.ts:285

Returns: void

`<Const>` _dateElement

▸ _dateElement(): void

Defined in rendering/rendering.ts:279

Returns: void

_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

_extractAndConvert

▸ _extractAndConvert<T,R>(aExtractor: ValueExtractor<T>, aConverter: ValueConverter<T, R>): ValueExtractor<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<`T`>	the extractor function
aConverter	ValueConverter<`T`, `R`>	the converter

Returns: ValueExtractor<R> the function

_getExpressionFromAccessor

▸ _getExpressionFromAccessor(aPrototype: any, aAccessor: string): string | 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 | undefined

the accessor expression, relative to the rendering context

_getExpressionFromProperty

▸ _getExpressionFromProperty(aPrototype: any, aPropertyKey: string): string | null | 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 | null | undefined

the expression or undefined if it does not exist

`<Const>` _groupElement

▸ _groupElement(): void

Defined in rendering/rendering.ts:273

Returns: void

_handleElement

▸ _handleElement<T,R>(aSingleType: string, aMultiType: string, aName: string, aElement: any, aRenderingContext: any, aExtractor: ValueExtractor<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<`T`>

Returns: void

_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

`<Const>` _parseCategory

▸ _parseCategory(aCategory: string): string[]

Defined in rendering/rendering.ts:50

Parameters:

Param	Type
aCategory	`string`

Returns: string[]

`<Const>` _parseDate

▸ _parseDate(aValue: * number | string | Date*): Date

Defined in rendering/rendering.ts:47

Decodes a value into a date object

Parameters:

Param	Type	Description
aValue	`number` \| `string` \| `Date`	the value

Returns: Date the object

_pluralize

▸ _pluralize(aValue: string): string

Defined in rendering/rendering.ts:193

Parameters:

Param	Type
aValue	`string`

Returns: string

_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

_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

_valueValuesElement

▸ _valueValuesElement<T,R>(aType: string, aConverter: ValueConverter<T, R>): void

Defined in rendering/rendering.ts:219

Type parameters:

T

R

Parameters:

Param	Type
aType	`string`
aConverter	ValueConverter<`T`, `R`>

Returns: void

`<Const>` _valueValuesElements

▸ _valueValuesElements(aTypes: string[]): void

Defined in rendering/rendering.ts:261

Parameters:

Param	Type
aTypes	`string`[]

Returns: void

_valuesElement

▸ _valuesElement<T,R>(aType: string, aConverter: ValueConverter<T, R>): void

Defined in rendering/rendering.ts:240

Type parameters:

T

R

Parameters:

Param	Type
aType	`string`
aConverter	ValueConverter<`T`, `R`>

Returns: void

`<Const>` _valuesElements

▸ _valuesElements(aTypes: string[]): void

Defined in rendering/rendering.ts:268

Parameters:

Param	Type
aTypes	`string`[]

Returns: void

`<Const>` groupConverter

▸ groupConverter(aGroupElement: any): any

Defined in rendering/rendering.ts:114

Parameters:

Param	Type
aGroupElement	`any`

Returns: any

`<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

valueValuesExtractor

▸ valueValuesExtractor(aValue: any): any | 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 | any[]

valuesExtractor

▸ valuesExtractor(aValue: any): any | 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 | any[]

ibm-wch-sdk-utils > "rx/rx.utils"

External module: "rx/rx.utils"

Index

Classes

IdleFrameAction
IdleFrameScheduler

Variables

EMPTY_JSON_OBSERVABLE
EMPTY_STRING_OBSERVABLE
idleFrameScheduler

Functions

_createConsumer
_createGetter
_createSetter
_createSingleSubject
_generateItem
_safeUnsubscribe
_safeUnsubscribeAll
_thisThenThat
_thisThenThats

Variables

`<Const>` EMPTY_JSON_OBSERVABLE

● EMPTY_JSON_OBSERVABLE: Observable<AnyJson> = empty()

Defined in rx/rx.utils.ts:217

`<Const>` EMPTY_STRING_OBSERVABLE

● EMPTY_STRING_OBSERVABLE: Observable<string> = empty()

Defined in rx/rx.utils.ts:212

`<Const>` idleFrameScheduler

● idleFrameScheduler: IScheduler = new IdleFrameScheduler(IdleFrameAction)

Defined in rx/rx.utils.ts:137

Functions

_createConsumer

▸ _createConsumer<T>(aSubject: * Subject<T> | Observer<T>*): Consumer<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`> \| `Observer`<`T`>	the subject that handles the events

Returns: Consumer<T> the binding function

_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

_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

_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

_generateItem

▸ _generateItem<T>(aGenerator: Generator<T>): Observable<T>

Defined in rx/rx.utils.ts:198

Type parameters:

T

Parameters:

Param	Type
aGenerator	Generator<`T`>

Returns: Observable<T>

_safeUnsubscribe

▸ _safeUnsubscribe(aSubscription: * Subscription | null | undefined*): void

Defined in rx/rx.utils.ts:223

Parameters:

Param	Type
aSubscription	`Subscription` \| `null` \| `undefined`

Returns: void

_safeUnsubscribeAll

▸ _safeUnsubscribeAll(aSubscriptions: * Subscription[] | null | undefined*): void

Defined in rx/rx.utils.ts:233

Parameters:

Param	Type
aSubscriptions	`Subscription`[] \| `null` \| `undefined`

Returns: void

_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>

_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>

ibm-wch-sdk-utils > "search/search.utils"

External module: "search/search.utils"

Index

Functions

_escapeKeyValue
_escapeTerm

Functions

_escapeKeyValue

▸ _escapeKeyValue(aKey: string, aTerm: string): string

Defined in search/search.utils.ts:12

Parameters:

Param	Type
aKey	`string`
aTerm	`string`

Returns: string

_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

ibm-wch-sdk-utils > "site/site.utils"

External module: "site/site.utils"

Index

Classes

InternalSiteInformation
SiteInformation

Interfaces

AnalysisContext
AsyncMapping
SyncMapping

Type aliases

ChangeNotification

Variables

IGNORED_SITE_PAGE_FIELDS
LOGGER
NO_ID
UNKNKOWN_ID
_assign
_decodeURIComponent
_encodeURIComponent

Functions

_cloneSitePage
_createPartialSiteContextForSitePage
_createSiteContextFromSearchResult
_getEncodedPath
_getPage
_getSiteURL
_pageArrayEquals
_pageEquals
_siteContextEquals
access
analyzeSite
cloneSiteInfo
dispatchError
doDispatchError
doMarkComplete
doMarkUnused
markComplete
markUnused
registerAsync
registerSync

Type aliases

ChangeNotification

Ƭ ChangeNotification: function

Defined in site/site.utils.ts:105

Type declaration

▸(): void

Returns: void

Variables

`<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

`<Const>` LOGGER

● LOGGER: "SiteUtils" = "SiteUtils"

Defined in site/site.utils.ts:82

`<Const>` NO_ID

● NO_ID: string = null

Defined in site/site.utils.ts:102

`<Const>` UNKNKOWN_ID

● UNKNKOWN_ID: string = undefined

Defined in site/site.utils.ts:97

`<Const>` _assign

● _assign: assign = Object.assign

Defined in site/site.utils.ts:15

`<Const>` _decodeURIComponent

● _decodeURIComponent: decodeURIComponent = decodeURIComponent

Defined in site/site.utils.ts:13

`<Const>` _encodeURIComponent

● _encodeURIComponent: encodeURIComponent = encodeURIComponent

Defined in site/site.utils.ts:14

Functions

_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

_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

_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

_getEncodedPath

▸ _getEncodedPath(aPath: string): string

Defined in site/site.utils.ts:65

Parameters:

Param	Type
aPath	`string`

Returns: string

_getPage

▸ _getPage(aRenderingContext: RenderingContext): SitePage

Defined in site/site.utils.ts:23

Parameters:

Param	Type
aRenderingContext	`RenderingContext`

Returns: SitePage

_getSiteURL

▸ _getSiteURL(aBaseUrl: string, aSiteID?: string): string

Defined in site/site.utils.ts:530

Parameters:

Param	Type
aBaseUrl	`string`
`Optional` aSiteID	`string`

Returns: string

_pageArrayEquals

▸ _pageArrayEquals(aLeft: SitePage[], aRight: SitePage[]): boolean

Defined in site/site.utils.ts:76

Parameters:

Param	Type
aLeft	`SitePage`[]
aRight	`SitePage`[]

Returns: boolean

_pageEquals

▸ _pageEquals(aLeft: SitePage, aRight: SitePage): boolean

Defined in site/site.utils.ts:44

Parameters:

Param	Type
aLeft	`SitePage`
aRight	`SitePage`

Returns: boolean

_siteContextEquals

▸ _siteContextEquals(aLeft: SiteContext, aRight: SiteContext): boolean

Defined in site/site.utils.ts:136

Parameters:

Param	Type
aLeft	`SiteContext`
aRight	`SiteContext`

Returns: boolean

access

▸ access<T>(aKey: string, aDefault: * T | null | undefined*, aMapping: AsyncMapping<T>): BehaviorSubject< T | null | undefined>

Defined in site/site.utils.ts:326

Type parameters:

T

Parameters:

Param	Type
aKey	`string`
aDefault	`T` \| `null` \| `undefined`
aMapping	AsyncMapping<`T`>

Returns: BehaviorSubject< T | null | undefined>

analyzeSite

▸ analyzeSite(aBreadcrumb: SitePage[], aParentPage: SitePage, aChildren: SiteChild[], aContext: AnalysisContext): SitePage[]

Defined in site/site.utils.ts:244

Parameters:

Param	Type
aBreadcrumb	`SitePage`[]
aParentPage	`SitePage`
aChildren	`SiteChild`[]
aContext	AnalysisContext

Returns: SitePage[]

cloneSiteInfo

▸ cloneSiteInfo(aInfo: InternalSiteInformation): InternalSiteInformation

Defined in site/site.utils.ts:147

Parameters:

Param	Type
aInfo	InternalSiteInformation

Returns: InternalSiteInformation

dispatchError

▸ dispatchError(aInfo: InternalSiteInformation, aError: any): void

Defined in site/site.utils.ts:321

Parameters:

Param	Type
aInfo	InternalSiteInformation
aError	`any`

Returns: void

doDispatchError

▸ doDispatchError<T>(aMapping: AsyncMapping<T>, aError: any): void

Defined in site/site.utils.ts:313

Type parameters:

T

Parameters:

Param	Type
aMapping	AsyncMapping<`T`>
aError	`any`

Returns: void

doMarkComplete

▸ doMarkComplete<T>(aMapping: AsyncMapping<T>): void

Defined in site/site.utils.ts:300

Type parameters:

T

Parameters:

Param	Type
aMapping	AsyncMapping<`T`>

Returns: void

doMarkUnused

▸ doMarkUnused<T>(aMapping: AsyncMapping<T>, aValue: * T | null | undefined*): void

Defined in site/site.utils.ts:287

Type parameters:

T

Parameters:

Param	Type
aMapping	AsyncMapping<`T`>
aValue	`T` \| `null` \| `undefined`

Returns: void

markComplete

▸ markComplete(aInfo: InternalSiteInformation): void

Defined in site/site.utils.ts:308

Parameters:

Param	Type
aInfo	InternalSiteInformation

Returns: void

markUnused

▸ markUnused(aInfo: InternalSiteInformation): void

Defined in site/site.utils.ts:295

Parameters:

Param	Type
aInfo	InternalSiteInformation

Returns: void

registerAsync

▸ registerAsync<T>(aKey: string, aContext: T, aOldMap: AsyncMapping<T>, aNewMap: AsyncMapping<T>, aNotifications: ChangeNotification[]): void

Defined in site/site.utils.ts:167

Type parameters:

T

Parameters:

Param	Type
aKey	`string`
aContext	`T`
aOldMap	AsyncMapping<`T`>
aNewMap	AsyncMapping<`T`>
aNotifications	ChangeNotification[]

Returns: void

registerSync

▸ registerSync<T>(aKey: string, aContext: T, aOldMap: SyncMapping<T>, aNewMap: SyncMapping<T>): void

Defined in site/site.utils.ts:206

Type parameters:

T

Parameters:

Param	Type
aKey	`string`
aContext	`T`
aOldMap	SyncMapping<`T`>
aNewMap	SyncMapping<`T`>

Returns: void

ibm-wch-sdk-utils > "site/sites.constants"

External module: "site/sites.constants"

Index

Variables

_DEFAULT_SITE
_EMPTY_SITE
_EMPTY_SITE_CONTEXT
_UNDEFINED_SITE_CONTEXT

Variables

`<Const>` _DEFAULT_SITE

● _DEFAULT_SITE: "default" = "default"

Defined in site/sites.constants.ts:5

`<Const>` _EMPTY_SITE

● _EMPTY_SITE: Site = freezeDeep({ pages: [], id: null })

Defined in site/sites.constants.ts:7

`<Const>` _EMPTY_SITE_CONTEXT

● _EMPTY_SITE_CONTEXT: SiteContext = freezeDeep({ parent: undefined, sibling: [], breadcrumb: [], children: [], site: _EMPTY_SITE })

Defined in site/sites.constants.ts:12

`<Const>` _UNDEFINED_SITE_CONTEXT

● _UNDEFINED_SITE_CONTEXT: SiteContext = freezeDeep({ parent: undefined, sibling: [], breadcrumb: [], children: [], site: undefined })

Defined in site/sites.constants.ts:20

ibm-wch-sdk-utils > "static/static.resources"

External module: "static/static.resources"

Index

Classes

StaticResources

ibm-wch-sdk-utils > "storage/clientstorage"

External module: "storage/clientstorage"

Index

Classes

ClientStorageOnLocalStorage
EmptyClientStorage

Interfaces

ClientStorage

Functions

clientStorageFromStorage
clientStorageFromWindow
createKey
isQuotaExceeded

Functions

clientStorageFromStorage

▸ clientStorageFromStorage(aStorage: * Storage | null | undefined*, aScope: string): ClientStorage

Defined in storage/clientstorage.ts:98

Parameters:

Param	Type
aStorage	`Storage` \| `null` \| `undefined`
aScope	`string`

Returns: ClientStorage

clientStorageFromWindow

▸ clientStorageFromWindow(aScope: string, aWindow?: Window): ClientStorage

Defined in storage/clientstorage.ts:109

Parameters:

Param	Type
aScope	`string`
`Optional` aWindow	`Window`

Returns: ClientStorage

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

isQuotaExceeded

▸ isQuotaExceeded(e: any): boolean

Defined in storage/clientstorage.ts:27

Parameters:

Param	Type
e	`any`

Returns: boolean

ibm-wch-sdk-utils > "storage/storage.service"

External module: "storage/storage.service"

Index

Classes

ClientStorageService

Variables

LOGGER

Variables

`<Const>` LOGGER

● LOGGER: "ClientStorageService" = "ClientStorageService"

Defined in storage/storage.service.ts:9

ibm-wch-sdk-utils > "url/url.utils"

External module: "url/url.utils"

Index

Interfaces

ParsedQuery

Variables

PARSE_HOST
PARSE_URL
decode
encode

Functions

_buildQueryString
_cloneURL
_decodeQueryArg
_ensureStartingAndTrailingSlash
_ensureTrailingSlash
_fallbackToEmpty
_getBaseUrlFromDocument
_getBaseUrlFromWindow
_getPathForSearch
_parseQuery
_parseURL
_parseUrlString
_push
_urlToString

Variables

`<Const>` PARSE_HOST

● PARSE_HOST: RegExp = /^([^:]+)(?::(\d+))?$/

Defined in url/url.utils.ts:38

`<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

`<Const>` decode

● decode: decodeURIComponent = decodeURIComponent

Defined in url/url.utils.ts:109

`<Const>` encode

● encode: encodeURIComponent = encodeURIComponent

Defined in url/url.utils.ts:108

Functions

_buildQueryString

▸ _buildQueryString(aValue: any): string | null | undefined

Defined in url/url.utils.ts:128

Parameters:

Param	Type
aValue	`any`

Returns: string | null | undefined

_cloneURL

▸ _cloneURL(aURL: URL): URL

Defined in url/url.utils.ts:90

Parameters:

Param	Type
aURL	`URL`

Returns: URL

_decodeQueryArg

▸ _decodeQueryArg(aValue: string): string

Defined in url/url.utils.ts:173

Parameters:

Param	Type
aValue	`string`

Returns: string

_ensureStartingAndTrailingSlash

▸ _ensureStartingAndTrailingSlash(aUrl?: string): string

Defined in url/url.utils.ts:11

Parameters:

Param	Type
`Optional` aUrl	`string`

Returns: string

_ensureTrailingSlash

▸ _ensureTrailingSlash(aUrl: string): string

Defined in url/url.utils.ts:27

Parameters:

Param	Type
aUrl	`string`

Returns: string

_fallbackToEmpty

▸ _fallbackToEmpty(aValue: * string | 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` \| `undefined`

Returns: string

_getBaseUrlFromDocument

▸ _getBaseUrlFromDocument(aDoc: Document): string | 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

Parameters:

Param	Type	Description
aDoc	`Document`	the document

Returns: string | undefined

the URL

_getBaseUrlFromWindow

▸ _getBaseUrlFromWindow(aWindow?: Window): string | undefined

Defined in url/url.utils.ts:246

Extracts the base URL from the window

Parameters:

Param	Type
`Optional` aWindow	`Window`

Returns: string | undefined

the URL

_getPathForSearch

▸ _getPathForSearch(aPath: string): string

Defined in url/url.utils.ts:261

Parameters:

Param	Type
aPath	`string`

Returns: string

_parseQuery

▸ _parseQuery(aQuery: string): ParsedQuery

Defined in url/url.utils.ts:183

Parameters:

Param	Type
aQuery	`string`

Returns: ParsedQuery

_parseURL

Defined in url/url.utils.ts:79

Parameters:

Param	Type
aURL	`URL` \| `string` \| `null` \| `undefined`

Returns: URL | null | undefined

_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

_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

_urlToString

▸ _urlToString(aURL: * URL | string*): string

Defined in url/url.utils.ts:257

Parameters:

Param	Type
aURL	`URL` \| `string`

Returns: string

ibm-wch-sdk-utils > "wch/wch.service"

External module: "wch/wch.service"

Index

Classes

InternalWchService

Variables

BFF_PUBLIC_URL
BFF_SECURE_URL
DEFAULT_CYCLE_HANDLING
EMPTY_PAGE_SEARCH_RESULT
EMPTY_RENDERING_CONTEXTS
EMPTY_RENDERING_CONTEXTS_SEQUENCE
EMPTY_RENDERING_CONTEXT_SEARCH_RESULT
EMPTY_SITE_PAGES_SEQUENCE
LOGGER
NO_RENDERING_CONTEXT
UNKNOWN_RENDERING_CONTEXT
_Subject
_assign

Functions

_getPathFromUrlSegments
_pluckDocument
_pluckSiteId

Object literals

EMPTY_RENDERING_QUERY
EMPTY_SITE_PAGES_QUERY

Variables

`<Const>` BFF_PUBLIC_URL

● BFF_PUBLIC_URL: "delivery/v1/rendering/" = "delivery/v1/rendering/"

Defined in wch/wch.service.ts:136

`<Const>` BFF_SECURE_URL

● BFF_SECURE_URL: "mydelivery/v1/rendering/" = "mydelivery/v1/rendering/"

Defined in wch/wch.service.ts:137

`<Const>` DEFAULT_CYCLE_HANDLING

● DEFAULT_CYCLE_HANDLING: BREAK = CYCLE_HANDLING.BREAK

Defined in wch/wch.service.ts:101

`<Const>` EMPTY_PAGE_SEARCH_RESULT

● EMPTY_PAGE_SEARCH_RESULT: PageSearchResult[] = []

Defined in wch/wch.service.ts:82

`<Const>` EMPTY_RENDERING_CONTEXTS

● EMPTY_RENDERING_CONTEXTS: RenderingContext[] = []

Defined in wch/wch.service.ts:83

`<Const>` EMPTY_RENDERING_CONTEXTS_SEQUENCE

● EMPTY_RENDERING_CONTEXTS_SEQUENCE: Observable<RenderingContextQueryResult> = of(EMPTY_RENDERING_QUERY)

Defined in wch/wch.service.ts:89

`<Const>` EMPTY_RENDERING_CONTEXT_SEARCH_RESULT

● EMPTY_RENDERING_CONTEXT_SEARCH_RESULT: RenderingContextSearchResult[] = []

Defined in wch/wch.service.ts:81

`<Const>` EMPTY_SITE_PAGES_SEQUENCE

● EMPTY_SITE_PAGES_SEQUENCE: Observable<SitePagesQueryResult> = of(EMPTY_SITE_PAGES_QUERY)

Defined in wch/wch.service.ts:90

`<Const>` LOGGER

● LOGGER: "WchService" = "WchService"

Defined in wch/wch.service.ts:97

`<Const>` NO_RENDERING_CONTEXT

● NO_RENDERING_CONTEXT: Observable<RenderingContext> = of(EMPTY_RENDERING_CONTEXT).pipe( map(cloneDeep) )

Defined in wch/wch.service.ts:92

`<Const>` UNKNOWN_RENDERING_CONTEXT

● UNKNOWN_RENDERING_CONTEXT: Observable<RenderingContext> = of(undefined)

Defined in wch/wch.service.ts:95

`<Const>` _Subject

● _Subject: Subject = Subject

Defined in wch/wch.service.ts:98

`<Const>` _assign

● _assign: assign = Object.assign

Defined in wch/wch.service.ts:134

Functions

_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

_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

_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

`<Const>` EMPTY_RENDERING_QUERY

EMPTY_RENDERING_QUERY: object

Defined in wch/wch.service.ts:84

numFound

● numFound: number = 0

Defined in wch/wch.service.ts:84

renderingContexts

● renderingContexts: RenderingContext[] = EMPTY_RENDERING_CONTEXTS

Defined in wch/wch.service.ts:84

`<Const>` EMPTY_SITE_PAGES_QUERY

EMPTY_SITE_PAGES_QUERY: object

Defined in wch/wch.service.ts:85

numFound

● numFound: number = 0

Defined in wch/wch.service.ts:85

sitePages

● sitePages: undefined[] = []

Defined in wch/wch.service.ts:85

ibm-wch-sdk-utils > "wch/wch.utils"

External module: "wch/wch.utils"

Index

Interfaces

RenderingContextMap
WchDebug

Type aliases

RenderingContextCallback

Variables

HEX_REGEXP_STRING
HOST_REGEXP_STRING
KEY_CYCLE
KEY_LAYOUT_MODE
KEY_LEVELS
KEY_REFERENCE
KEY_RENDERING_CONTEXT
KEY_RENDERING_CONTEXT_MAP
PREVIEW_HOST_REGEXP
PREVIEW_HOST_REGEXP_STRING
PREVIEW_INDICATOR
PREVIEW_ORIGIN_REGEXP
PREVIEW_ORIGIN_REGEXP_STRING
TENANT_BASED_URL
TENANT_BASED_URL_REGEXP
UUID_V4_REGEXP_STRING
VALUE_ROOT
_ALL_FETCH_LEVELS
_DEFAULT_FETCH_LEVELS
_FQ_SITE_ID
_KEY_FIELD_LIST
_KEY_PATHS
_KEY_ROWS
_KEY_SEARCH_FQ
_KEY_SEARCH_Q
_KEY_SORT
_PREFIX_SEARCH_CLASSIFICATION
_VALUE_FIELD_LIST
_VALUE_MAX_ROWS
_VALUE_ONE_ROW
_VALUE_SEARCH_FQ_CONTENT
_VALUE_SEARCH_FQ_PAGE
_VALUE_SEARCH_Q

Functions

_addDebug
_adjustRenderingContextSearchQuery
_adjustSearchQuery
_adjustSitePagesSearchQuery
_boxFetchLevels
_boxLayoutMode
_forEachRenderingContext
_forEachRenderingContexts
_fqValuePush
_fromHubInfoUrlProvider
_getApiUrlFromDeliveryURL
_getChildrenExpression
_getCycleHandling
_getDeliveryUrlFromApiURL
_getHubInfoFromBaseURL
_getLayout
_getPageSearchURL
_getParentExpression
_getParentPageURL
_getRenderingContextURL
_getSearchURL
_getSiblingsExpression
_getSiteContextExpression
_getSiteContextURL
_getSiteURL
_internalForEachRenderingContext
_internalForEachRenderingContexts
_isPreviewMode
_isPreviewOrigin
_isSearchClassification
_resolveRenderingContext

Object literals

EMPTY_RENDERING_CONTEXT
UNDEFINED_HUB_INFO
UNDEFINED_RENDERING_CONTEXT

Type aliases

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

`<Const>` HEX_REGEXP_STRING

● HEX_REGEXP_STRING: "[0-9a-fA-F]" = "[0-9a-fA-F]"

Defined in wch/wch.utils.ts:44

`<Const>` HOST_REGEXP_STRING

● HOST_REGEXP_STRING: "[^.:]" = "[^.:]"

Defined in wch/wch.utils.ts:45

`<Const>` KEY_CYCLE

● KEY_CYCLE: "$$CYCLE" = "$$CYCLE"

Defined in wch/wch.utils.ts:24

`<Const>` KEY_LAYOUT_MODE

● KEY_LAYOUT_MODE: "layoutMode" = "layoutMode"

Defined in wch/wch.utils.ts:203

`<Const>` KEY_LEVELS

● KEY_LEVELS: "levels" = "levels"

Defined in wch/wch.utils.ts:204

`<Const>` KEY_REFERENCE

● KEY_REFERENCE: "$$REF" = "$$REF"

Defined in wch/wch.utils.ts:25

`<Const>` KEY_RENDERING_CONTEXT

● KEY_RENDERING_CONTEXT: "renderingContext" = "renderingContext"

Defined in wch/wch.utils.ts:202

`<Const>` KEY_RENDERING_CONTEXT_MAP

● KEY_RENDERING_CONTEXT_MAP: unique symbol = Symbol('RenderingContextMap')

Defined in wch/wch.utils.ts:22

`<Const>` PREVIEW_HOST_REGEXP

● PREVIEW_HOST_REGEXP: RegExp = new RegExp(PREVIEW_HOST_REGEXP_STRING)

Defined in wch/wch.utils.ts:54

`<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

`<Const>` PREVIEW_INDICATOR

● PREVIEW_INDICATOR: "(?:-preview|-preview-stage)" = "(?:-preview|-preview-stage)"

Defined in wch/wch.utils.ts:52

`<Const>` PREVIEW_ORIGIN_REGEXP

● PREVIEW_ORIGIN_REGEXP: RegExp = new RegExp(PREVIEW_ORIGIN_REGEXP_STRING)

Defined in wch/wch.utils.ts:58

`<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

`<Const>` TENANT_BASED_URL

● TENANT_BASED_URL: string = ^(?:\\/api)?\\/(${UUID_V4_REGEXP_STRING})(?:\\/)?(?:.*)$

Defined in wch/wch.utils.ts:48

`<Const>` TENANT_BASED_URL_REGEXP

● TENANT_BASED_URL_REGEXP: RegExp = new RegExp(TENANT_BASED_URL)

Defined in wch/wch.utils.ts:49

`<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

`<Const>` VALUE_ROOT

● VALUE_ROOT: "$" = "$"

Defined in wch/wch.utils.ts:480

`<Const>` _ALL_FETCH_LEVELS

● _ALL_FETCH_LEVELS: -1 = -1

Defined in wch/wch.utils.ts:60

`<Const>` _DEFAULT_FETCH_LEVELS

● _DEFAULT_FETCH_LEVELS: -1 = _ALL_FETCH_LEVELS

Defined in wch/wch.utils.ts:61

`<Const>` _FQ_SITE_ID

● _FQ_SITE_ID: "siteId" = "siteId"

Defined in wch/wch.utils.ts:220

`<Const>` _KEY_FIELD_LIST

● _KEY_FIELD_LIST: "fl" = "fl"

Defined in wch/wch.utils.ts:209

`<Const>` _KEY_PATHS

● _KEY_PATHS: "paths" = "paths"

Defined in wch/wch.utils.ts:212

`<Const>` _KEY_ROWS

● _KEY_ROWS: "rows" = "rows"

Defined in wch/wch.utils.ts:211

`<Const>` _KEY_SEARCH_FQ

● _KEY_SEARCH_FQ: "fq" = "fq"

Defined in wch/wch.utils.ts:216

`<Const>` _KEY_SEARCH_Q

● _KEY_SEARCH_Q: "q" = "q"

Defined in wch/wch.utils.ts:207

`<Const>` _KEY_SORT

● _KEY_SORT: "sort" = "sort"

Defined in wch/wch.utils.ts:210

`<Const>` _PREFIX_SEARCH_CLASSIFICATION

● _PREFIX_SEARCH_CLASSIFICATION: "classification" = "classification"

Defined in wch/wch.utils.ts:219

`<Const>` _VALUE_FIELD_LIST

● _VALUE_FIELD_LIST: "document:[json]" = "document:[json]"

Defined in wch/wch.utils.ts:215

`<Const>` _VALUE_MAX_ROWS

● _VALUE_MAX_ROWS: string = anyToString(0x7FFFFFFF)

Defined in wch/wch.utils.ts:214

`<Const>` _VALUE_ONE_ROW

● _VALUE_ONE_ROW: "1" = "1"

Defined in wch/wch.utils.ts:213

`<Const>` _VALUE_SEARCH_FQ_CONTENT

● _VALUE_SEARCH_FQ_CONTENT: "classification:(content)" = "classification:(content)"

Defined in wch/wch.utils.ts:217

`<Const>` _VALUE_SEARCH_FQ_PAGE

● _VALUE_SEARCH_FQ_PAGE: "classification:(page)" = "classification:(page)"

Defined in wch/wch.utils.ts:218

`<Const>` _VALUE_SEARCH_Q

● _VALUE_SEARCH_Q: ":" = ":"

Defined in wch/wch.utils.ts:208

Functions

_addDebug

▸ _addDebug(aPath: string, aRenderingContext: RenderingContext): RenderingContext

Defined in wch/wch.utils.ts:423

Parameters:

Param	Type
aPath	`string`
aRenderingContext	`RenderingContext`

Returns: RenderingContext

_adjustRenderingContextSearchQuery

▸ _adjustRenderingContextSearchQuery(aQuery: string): string

Defined in wch/wch.utils.ts:298

Parameters:

Param	Type
aQuery	`string`

Returns: string

_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

_adjustSitePagesSearchQuery

▸ _adjustSitePagesSearchQuery(aQuery: string, aSiteId: string): string

Defined in wch/wch.utils.ts:309

Parameters:

Param	Type
aQuery	`string`
aSiteId	`string`

Returns: string

_boxFetchLevels

▸ _boxFetchLevels(aLevels: * number | null | undefined*, aDefault?: number): number

Defined in wch/wch.utils.ts:182

Parameters:

Param	Type
aLevels	`number` \| `null` \| `undefined`
`Optional` aDefault	`number`

Returns: number

_boxLayoutMode

▸ _boxLayoutMode(aMode: * string | null | undefined*): string

Defined in wch/wch.utils.ts:69

Parameters:

Param	Type
aMode	`string` \| `null` \| `undefined`

Returns: string

_forEachRenderingContext

▸ _forEachRenderingContext(aRenderingContext: RenderingContext, aCallback: RenderingContextCallback): void

Defined in wch/wch.utils.ts:568

Parameters:

Param	Type
aRenderingContext	`RenderingContext`
aCallback	RenderingContextCallback

Returns: void

_forEachRenderingContexts

▸ _forEachRenderingContexts(aRenderingContext: RenderingContext[], aCallback: RenderingContextCallback): void

Defined in wch/wch.utils.ts:555

Parameters:

Param	Type
aRenderingContext	`RenderingContext`[]
aCallback	RenderingContextCallback

Returns: void

_fqValuePush

▸ _fqValuePush(aValue: string, aArray: string[]): string[]

Defined in wch/wch.utils.ts:238

Parameters:

Param	Type
aValue	`string`
aArray	`string`[]

Returns: string[]

_fromHubInfoUrlProvider

▸ _fromHubInfoUrlProvider(aProvider: HubInfoUrlProvider): URL | null | undefined

Defined in wch/wch.utils.ts:192

Converts the provider into a URL

Parameters:

Param	Type	Description
aProvider	`HubInfoUrlProvider`	the provider

Returns: URL | null | undefined

the URL if available

_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

_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

_getCycleHandling

▸ _getCycleHandling(aCycle?: * CYCLE_HANDLING | string*): CYCLE_HANDLING

Defined in wch/wch.utils.ts:197

Parameters:

Param	Type
`Optional` aCycle	`CYCLE_HANDLING` \| `string`

Returns: CYCLE_HANDLING

_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

_getHubInfoFromBaseURL

▸ _getHubInfoFromBaseURL(aBaseURL: URL): HubInfo

Defined in wch/wch.utils.ts:120

Parameters:

Param	Type
aBaseURL	`URL`

Returns: HubInfo

_getLayout

▸ _getLayout(aLayoutMode: * string | undefined, aContext: * RenderingContext | undefined): Layout | undefined

Defined in wch/wch.utils.ts:79

Parameters:

Param	Type
aLayoutMode	`string` \| `undefined`
aContext	`RenderingContext` \| `undefined`

Returns: Layout | undefined

_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>

_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

_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>

_getRenderingContextURL

▸ _getRenderingContextURL(aBaseUrl: string, aID: string): string

Defined in wch/wch.utils.ts:583

Parameters:

Param	Type
aBaseUrl	`string`
aID	`string`

Returns: string

_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

_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

_getSiteContextExpression

▸ _getSiteContextExpression(aParentId: * string | null | 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` \| `null` \| `undefined`	the parent ID
aPageId	`string`	the page ID

Returns: string the expression

_getSiteContextURL

▸ _getSiteContextURL(aParentId: * string | null | undefined*, aPageId: string, aSiteId: string): Observable<string>

Defined in wch/wch.utils.ts:392

Parameters:

Param	Type
aParentId	`string` \| `null` \| `undefined`
aPageId	`string`
aSiteId	`string`

Returns: Observable<string>

_getSiteURL

▸ _getSiteURL(aBaseUrl: string, aSiteID?: string): string

Defined in wch/wch.utils.ts:592

Parameters:

Param	Type
aBaseUrl	`string`
`Optional` aSiteID	`string`

Returns: string

_internalForEachRenderingContext

▸ _internalForEachRenderingContext(aRenderingContext: RenderingContext, aParent: * RenderingContext | undefined*, aPath: string, aCallback: RenderingContextCallback): void

Defined in wch/wch.utils.ts:511

Parameters:

Param	Type
aRenderingContext	`RenderingContext`
aParent	`RenderingContext` \| `undefined`
aPath	`string`
aCallback	RenderingContextCallback

Returns: void

_internalForEachRenderingContexts

▸ _internalForEachRenderingContexts(aRenderingContext: RenderingContext[], aParent: * RenderingContext | undefined*, aPath: string, aCallback: RenderingContextCallback): void

Defined in wch/wch.utils.ts:490

Parameters:

Param	Type
aRenderingContext	`RenderingContext`[]
aParent	`RenderingContext` \| `undefined`
aPath	`string`
aCallback	RenderingContextCallback

Returns: void

_isPreviewMode

▸ _isPreviewMode(aBaseURL: URL): boolean

Defined in wch/wch.utils.ts:96

Parameters:

Param	Type
aBaseURL	`URL`

Returns: boolean

_isPreviewOrigin

▸ _isPreviewOrigin(aOrigin: string): boolean

Defined in wch/wch.utils.ts:106

Parameters:

Param	Type
aOrigin	`string`

Returns: boolean

_isSearchClassification

▸ _isSearchClassification(aValue: string): boolean

Defined in wch/wch.utils.ts:228

Parameters:

Param	Type
aValue	`string`

Returns: boolean

_resolveRenderingContext

▸ _resolveRenderingContext(aRenderingContext: * RenderingContext | null | undefined*, aStrategy: CYCLE_HANDLING, aRenderingContextById: function, aLogger?: Logger): Observable< RenderingContext | null | undefined>

Defined in wch/wch.utils.ts:432

Parameters:

Param	Type
aRenderingContext	`RenderingContext` \| `null` \| `undefined`
aStrategy	`CYCLE_HANDLING`
aRenderingContextById	`function`
`Optional` aLogger	`Logger`

Returns: Observable< RenderingContext | null | undefined>

Object literals

`<Const>` EMPTY_RENDERING_CONTEXT

EMPTY_RENDERING_CONTEXT: object

Defined in wch/wch.utils.ts:27

context

● context: SiteContext = EMPTY_SITE_CONTEXT

Defined in wch/wch.utils.ts:32

elements

● elements: object

Defined in wch/wch.utils.ts:114

`<Const>` UNDEFINED_RENDERING_CONTEXT

UNDEFINED_RENDERING_CONTEXT: object

Defined in wch/wch.utils.ts:35

External modules

"cache/cache.utils"
"categories/categories"
"consumers/consumer"
"cors/cors.utils"
"debug/debug.utils"
"elements/element"
"error/error"
"generators/generator"
"generators/lazy.generator"
"hash/hash.utils"
"http/http.utils"
"idle/idle"
"index"
"js/js.utils"
"json/json.utils"
"layouts/layout"
"logger/console.logger"
"logger/noop.logger"
"logger/noop.logger.service"
"messages/message.event"
"messages/navigate.by.path.handler"
"messages/refresh.handler"
"messages/set.mode.handler"
"messages/subscribe.active.route.handler"
"messages/subscribe.handler"
"messages/subscribe.mode.handler"
"messages/subscribe.route.handler"
"misc"
"operators/operators"
"predicates/predicates"
"rendering/rendering"
"rx/rx.utils"
"search/search.utils"
"site/site.utils"
"site/sites.constants"
"static/static.resources"
"storage/clientstorage"
"storage/storage.service"
"url/url.utils"
"wch/wch.service"
"wch/wch.utils"

ibm-wch-sdk-utils > "cache/cache.utils" > CacheImpl

Interface: CacheImpl

Type parameters

V

Hierarchy

CacheImpl

Indexable

[key: string]: CacheValue<V>

Index

ibm-wch-sdk-utils > "cache/cache.utils" > CacheValue

Interface: CacheValue

Type parameters

V

Hierarchy

CacheValue

Index

Properties

isDirty
value

Properties

isDirty

● isDirty: boolean

Defined in cache/cache.utils.ts:17

value

● value: V

Defined in cache/cache.utils.ts:15

ibm-wch-sdk-utils > "http/http.utils" > HttpOptions

Interface: HttpOptions

Hierarchy

HttpOptions

Index

Properties

dispatchError
withCredentials

Properties

`<Optional>` dispatchError

● dispatchError: boolean

Defined in http/http.utils.ts:38

withCredentials

● withCredentials: boolean

Defined in http/http.utils.ts:36

ibm-wch-sdk-utils > "http/http.utils" > HttpService

Interface: HttpService

Hierarchy

HttpService

Index

Methods

getJson
getText

Methods

getJson

▸ getJson<T>(aUrl: string, aOptions: HttpOptions): Observable<T>

Defined in http/http.utils.ts:42

Type parameters:

T

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions

Returns: Observable<T>

getText

▸ getText(aUrl: string, aOptions: HttpOptions): Observable<string>

Defined in http/http.utils.ts:43

Parameters:

Param	Type
aUrl	`string`
aOptions	HttpOptions

Returns: Observable<string>

ibm-wch-sdk-utils > "json/json.utils" > JsonArray

Interface: JsonArray

Hierarchy

Array<AnyJson>

↳ JsonArray

Indexable

[n: number]: AnyJson

Index

Properties

Array
length

Methods

__@iterator
__@unscopables
concat
copyWithin
entries
every
fill
filter
find
findIndex
forEach
includes
indexOf
join
keys
lastIndexOf
map
pop
push
reduce
reduceRight
reverse
shift
slice
some
sort
splice
toLocaleString
toString
unshift
values

Properties

Array

● Array: ArrayConstructor

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280

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

__@iterator

▸ __@iterator(): IterableIterator<AnyJson>

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>

__@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

concat

▸ concat(...items: ConcatArray<AnyJson>[]): AnyJson[]

▸ concat(...items: ( T | ConcatArray<T>)[]): AnyJson[]

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>[]	Additional items to add to the end of array1.

Returns: AnyJson[]

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` \| `ConcatArray`<`T`>)[]	Additional items to add to the end of array1.

Returns: AnyJson[]

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

entries

▸ entries(): IterableIterator<[number, AnyJson]>

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]>

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

fill

▸ fill(value: AnyJson, 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	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

filter

▸ filter<S>(callbackfn: function, thisArg?: any): S[]

▸ filter(callbackfn: function, thisArg?: any): AnyJson[]

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

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[]

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): AnyJson | 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

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 | 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 | undefined

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

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

includes

▸ includes(searchElement: AnyJson, 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	The element to search for.
`Optional` fromIndex	`number`	The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: AnyJson, 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	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

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

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>

lastIndexOf

▸ lastIndexOf(searchElement: AnyJson, 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	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

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[]

pop

▸ pop(): AnyJson | 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 | undefined

push

▸ push(...items: AnyJson[]): 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[]	New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): AnyJson

▸ reduce(callbackfn: function, initialValue: AnyJson): AnyJson

▸ 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

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

Returns: AnyJson

Inherited from Array.reduce

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1251

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

reduceRight

▸ reduceRight(callbackfn: function): AnyJson

▸ reduceRight(callbackfn: function, initialValue: AnyJson): AnyJson

▸ 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

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

Returns: AnyJson

Inherited from Array.reduceRight

Defined in /usr/build/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1264

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

reverse

▸ reverse(): AnyJson[]

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[]

shift

▸ shift(): AnyJson | 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 | undefined

slice

▸ slice(start?: number, end?: number): AnyJson[]

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[]

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

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

splice

▸ splice(start: number, deleteCount?: number): AnyJson[]

▸ splice(start: number, deleteCount: number, ...items: AnyJson[]): AnyJson[]

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[]

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[]	Elements to insert into the array in place of the deleted elements.

Returns: AnyJson[]

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

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

unshift

▸ unshift(...items: AnyJson[]): 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[]	Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<AnyJson>

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>

ibm-wch-sdk-utils > "rendering/rendering" > HandlerKind

Enumeration: HandlerKind

Index

Enumeration members

MULTI_VALUES
SINGLE
SINGLE_VALUE

Enumeration members

MULTI_VALUES

MULTI_VALUES:

Defined in rendering/rendering.ts:205

SINGLE

SINGLE:

Defined in rendering/rendering.ts:206

SINGLE_VALUE

SINGLE_VALUE: = 1

Defined in rendering/rendering.ts:204

ibm-wch-sdk-utils > "rx/rx.utils" > IdleFrameAction

Class: IdleFrameAction

Type parameters

T

Hierarchy

AsyncAction<T>

↳ IdleFrameAction

Implements

ISubscription

Index

Constructors

constructor

Properties

_parent
_parents
closed
delay
id
pending
scheduler
state
work
EMPTY

Methods

_execute
_unsubscribe
add
execute
recycleAsyncId
remove
requestAsyncId
schedule
unsubscribe

Constructors

constructor

⊕ new IdleFrameAction(scheduler: IdleFrameScheduler, work: function): IdleFrameAction

Overrides AsyncAction.__constructor

Defined in rx/rx.utils.ts:98

Parameters:

Param	Type
scheduler	IdleFrameScheduler
work	`function`

Returns: IdleFrameAction

Properties

`<Protected>` _parent

● _parent: Subscription

Inherited from Subscription._parent

Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:28

`<Protected>` _parents

● _parents: Subscription[]

Inherited from Subscription._parents

Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:29

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}

delay

● delay: number

Inherited from AsyncAction.delay

Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:13

id

● id: any

Inherited from AsyncAction.id

Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:11

`<Protected>` pending

● pending: boolean

Inherited from AsyncAction.pending

Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:14

`<Protected>` scheduler

● scheduler: IdleFrameScheduler

Overrides AsyncAction.scheduler

Defined in rx/rx.utils.ts:100

state

● state: T

Inherited from AsyncAction.state

Defined in /usr/build/node_modules/rxjs/scheduler/AsyncAction.d.ts:12

`<Protected>` work

● work: function

Overrides AsyncAction.work

Defined in rx/rx.utils.ts:101

Type declaration

▸(this: IdleFrameAction<T>, state?: T): void

Parameters:

Param	Type
this	IdleFrameAction<`T`>
`Optional` state	`T`

Returns: void

`<Static>` EMPTY

● EMPTY: Subscription

Inherited from Subscription.EMPTY

Defined in /usr/build/node_modules/rxjs/Subscription.d.ts:22

Methods

`<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

_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

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.

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

`<Protected>` recycleAsyncId

▸ recycleAsyncId(scheduler: IdleFrameScheduler, id?: any, delay?: number): any

Overrides AsyncAction.recycleAsyncId

Defined in rx/rx.utils.ts:118

Parameters:

Param	Type	Default value
scheduler	IdleFrameScheduler	-
`Optional` id	`any`	-
`Default value` delay	`number`	0

Returns: any

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

`<Protected>` requestAsyncId

▸ requestAsyncId(scheduler: IdleFrameScheduler, id?: any, delay?: number): any

Overrides AsyncAction.requestAsyncId

Defined in rx/rx.utils.ts:105

Parameters:

Param	Type	Default value
scheduler	IdleFrameScheduler	-
`Optional` id	`any`	-
`Default value` delay	`number`	0

Returns: any

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

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

ibm-wch-sdk-utils > "rx/rx.utils" > IdleFrameScheduler

Class: IdleFrameScheduler

Hierarchy

AsyncScheduler

↳ IdleFrameScheduler

Implements

IScheduler

Index

Constructors

constructor

Properties

actions
active
now
scheduled
now

Methods

flush
schedule

Constructors

constructor

⊕ new IdleFrameScheduler(SchedulerAction: Action, now?: function): IdleFrameScheduler

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

Properties

actions

● actions: Array<AsyncAction<any>>

Inherited from AsyncScheduler.actions

Defined in /usr/build/node_modules/rxjs/scheduler/AsyncScheduler.d.ts:4

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}

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

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}

`<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

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

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.

ibm-wch-sdk-utils > "site/site.utils" > InternalSiteInformation

Class: InternalSiteInformation

Hierarchy

InternalSiteInformation

Index

Properties

_idToContext
_pathToId
_siteContext

Properties

_idToContext

● _idToContext: SyncMapping<SiteContext>

Defined in site/site.utils.ts:114

_pathToId

● _pathToId: AsyncMapping<string>

Defined in site/site.utils.ts:111

_siteContext

● _siteContext: SiteContext = cloneDeep(UNDEFINED_SITE_CONTEXT)

Defined in site/site.utils.ts:117

ibm-wch-sdk-utils > "site/site.utils" > SiteInformation

Class: SiteInformation

Hierarchy

SiteInformation

Index

Constructors

constructor

Properties

bInitialized
observer
siteInfo
siteSubject

Accessors

site

Methods

clear
getIdByPath
getSiteContextById

Constructors

constructor

⊕ new SiteInformation(): SiteInformation

Defined in site/site.utils.ts:354

Returns: SiteInformation

Properties

`<Private>` bInitialized

● bInitialized: boolean = false

Defined in site/site.utils.ts:342

observer

● observer: Observer<Site>

Defined in site/site.utils.ts:354

`<Private>` siteInfo

● siteInfo: InternalSiteInformation = new InternalSiteInformation()

Defined in site/site.utils.ts:352

`<Private>` siteSubject

● siteSubject: ReplaySubject<Site> = new ReplaySubject(1)

Defined in site/site.utils.ts:347

Accessors

site

getsite(): Observable<Site>

Defined in site/site.utils.ts:456

Returns: Observable<Site>

Methods

`<Private>` clear

▸ clear(): void

Defined in site/site.utils.ts:411

Returns: void

getIdByPath

▸ getIdByPath(path: string): Observable< string | null | undefined>

Defined in site/site.utils.ts:431

Parameters:

Param	Type
path	`string`

Returns: Observable< string | null | undefined>

getSiteContextById

▸ getSiteContextById(aID: * string | null*): SiteContext

Defined in site/site.utils.ts:446

Parameters:

Param	Type
aID	`string` \| `null`

Returns: SiteContext

ibm-wch-sdk-utils > "site/site.utils" > AnalysisContext

Interface: AnalysisContext

Hierarchy

AnalysisContext

Index

Properties

_newInfo
_notifications
_oldInfo
_site

Properties

_newInfo

● _newInfo: InternalSiteInformation

Defined in site/site.utils.ts:124

_notifications

● _notifications: ChangeNotification[]

Defined in site/site.utils.ts:126

_oldInfo

● _oldInfo: InternalSiteInformation

Defined in site/site.utils.ts:123

_site

● _site: Site

Defined in site/site.utils.ts:122

ibm-wch-sdk-utils > "site/site.utils" > AsyncMapping

Interface: AsyncMapping

Type parameters

T

Hierarchy

AsyncMapping

Indexable

[key: string]: BehaviorSubject<T>

Index

ibm-wch-sdk-utils > "site/site.utils" > SyncMapping

Interface: SyncMapping

Type parameters

T

Hierarchy

SyncMapping

Indexable

[key: string]: T

Index

ibm-wch-sdk-utils > "static/static.resources" > StaticResources

Class: StaticResources

Hierarchy

StaticResources

Index

Constructors

constructor

Properties

base
http

Methods

Constructors

constructor

⊕ new StaticResources(aBaseUrl: * URL | undefined*, http: HttpService): StaticResources

Defined in static/static.resources.ts:17

Parameters:

Param	Type
aBaseUrl	`URL` \| `undefined`
http	HttpService

Returns: StaticResources

Properties

`<Private>` base

● base: string

Defined in static/static.resources.ts:17

`<Private>` http

● http: HttpService

Defined in static/static.resources.ts:20

Methods

get

▸ get(aKey: string): Observable<AnyJson>

Defined in static/static.resources.ts:31

Parameters:

Param	Type
aKey	`string`

Returns: Observable<AnyJson>

ibm-wch-sdk-utils > "storage/clientstorage" > ClientStorageOnLocalStorage

Class: ClientStorageOnLocalStorage

Hierarchy

ClientStorageOnLocalStorage

Implements

ClientStorage

Index

Constructors

constructor

Properties

prefix
storage
suffix

Methods

Constructors

constructor

⊕ new ClientStorageOnLocalStorage(storage: Storage, scope: string): ClientStorageOnLocalStorage

Defined in storage/clientstorage.ts:54

Parameters:

Param	Type
storage	`Storage`
scope	`string`

Returns: ClientStorageOnLocalStorage

Properties

`<Private>` prefix

● prefix: string

Defined in storage/clientstorage.ts:53

`<Private>` storage

● storage: Storage

Defined in storage/clientstorage.ts:56

`<Private>` suffix

● suffix: string

Defined in storage/clientstorage.ts:54

Methods

get

▸ get(aKey: string): AnyJson

Implementation of ClientStorage.get

Defined in storage/clientstorage.ts:63

Parameters:

Param	Type
aKey	`string`

Returns: AnyJson

put

▸ put(aKey: string, aValue: AnyJson): void

Implementation of ClientStorage.put

Defined in storage/clientstorage.ts:73

Parameters:

Param	Type
aKey	`string`
aValue	AnyJson

Returns: void

ibm-wch-sdk-utils > "storage/clientstorage" > EmptyClientStorage

Class: EmptyClientStorage

Hierarchy

EmptyClientStorage

Implements

ClientStorage

Index

Methods

get

▸ get(aKey: string): AnyJson

Implementation of ClientStorage.get

Defined in storage/clientstorage.ts:83

Parameters:

Param	Type
aKey	`string`

Returns: AnyJson

put

▸ put(aKey: string, aValue: AnyJson): void

Implementation of ClientStorage.put

Defined in storage/clientstorage.ts:87

Parameters:

Param	Type
aKey	`string`
aValue	AnyJson

Returns: void

ibm-wch-sdk-utils > "storage/clientstorage" > ClientStorage

Interface: ClientStorage

Hierarchy

ClientStorage

Implemented by

ClientStorageOnLocalStorage
ClientStorageService
EmptyClientStorage

Index

Methods

get

▸ get(aKey: string): AnyJson | null | undefined

Defined in storage/clientstorage.ts:10

Parameters:

Param	Type
aKey	`string`

Returns: AnyJson | null | undefined

put

▸ put(aKey: string, aValue: AnyJson): any

Defined in storage/clientstorage.ts:12

Parameters:

Param	Type
aKey	`string`
aValue	AnyJson

Returns: any

ibm-wch-sdk-utils > "storage/storage.service" > ClientStorageService

Class: ClientStorageService

Hierarchy

ClientStorageService

Implements

ClientStorage

Index

Constructors

constructor

Properties

Constructors

constructor

⊕ new ClientStorageService(aUrlsService: UrlConfig, aWindow?: Window): ClientStorageService

Defined in storage/storage.service.ts:15

Parameters:

Param	Type
aUrlsService	`UrlConfig`
`Optional` aWindow	`Window`

Returns: ClientStorageService

Properties

get

● get: function

Implementation of ClientStorage.get

Defined in storage/storage.service.ts:14

Type declaration

▸(aKey: string): AnyJson

Parameters:

Param	Type
aKey	`string`

Returns: AnyJson

put

● put: function

Implementation of ClientStorage.put

Defined in storage/storage.service.ts:15

Type declaration

▸(aKey: string, aValue: AnyJson): void

Parameters:

Param	Type
aKey	`string`
aValue	AnyJson

Returns: void

ibm-wch-sdk-utils > "url/url.utils" > ParsedQuery

Interface: ParsedQuery

Hierarchy

ParsedQuery

Indexable

[key: string]: string | string[]

Index

ibm-wch-sdk-utils > "wch/wch.service" > InternalWchService

Class: InternalWchService

Hierarchy

InternalWchService

Index

Constructors

constructor

Properties

createPollingTrigger
dispose
getApiUrl
getCorsWhitelist
getDeliverOrigin
getDeliveryUrl
getJsonResource
getRenderingContextById
getRenderingContextByPage
getRenderingContextByPath
getRenderingContextByUrlSegments
getRenderingContextForAppConfig
getRenderingContextsByQuery
getSitePagesByQuery
getTextResource
isPreviewMode
resolveRenderingContext
triggerRefresh

Constructors

constructor

⊕ new InternalWchService(aHttp: HttpService, aJsonp: HttpService, wchConfig: HubInfoConfig, aUrlService: UrlConfig, clientStorage: ClientStorage, usePublicUrl: Observable<boolean>, aLogger?: Logger): InternalWchService

Defined in wch/wch.service.ts:162

Parameters:

Param	Type
aHttp	HttpService
aJsonp	HttpService
wchConfig	`HubInfoConfig`
aUrlService	`UrlConfig`
clientStorage	ClientStorage
usePublicUrl	`Observable`<`boolean`>
`Optional` aLogger	`Logger`

Returns: InternalWchService

Properties

`<Protected>` createPollingTrigger

● createPollingTrigger: function

Defined in wch/wch.service.ts:162

Type declaration

▸(aOptions?: HttpResourceOptions): Observable<any>

Parameters:

Param	Type
`Optional` aOptions	`HttpResourceOptions`

Type parameters:

T

Parameters:

Param	Type
aUrl	`string`
`Optional` aOptions	`HttpResourceOptions`

Returns: Observable<T>

getRenderingContextById

● getRenderingContextById: function

Defined in wch/wch.service.ts:148

Type declaration

▸(aID: * string | null | undefined*, aLevels?: number): Observable< RenderingContext | null | undefined>

Parameters:

Param	Type
aID	`string` \| `null` \| `undefined`
`Optional` aLevels	`number`

Returns: Observable< RenderingContext | null | undefined>

getRenderingContextByPage

● getRenderingContextByPage: function

Defined in wch/wch.service.ts:151

Type declaration

▸(aPage: SitePage, aLevels?: number): Observable< RenderingContext | null | undefined>

Parameters:

Param	Type
aPage	`SitePage`
`Optional` aLevels	`number`

Returns: Observable< RenderingContext | null | undefined>

getRenderingContextByPath

● getRenderingContextByPath: function

Defined in wch/wch.service.ts:150

Type declaration

▸(aPath: string, aLevels?: number): Observable< RenderingContext | null | undefined>

Parameters:

Param	Type
aPath	`string`
`Optional` aLevels	`number`

Returns: Observable< RenderingContext | null | undefined>

getRenderingContextByUrlSegments

● getRenderingContextByUrlSegments: function

Defined in wch/wch.service.ts:149

Type declaration

▸(aSegments: string[], aLevels?: number): Observable< RenderingContext | null | undefined>

Parameters:

Param	Type
aSegments	`string`[]
`Optional` aLevels	`number`

Returns: Observable< RenderingContext | null | undefined>

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>

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>

getSitePagesByQuery

● getSitePagesByQuery: function

Defined in wch/wch.service.ts:154

Type declaration

▸(aQuery: string): Observable<SitePagesQueryResult>

Parameters:

Param	Type
aQuery	`string`

Returns: Observable<SitePagesQueryResult>

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>

isPreviewMode

● isPreviewMode: function

Defined in wch/wch.service.ts:146

Type declaration

▸(): boolean

Returns: boolean

resolveRenderingContext

● resolveRenderingContext: function

Defined in wch/wch.service.ts:158

Type declaration

▸(aRenderingContext?: RenderingContext, aStrategy?: CYCLE_HANDLING): Observable< RenderingContext | null | undefined>

Parameters:

Param	Type
`Optional` aRenderingContext	`RenderingContext`
`Optional` aStrategy	`CYCLE_HANDLING`

Returns: Observable< RenderingContext | null | undefined>

triggerRefresh

● triggerRefresh: function

Defined in wch/wch.service.ts:143

Type declaration

▸(): void

Returns: void

ibm-wch-sdk-utils > "wch/wch.utils" > RenderingContextMap

Interface: RenderingContextMap

Hierarchy

RenderingContextMap

Indexable

[id: string]: RenderingContext

Index

ibm-wch-sdk-utils > "wch/wch.utils" > WchDebug

Interface: WchDebug

Hierarchy

WchDebug

Index

Properties

path

Properties

path

● path: string

Defined in wch/wch.utils.ts:15

ibm-wch-sdk-utils

ibm-wch-sdk-utils

Details

Changes

Class documentation

Utils

Changelog

Current

Added

Utils

Index

External modules

External module: "cache/cache.utils"

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

CacheAccessor

CacheCallback

Variables

<Const> DEFAULT_MAXCOUNT

<Const> DEFAULT_TIMEOUT

Functions

<Const> _createCache

V

External module: "categories/categories"

Index

Functions

Functions

<Const> getCategoryLeaf

External module: "consumers/consumer"

Index

Type aliases

Type aliases

BiConsumer

BiFunction

Type declaration

Consumer

External module: "cors/cors.utils"

Index

Variables

Functions

Variables

<Const> NULL_ORIGIN

<Const> _ALL_ORIGINS

Functions

_testOrigin

External module: "debug/debug.utils"

Index

Type aliases

Variables

Functions

Type aliases

AddDebugCallback

Type declaration

Variables

<Let> COUNTER

<Const> _isFrozen

Functions

_addDebugInfo

T

_addSourceCallback

_addSourceDebug

T

_getCounter

External module: "elements/element"

Index

Variables

Functions

Object literals

Variables

<Const> _PROP_ID

<Const> _PROP_SELECTION

<Const> _PROP_TYPE

<Const> _PROP_TYPE_REF

<Const> _PROP_VALUE

<Const> _PROP_VALUES

Functions

`<Const>` DEFAULT_MAXCOUNT

`<Const>` DEFAULT_TIMEOUT

`<Const>` _createCache

`<Const>` getCategoryLeaf

`<Const>` NULL_ORIGIN

`<Const>` _ALL_ORIGINS

`<Let>` COUNTER

`<Const>` _isFrozen

`<Const>` _PROP_ID

`<Const>` _PROP_SELECTION

`<Const>` _PROP_TYPE

`<Const>` _PROP_TYPE_REF

`<Const>` _PROP_VALUE

`<Const>` _PROP_VALUES

`<Const>` _falseHandler

`<Const>` _getHandler

`<Const>` HANDLERS