@ibm-wch-sdk/utils v9.0.10076

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

This library contains a set of utility functions to help implementing applications of libraries against Watson Content Hub, e.g. WCH SDK. It is independent of any UI framework.

• WCH WCH specific utility functions.
• URL Utility functions that assist in working with URLs.

Changelog

Current

Added

• New method "wchSiteIdFromBaseURL" to decode the site ID from a URL

6.0.185

Added

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

@ibm-wch-sdk/utils

Index

External modules

• "cache/cache.utils"
• "categories/categories"
• "compare/compare"
• "consumers/consumer"
• "cors/cors.utils"
• "debug/debug.utils"
• "dom/dom.utils"
• "elements/element"
• "error/error"
• "generators/generator"
• "generators/lazy.generator"
• "hash/hash.utils"
• "html/html"
• "http/http.utils"
• "i18n/localized"
• "idle/idle"
• "index"
• "js/js.core"
• "js/js.utils"
• "json/json.utils"
• "layouts/layout"
• "logger/console.logger"
• "logger/noop.logger"
• "logger/noop.logger.service"
• "logger/rx.logger"
• "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"
• "path/path"
• "perf/perf.utils"
• "placeholder/placeholder"
• "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"

Utility functions to work with WCH

Compute the API URL

The WCH API URL differs between the live and the preview system. If you decide to configure you application with an explicit API URL, e.g. for applications that are hosted outside of WCH, then you need to feed in the correct version of the URL depending on the runtime system.

The wchGetHubInfoUrlProvider method provides a default implementation for this task. It takes the live version of the API URL and a callback predicate as an input. The callback decides based on the current base URL of the application if the application is in live or preview state. The helper function will then derive the correct API URL.

Example:

import { HubInfoUrlProvider } from '@ibm-wch-sdk/api';
import { wchGetHubInfoUrlProvider } from '@ibm-wch-sdk/utils';

export function apiUrl(): HubInfoUrlProvider {
  return wchGetHubInfoUrlProvider(
    'https://my10.digitalexperience.ibm.com/api/6f0ce0ff-8a25-4fac-b66a-5d42516247eb',
    baseURL => /preview/.test(baseURL.href)
  );
}

export const environment = {
  apiUrl
};

Note It is important that apiUrl is an exported function using the function statement. Arrow functions do NOT work for the AOT compiler.

Utility functions to work with URLs

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

External module: "cache/cache.utils"

Index

Type aliases

• CacheAccessor
• CacheCallback
• CacheImpl
• CacheValue

Variables

• DEFAULT_MAXCOUNT
• DEFAULT_TIMEOUT
• _currentTime

Functions

• _createCache

Type aliases

CacheAccessor

Ƭ CacheAccessor: function

Defined in cache/cache.utils.ts:8

Type declaration

▸(aKey: string, aCallback: CacheCallback<V>, aLogger?: Logger): V

Parameters:

Returns: V

CacheCallback

Ƭ CacheCallback: function

Defined in cache/cache.utils.ts:7

Type declaration

▸(aKey: string, aLogger?: Logger): V

Parameters:

Returns: V

CacheImpl

Ƭ CacheImpl: CacheValue<V>[]

Defined in cache/cache.utils.ts:15

CacheValue

Ƭ CacheValue: string, V, boolean, number

Defined in cache/cache.utils.ts:14

Variables

<Const> DEFAULT_MAXCOUNT

● DEFAULT_MAXCOUNT: 100 = 100

Defined in cache/cache.utils.ts:21

<Const> DEFAULT_TIMEOUT

● DEFAULT_TIMEOUT: number = 30 * 1000

Defined in cache/cache.utils.ts:18

<Const> _currentTime

● _currentTime: now = Date.now

Defined in cache/cache.utils.ts:24

Functions

<Const> _createCache

▸ _createCache<V>(aTimeout?: number, aMaxValues?: number, aLogger?: Logger): CacheAccessor<V>

Defined in cache/cache.utils.ts:34

Constructs a new cache

Type parameters:

V

Parameters:

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:14

Extracts the last category element

Parameters:

Returns: string the last element

@ibm-wch-sdk/utils > "compare/compare"

External module: "compare/compare"

Index

Type aliases

• Comparator

Functions

• cmpNumbers
• cmpStrings

Type aliases

Comparator

Ƭ Comparator: BiFunction<T, T, number>

Defined in compare/compare.ts:6

Comparison operator

Functions

<Const> cmpNumbers

▸ cmpNumbers(aLeft: number, aRight: number): 0 | 1 | -1

Defined in compare/compare.ts:16

Exports a comparator for numbers

Parameters:

Returns: 0 | 1 | -1

the result

<Const> cmpStrings

▸ cmpStrings(aLeft: string, aRight: string): number

Defined in compare/compare.ts:27

Exports a comparator for numbers

Parameters:

Returns: number the result

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

External module: "consumers/consumer"

Index

Type aliases

• BiConsumer
• BiFunction
• Consumer

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:

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:

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:

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:

Returns: T the object

_addSourceCallback

▸ _addSourceCallback(aSource: string): AddDebugCallback

Defined in debug/debug.utils.ts:18

Adds source information

Parameters:

Returns: AddDebugCallback

_addSourceDebug

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

Defined in debug/debug.utils.ts:54

Adds source information

Type parameters:

T

Parameters:

Returns: T the original object

_getCounter

▸ _getCounter(): number

Defined in debug/debug.utils.ts:7

Returns: number

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

External module: "dom/dom.utils"

Index

Functions

• getDocument
• getWindow

Functions

getDocument

▸ getDocument(aDocument?: Document, aWindow?: Window): Document

Defined in dom/dom.utils.ts:27

Returns a document object if one is available

Parameters:

Returns: Document the resolved document object, using the global variable as a default

getWindow

▸ getWindow(aWindow?: Window): Window

Defined in dom/dom.utils.ts:11

Returns a window object if one is available

Parameters:

Returns: Window the resolved window object, using the global variable as a default

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

External module: "elements/element"

Index

Type aliases

• OptionalPredicate

Variables

• _PROP_ID
• _PROP_SELECTION
• _PROP_TYPE
• _PROP_TYPE_REF
• _PROP_VALUE
• _PROP_VALUES

Functions

• _falseHandler
• _getElementHandler
• _getValueHandler
• _hasAssetAndUrl
• _isArrayOf
• _isAsset
• _isBoolean
• _isCategory
• _isCategoryElement
• _isDate
• _isDateElement
• _isElement
• _isFile
• _isFileElement
• _isFormattedTextElement
• _isGroup
• _isGroupElement
• _isImage
• _isImageElement
• _isLink
• _isLinkElement
• _isLocation
• _isLocationElement
• _isMultiDateElement
• _isMultiFileElement
• _isMultiFormattedTextElement
• _isMultiGroupElement
• _isMultiImageElement
• _isMultiLinkElement
• _isMultiNumberElement
• _isMultiOptionSelectionElement
• _isMultiProductElement
• _isMultiReferenceElement
• _isMultiTextElement
• _isMultiToggleElement
• _isMultiVideoElement
• _isNumber
• _isNumberElement
• _isOptionSelection
• _isOptionSelectionElement
• _isProductElement
• _isReference
• _isReferenceElement
• _isSingleDateElement
• _isSingleFileElement
• _isSingleFormattedTextElement
• _isSingleGroupElement
• _isSingleImageElement
• _isSingleLinkElement
• _isSingleNumberElement
• _isSingleOptionSelectionElement
• _isSingleProductElement
• _isSingleReferenceElement
• _isSingleTextElement
• _isSingleToggleElement
• _isSingleVideoElement
• _isSomeDateElement
• _isSomeFileElement
• _isSomeFormattedTextElement
• _isSomeGroupElement
• _isSomeImageElement
• _isSomeLinkElement
• _isSomeNumberElement
• _isSomeOptionSelectionElement
• _isSomeProductElement
• _isSomeReferenceElement
• _isSomeTextElement
• _isSomeToggleElement
• _isSomeVideoElement
• _isString
• _isTextElement
• _isToggleElement
• _isType
• _isTypeRef
• _isValueOf
• _isVideo
• _isVideoElement

Object literals

• ELEMENT_HANDLERS
• VALUE_HANDLERS

Type aliases

OptionalPredicate

Ƭ OptionalPredicate: function

Defined in elements/element.ts:938

Type declaration

▸(aValue: T, bOptional?: boolean): boolean

Parameters:

Returns: boolean

Variables

<Const> _PROP_ID

● _PROP_ID: "id" = "id"

Defined in elements/element.ts:89

<Const> _PROP_SELECTION

● _PROP_SELECTION: "selection" = "selection"

Defined in elements/element.ts:87

<Const> _PROP_TYPE

● _PROP_TYPE: "elementType" = "elementType"

Defined in elements/element.ts:84

<Const> _PROP_TYPE_REF

● _PROP_TYPE_REF: "typeRef" = "typeRef"

Defined in elements/element.ts:88

<Const> _PROP_VALUE

● _PROP_VALUE: "value" = "value"

Defined in elements/element.ts:85

<Const> _PROP_VALUES

● _PROP_VALUES: "values" = "values"

Defined in elements/element.ts:86

Functions

<Const> _falseHandler

▸ _falseHandler(): boolean

Defined in elements/element.ts:982

Returns: boolean

<Const> _getElementHandler

▸ _getElementHandler(aElementType: string, bOptional?: boolean): OptionalPredicate<any>

Defined in elements/element.ts:984

Parameters:

Returns: OptionalPredicate<any>

<Const> _getValueHandler

▸ _getValueHandler(aElementType: string, bOptional?: boolean): OptionalPredicate<any>

Defined in elements/element.ts:989

Parameters:

Returns: OptionalPredicate<any>

_hasAssetAndUrl

▸ _hasAssetAndUrl(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:532

Tests if an element has at least an asset and a URL

Parameters:

Returns: boolean true if we have an video, else false

_isArrayOf

▸ _isArrayOf<T>(aValue: any, aPredicate: IsPredicate<T>, bOptional?: boolean): boolean

Defined in elements/element.ts:123

Type parameters:

T

Parameters:

Returns: boolean

_isAsset

▸ _isAsset(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:518

Tests the value is a valid asset

Parameters:

Returns: boolean true if the element is an asset

_isBoolean

▸ _isBoolean(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:185

Parameters:

Returns: boolean

_isCategory

▸ _isCategory(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:476

Parameters:

Returns: boolean

_isCategoryElement

▸ _isCategoryElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:491

Parameters:

Returns: boolean

_isDate

▸ _isDate(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:247

Parameters:

Returns: boolean

_isDateElement

▸ _isDateElement(aValue: any): boolean

Defined in elements/element.ts:472

Parameters:

Returns: boolean

_isElement

▸ _isElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:1000

Tests if the value is a value element

Parameters:

Returns: boolean true if the value is a valid element

_isFile

▸ _isFile(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:550

Tests if an element is a video. If the element is optional, it can be null or an arbitrary object. Otherwise we must have at least an asset and a URL.

Parameters:

Returns: boolean true if we have an video, else false

_isFileElement

▸ _isFileElement(aValue: any): boolean

Defined in elements/element.ts:506

Parameters:

Returns: boolean

_isFormattedTextElement

▸ _isFormattedTextElement(aValue: any): boolean

Defined in elements/element.ts:340

Parameters:

Returns: boolean

_isGroup

▸ _isGroup(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:301

Tests if the value is a vaid group

Parameters:

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

_isGroupElement

▸ _isGroupElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:286

Parameters:

Returns: boolean

_isImage

▸ _isImage(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:596

Tests if an element is an image. If the element is optional, it can be null or an arbitrary object. Otherwise we must have at least an asset and a URL.

Parameters:

Returns: boolean true if we have an image, else false

_isImageElement

▸ _isImageElement(aValue: any): boolean

Defined in elements/element.ts:646

Parameters:

Returns: boolean

_isLink

▸ _isLink(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:578

Tests if we have a link element. We consider the element to exist if it has at least one of its fields set.

Parameters:

Returns: boolean true if the element is a link

_isLinkElement

▸ _isLinkElement(aValue: any): boolean

Defined in elements/element.ts:462

Parameters:

Returns: boolean

_isLocation

▸ _isLocation(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:785

Parameters:

Returns: boolean

_isLocationElement

▸ _isLocationElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:799

Parameters:

Returns: boolean

_isMultiDateElement

▸ _isMultiDateElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:270

Parameters:

Returns: boolean

_isMultiFileElement

▸ _isMultiFileElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:620

Parameters:

Returns: boolean

_isMultiFormattedTextElement

▸ _isMultiFormattedTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:365

Parameters:

Returns: boolean

_isMultiGroupElement

▸ _isMultiGroupElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:324

Parameters:

Returns: boolean

_isMultiImageElement

▸ _isMultiImageElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:669

Parameters:

Returns: boolean

_isMultiLinkElement

▸ _isMultiLinkElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:727

Parameters:

Returns: boolean

_isMultiNumberElement

▸ _isMultiNumberElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:404

Parameters:

Returns: boolean

_isMultiOptionSelectionElement

▸ _isMultiOptionSelectionElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:153

Parameters:

Returns: boolean

_isMultiProductElement

▸ _isMultiProductElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:237

Parameters:

Returns: boolean

_isMultiReferenceElement

▸ _isMultiReferenceElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:775

Parameters:

Returns: boolean

_isMultiTextElement

▸ _isMultiTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:208

Parameters:

Returns: boolean

_isMultiToggleElement

▸ _isMultiToggleElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:446

Parameters:

Returns: boolean

_isMultiVideoElement

▸ _isMultiVideoElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:698

Parameters:

Returns: boolean

_isNumber

▸ _isNumber(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:181

Parameters:

Returns: boolean

_isNumberElement

▸ _isNumberElement(aValue: any): boolean

Defined in elements/element.ts:381

Parameters:

Returns: boolean

_isOptionSelection

▸ _isOptionSelection(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:113

Parameters:

Returns: boolean

_isOptionSelectionElement

▸ _isOptionSelectionElement(aValue: any): boolean

Defined in elements/element.ts:107

Parameters:

Returns: boolean

_isProductElement

▸ _isProductElement(aValue: any): boolean

Defined in elements/element.ts:173

Parameters:

Returns: boolean

_isReference

▸ _isReference(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:747

Parameters:

Returns: boolean

_isReferenceElement

▸ _isReferenceElement(aValue: any): boolean

Defined in elements/element.ts:743

Parameters:

Returns: boolean

_isSingleDateElement

▸ _isSingleDateElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:257

Parameters:

Returns: boolean

_isSingleFileElement

▸ _isSingleFileElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:607

Parameters:

Returns: boolean

_isSingleFormattedTextElement

▸ _isSingleFormattedTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:350

Parameters:

Returns: boolean

_isSingleGroupElement

▸ _isSingleGroupElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:311

Parameters:

Returns: boolean

_isSingleImageElement

▸ _isSingleImageElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:656

Parameters:

Returns: boolean

_isSingleLinkElement

▸ _isSingleLinkElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:714

Parameters:

Returns: boolean

_isSingleNumberElement

▸ _isSingleNumberElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:391

Parameters:

Returns: boolean

_isSingleOptionSelectionElement

▸ _isSingleOptionSelectionElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:137

Parameters:

Returns: boolean

_isSingleProductElement

▸ _isSingleProductElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:224

Parameters:

Returns: boolean

_isSingleReferenceElement

▸ _isSingleReferenceElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:760

Parameters:

Returns: boolean

_isSingleTextElement

▸ _isSingleTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:195

Parameters:

Returns: boolean

_isSingleToggleElement

▸ _isSingleToggleElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:433

Parameters:

Returns: boolean

_isSingleVideoElement

▸ _isSingleVideoElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:685

Parameters:

Returns: boolean

_isSomeDateElement

▸ _isSomeDateElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:808

Parameters:

Returns: boolean

_isSomeFileElement

▸ _isSomeFileElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:818

Parameters:

Returns: boolean

_isSomeFormattedTextElement

▸ _isSomeFormattedTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:828

Parameters:

Returns: boolean

_isSomeGroupElement

▸ _isSomeGroupElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:838

Parameters:

Returns: boolean

_isSomeImageElement

▸ _isSomeImageElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:848

Parameters:

Returns: boolean

_isSomeLinkElement

▸ _isSomeLinkElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:858

Parameters:

Returns: boolean

_isSomeNumberElement

▸ _isSomeNumberElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:868

Parameters:

Returns: boolean

_isSomeOptionSelectionElement

▸ _isSomeOptionSelectionElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:878

Parameters:

Returns: boolean

_isSomeProductElement

▸ _isSomeProductElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:908

Parameters:

Returns: boolean

_isSomeReferenceElement

▸ _isSomeReferenceElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:888

Parameters:

Returns: boolean

_isSomeTextElement

▸ _isSomeTextElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:898

Parameters:

Returns: boolean

_isSomeToggleElement

▸ _isSomeToggleElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:918

Parameters:

Returns: boolean

_isSomeVideoElement

▸ _isSomeVideoElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:928

Parameters:

Returns: boolean

_isString

▸ _isString(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:177

Parameters:

Returns: boolean

_isTextElement

▸ _isTextElement(aValue: any): boolean

Defined in elements/element.ts:169

Parameters:

Returns: boolean

_isToggleElement

▸ _isToggleElement(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:420

Parameters:

Returns: boolean

_isType

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

Defined in elements/element.ts:91

Parameters:

Returns: boolean

_isTypeRef

▸ _isTypeRef(aValue: any): boolean

Defined in elements/element.ts:95

Parameters:

Returns: boolean

_isValueOf

▸ _isValueOf(aType: string, aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:1015

Tests if the value is a value element

Parameters:

Returns: boolean true if the value is a valid element

_isVideo

▸ _isVideo(aValue: any, bOptional?: boolean): boolean

Defined in elements/element.ts:564

Tests if an element is a video. If the element is optional, it can be null or an arbitrary object. Otherwise we must have at least an asset and a URL.

Parameters:

Returns: boolean true if we have an video, else false

_isVideoElement

▸ _isVideoElement(aValue: any): boolean

Defined in elements/element.ts:636

Parameters:

Returns: boolean

Object literals

<Const> ELEMENT_HANDLERS

ELEMENT_HANDLERS: object

Defined in elements/element.ts:943

Maps from element type to handler function

__computed

● __computed: _isSomeVideoElement = _isSomeVideoElement

Defined in elements/element.ts:944 Defined in elements/element.ts:945 Defined in elements/element.ts:946 Defined in elements/element.ts:947 Defined in elements/element.ts:948 Defined in elements/element.ts:949 Defined in elements/element.ts:950 Defined in elements/element.ts:951 Defined in elements/element.ts:952 Defined in elements/element.ts:953 Defined in elements/element.ts:954 Defined in elements/element.ts:955 Defined in elements/element.ts:956 Defined in elements/element.ts:957 Defined in elements/element.ts:958

<Const> VALUE_HANDLERS

VALUE_HANDLERS: object

Defined in elements/element.ts:964

Maps from element type to handler function

__computed

● __computed: _isVideo = _isVideo

Defined in elements/element.ts:965 Defined in elements/element.ts:966 Defined in elements/element.ts:967 Defined in elements/element.ts:968 Defined in elements/element.ts:969 Defined in elements/element.ts:970 Defined in elements/element.ts:971 Defined in elements/element.ts:972 Defined in elements/element.ts:973 Defined in elements/element.ts:974 Defined in elements/element.ts:975 Defined in elements/element.ts:976 Defined in elements/element.ts:977 Defined in elements/element.ts:978 Defined in elements/element.ts:979

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

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
• GeneratorOrT

Functions

• _arrayGenerator
• _constGenerator
• _fromGeneratorOrT
• _objectGenerator

Type aliases

Generator

Ƭ Generator: function

Defined in generators/generator.ts:5

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

GeneratorOrT

Ƭ GeneratorOrT: T | function

Defined in generators/generator.ts:7

Functions

<Const> _arrayGenerator

▸ _arrayGenerator<T>(): T[]

Defined in generators/generator.ts:9

Type parameters:

T

Returns: T[]

<Const> _constGenerator

▸ _constGenerator<T>(aValue: T): (Anonymous function)

Defined in generators/generator.ts:12

Type parameters:

T

Parameters:

Returns: (Anonymous function)

<Const> _fromGeneratorOrT

▸ _fromGeneratorOrT<T>(aValue: GeneratorOrT<T>): any

Defined in generators/generator.ts:14

Type parameters:

T

Parameters:

Returns: any

<Const> _objectGenerator

▸ _objectGenerator(): any

Defined in generators/generator.ts:10

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:

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:

Returns: number

_hashStringSegment

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

Defined in hash/hash.utils.ts:27

Parameters:

Returns: number

_hashToIdentifier

▸ _hashToIdentifier(aHash: number): string

Defined in hash/hash.utils.ts:61

Parameters:

Returns: string

_longCombine

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

Defined in hash/hash.utils.ts:22

Parameters:

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 > "html/html"

External module: "html/html"

Index

Variables

• _escapeMatch
• htmlEscaper

Functions

• _escapeHtml
• escapeHtml

Object literals

• htmlEscapes

Variables

<Const> _escapeMatch

● _escapeMatch: UnaryFunction<Object, never> = partialFirst(getProperty, htmlEscapes)

Defined in html/html.ts:22

Function that executes the escape

<Const> htmlEscaper

● htmlEscaper: RegExp = /&<>"'\//g

Defined in html/html.ts:17

Functions

<Const> _escapeHtml

▸ _escapeHtml(aValue: string): string

Defined in html/html.ts:25

Parameters:

Returns: string

<Const> escapeHtml

▸ escapeHtml<T>(aValue: T): string | T

Defined in html/html.ts:34

Applies HTML escaping to strings

Type parameters:

T

Parameters:

Returns: string | T

the escaped value

Object literals

<Const> htmlEscapes

htmlEscapes: object

Defined in html/html.ts:7

"

● ": string = """

Defined in html/html.ts:11

&

● &: string = "&"

Defined in html/html.ts:8

'

● ': string = "'"

Defined in html/html.ts:12

/

● /: string = "/"

Defined in html/html.ts:13

<

● <: string = "<"

Defined in html/html.ts:9

>

● >: string = ">"

Defined in html/html.ts:10

@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
• _lazyCache
• _sendJsonRequest
• _sendRequest
• _sendTextRequest

Object literals

• DEFAULT_HTTP_RESOURCE_OPTIONS

Type aliases

Request

Ƭ Request: function

Defined in http/http.utils.ts:35

Type declaration

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

Parameters:

Returns: Observable<T>

Variables

<Const> DEFAULT_POLL_TIME

● DEFAULT_POLL_TIME: number = 10 * 1000

Defined in http/http.utils.ts:194

<Const> DEFAULT_POLL_TIME_VARIATION

● DEFAULT_POLL_TIME_VARIATION: 0.15 = 0.15

Defined in http/http.utils.ts:189

<Const> DEFAULT_RETRIES

● DEFAULT_RETRIES: 10 = 10

Defined in http/http.utils.ts:199

<Const> DEFAULT_USE_API

● DEFAULT_USE_API: true = true

Defined in http/http.utils.ts:209

<Const> DEFAULT_USE_BOOTSTRAP

● DEFAULT_USE_BOOTSTRAP: true = true

Defined in http/http.utils.ts:219

<Const> DEFAULT_USE_JSONP

● DEFAULT_USE_JSONP: true = true

Defined in http/http.utils.ts:224

<Const> DEFAULT_USE_LOCAL_STORAGE

● DEFAULT_USE_LOCAL_STORAGE: true = true

Defined in http/http.utils.ts:204

<Const> DEFAULT_USE_POLLING

● DEFAULT_USE_POLLING: true = true

Defined in http/http.utils.ts:229

<Const> DEFAULT_USE_STATIC_RESOURCES

● DEFAULT_USE_STATIC_RESOURCES: true = true

Defined in http/http.utils.ts:214

<Let> ID

● ID: number = 0

Defined in http/http.utils.ts:32

<Const> LOGGER

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

Defined in http/http.utils.ts:17

<Const> MAX_POLL_TIME

● MAX_POLL_TIME: number = Number.MAX_SAFE_INTEGER

Defined in http/http.utils.ts:233

<Const> MAX_POLL_TIME_VARIATION

● MAX_POLL_TIME_VARIATION: 0.5 = 0.5

Defined in http/http.utils.ts:237

<Const> MIN_POLL_TIME

● MIN_POLL_TIME: 1000 = 1000

Defined in http/http.utils.ts:232

<Const> MIN_POLL_TIME_VARIATION

● MIN_POLL_TIME_VARIATION: 0 = 0

Defined in http/http.utils.ts:236

<Const> _addDebugSource

● _addDebugSource: function = dbgSourceCallback(LOGGER)

Defined in http/http.utils.ts:318

Type declaration

▸(aDbg: any): void

Parameters:

Returns: void

<Const> _privateUrlJsonCache

● _privateUrlJsonCache: function = _lazyCache<Observable>()

Defined in http/http.utils.ts:275

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

<Const> _privateUrlStringCache

● _privateUrlStringCache: function = _lazyCache<Observable>()

Defined in http/http.utils.ts:274

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

<Const> _publicUrlJsonCache

● _publicUrlJsonCache: function = _lazyCache<Observable>()

Defined in http/http.utils.ts:271

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

<Const> _publicUrlStringCache

● _publicUrlStringCache: function = _lazyCache<Observable>()

Defined in http/http.utils.ts:270

Type declaration

▸(): T | null | undefined

Returns: T | null | undefined

Functions

_addDebug

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

Defined in http/http.utils.ts:326

Add debugging information to the result

Parameters:

Returns: JsonMap

_clip

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

Defined in http/http.utils.ts:246

Parameters:

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:336

Parameters:

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:367

Parameters:

Returns: Observable<string>

_createTimer

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

Defined in http/http.utils.ts:283

Parameters:

Returns: Observable<any>

_getErrorResponse

▸ _getErrorResponse(aError: any): ErrorResponse

Defined in http/http.utils.ts:43

Build an error response object

Parameters:

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:441

Parameters:

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:404

Represents an HTTP request, potentially made via the cache

Parameters:

Returns: Observable<string>

_lazyCache

▸ _lazyCache<V>(): function

Defined in http/http.utils.ts:265

Creates a cache that will generated lazily

Type parameters:

V

Returns: function

_sendJsonRequest

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

Defined in http/http.utils.ts:142

Type parameters:

T

Parameters:

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:69

Type parameters:

T

Parameters:

Returns: Observable<T>

_sendTextRequest

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

Defined in http/http.utils.ts:169

Parameters:

Returns: Observable<string>

Object literals

<Const> DEFAULT_HTTP_RESOURCE_OPTIONS

DEFAULT_HTTP_RESOURCE_OPTIONS: object

Defined in http/http.utils.ts:250

pollTime

● pollTime: number = DEFAULT_POLL_TIME

Defined in http/http.utils.ts:252

pollTimeVariation

● pollTimeVariation: number = DEFAULT_POLL_TIME_VARIATION

Defined in http/http.utils.ts:251

retries

● retries: number = DEFAULT_RETRIES

Defined in http/http.utils.ts:253

useApi

● useApi: true = DEFAULT_USE_API

Defined in http/http.utils.ts:259

useBootstrap

● useBootstrap: true = DEFAULT_USE_BOOTSTRAP

Defined in http/http.utils.ts:255

useJsonP

● useJsonP: true = DEFAULT_USE_JSONP

Defined in http/http.utils.ts:257

useLocalStorage

● useLocalStorage: true = DEFAULT_USE_LOCAL_STORAGE

Defined in http/http.utils.ts:254

usePolling

● usePolling: true = DEFAULT_USE_POLLING

Defined in http/http.utils.ts:258

useStaticResources

● useStaticResources: true = DEFAULT_USE_STATIC_RESOURCES

Defined in http/http.utils.ts:256

@ibm-wch-sdk/utils > "i18n/localized"

External module: "i18n/localized"

Index

Variables

• localizedText
• pluckLocale
• pluckText

Functions

• cmpByLocalizedContext
• isLocalizedText

Variables

<Const> localizedText

● localizedText: BiFunction<string, Locale, LocalizedText> = zipArgs as any

Defined in i18n/localized.ts:20

expose a tuple as text

<Const> pluckLocale

● pluckLocale: UnaryFunction<LocalizedText, Locale> = partialSecond( getProperty, 1 ) as any

Defined in i18n/localized.ts:29

Accessor for locales from a localized context

<Const> pluckText

● pluckText: UnaryFunction<LocalizedText, string> = partialSecond( getProperty, 0 ) as any

Defined in i18n/localized.ts:37

Accessor for text from a localized context

Functions

<Const> cmpByLocalizedContext

▸ cmpByLocalizedContext(locContext: object): function

Defined in i18n/localized.ts:51

Returns a comparator that orders localizations according to the preferences of a localized context

Parameters:

Returns: function

isLocalizedText

▸ isLocalizedText(aText: any): boolean

Defined in i18n/localized.ts:68

Tests if a value is a localized context

Parameters:

Returns: boolean true if the text is a localized context, else false

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

Returns: void

<Let> _setCallback

● _setCallback: function

Defined in idle/idle.ts:4

Type declaration

▸(aFct: Function): number

Parameters:

Returns: number

cancelIdleCallback

● cancelIdleCallback: function

Defined in idle/idle.ts:8

Type declaration

▸(aHandle: number): void

Parameters:

Returns: void

requestIdleCallback

● requestIdleCallback: function

Defined in idle/idle.ts:7

Type declaration

▸(aCallback: Function): number

Parameters:

Returns: number

@ibm-wch-sdk/utils > "index"

External module: "index"

Index

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

External module: "js/js.core"

Index

Interfaces

• SpreadArgs
• ZippedArgs

Variables

• UNDEFINED
• arraySlice
• zipArgs

Functions

• _zipArgs
• and
• biCompose
• biComposeMono
• compose
• composeAll
• flipArgs
• getProperty
• not
• or
• partialFirst
• partialSecond
• pluckProperty
• propertyFromObject
• spreadArgs
• ternary
• toArray

Variables

<Const> UNDEFINED

● UNDEFINED: any = undefined

Defined in js/js.core.ts:6

<Const> arraySlice

● arraySlice: slice = Array.prototype.slice

Defined in js/js.core.ts:197

<Const> zipArgs

● zipArgs: ZippedArgs = _zipArgs as any

Defined in js/js.core.ts:210

Expose the array method in a strongly typed way

Functions

_zipArgs

▸ _zipArgs(): any

Defined in js/js.core.ts:203

Make a shallow copy of the arguments.

The alternative would have been to use Array.of, but is this supported, everywhere?

Returns: any

<Const> and

▸ and(aLeft: function, aRight: function): (Anonymous function)

Defined in js/js.core.ts:104

Performs the "and" function

Parameters:

Returns: (Anonymous function) the or function

<Const> biCompose

▸ biCompose(aFirst: UnaryFunction<S1, D1>, aSecond: UnaryFunction<S2, D2>, aFct: function): (Anonymous function)

Defined in js/js.core.ts:149

Represents the composition of two functions

Parameters:

Returns: (Anonymous function)

<Const> biComposeMono

▸ biComposeMono(aTransform: UnaryFunction<S, D>, aFct: function): function

Defined in js/js.core.ts:163

Represents the composition of two functions where they have the same argument

Parameters:

Returns: function

<Const> compose

▸ compose(aLeft: UnaryFunction<T1, T2>, aRight: UnaryFunction<T2, R>): (Anonymous function)

Defined in js/js.core.ts:134

Represents the composition of two functions

Parameters:

Returns: (Anonymous function)

<Const> composeAll

▸ composeAll(...aFunctions: Function[]): (Anonymous function)

Defined in js/js.core.ts:175

Composes the sequence of functions

Parameters:

Returns: (Anonymous function) the composition result

<Const> flipArgs

▸ flipArgs(aFct: function): (Anonymous function)

Defined in js/js.core.ts:181

switch the order of arguments

Parameters:

Returns: (Anonymous function)

<Const> getProperty

▸ getProperty<T,K>(aValue: T, aKey: K, aDefault?: T[K] | undefined): T[K]

Defined in js/js.core.ts:42

Generates a function that returns a property

Type parameters:

T

K : keyof T

Parameters:

Returns: T[K] extractor function

<Const> not

▸ not(aFct: function): (Anonymous function)

Defined in js/js.core.ts:78

Negates a function

Parameters:

Returns: (Anonymous function) the negated function

<Const> or

▸ or(aLeft: function, aRight: function): (Anonymous function)

Defined in js/js.core.ts:90

Performs the "or" function

Parameters:

Returns: (Anonymous function) the or function

<Const> partialFirst

▸ partialFirst(aFunction: function, aFirst: T1): (Anonymous function)

Defined in js/js.core.ts:33

Binds the first parameter

Parameters:

Returns: (Anonymous function) the reduced function

<Const> partialSecond

▸ partialSecond(aFunction: function, aSecond: T2): (Anonymous function)

Defined in js/js.core.ts:19

Binds the second parameter

Parameters:

Returns: (Anonymous function) the reduced function

<Const> pluckProperty

▸ pluckProperty<T,K>(aKey: K, aDefault?: T[K] | undefined): UnaryFunction<T, T[K]>

Defined in js/js.core.ts:54

Generates a function that returns a property

Type parameters:

T

K : keyof T

Parameters:

Returns: UnaryFunction<T, T[K]> extractor function

<Const> propertyFromObject

▸ propertyFromObject<T,K>(aValue: T, aDefault?: T[K] | undefined): UnaryFunction<K, T[K]>

Defined in js/js.core.ts:65

Generates a function that returns a property

Type parameters:

T

K : keyof T

Parameters:

Returns: UnaryFunction<K, T[K]> extractor function

<Const> spreadArgs

▸ spreadArgs(aFct: Function, aArgs: any[]): any

Defined in js/js.core.ts:229

Parameters:

Returns: any

<Const> ternary

▸ ternary(aPredicate: function, aLeft: UnaryFunction<T, R>, aRight: UnaryFunction<T, R>): (Anonymous function)

Defined in js/js.core.ts:120

Performs the ternary operation

Parameters:

Returns: (Anonymous function) the or function

<Const> toArray

▸ toArray(aValue: ArrayLike<T>): any

Defined in js/js.core.ts:238

Converts an array like to an arry

Parameters:

Returns: any the array

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

External module: "js/js.utils"

Index

Interfaces

• Bind
• BindKey
• BindMember
• Partial

Type aliases

• Function0
• Function1
• Function2
• Function3
• Function4

Variables

• KEY_DEBUG
• _FUNCTION_TYPE
• _UNDEFINED_TYPE
• _assign
• _binary
• _bind
• _bindKey
• _bindMember
• _freeze
• _isFrozen
• _keys
• _unary

Functions

• __bind
• __bindKey
• __bindMember
• _anyToString
• _arrayEquals
• _arrayFind
• _assertArray
• _assertFromGenerator
• _assertObject
• _byProperty
• _cloneDeep
• _createGetter
• _deepEquals
• _forEach
• _forIn
• _freezeDeep
• _isDeepEqualTo
• _lastElement
• _mergeObjects
• _nary
• _nthElement
• _objectAssign
• _objectEquals
• _partialLeft
• _push
• _random
• _reduceForIn
• _reduceToObject
• _toInteger

Type aliases

Function0

Ƭ Function0: function

Defined in js/js.utils.ts:407

Type declaration

▸(): R

Returns: R

Function1

Ƭ Function1: function

Defined in js/js.utils.ts:408

Type declaration

▸(t1: T1): R

Parameters:

Returns: R

Function2

Ƭ Function2: function

Defined in js/js.utils.ts:409

Type declaration

▸(t1: T1, t2: T2): R

Parameters:

Returns: R

Function3

Ƭ Function3: function

Defined in js/js.utils.ts:410

Type declaration

▸(t1: T1, t2: T2, t3: T3): R

Parameters:

Returns: R

Function4

Ƭ Function4: function

Defined in js/js.utils.ts:411

Type declaration

▸(t1: T1, t2: T2, t3: T3, t4: T4): R

Parameters:

Returns: R

Variables

<Const> KEY_DEBUG

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

Defined in js/js.utils.ts:20

<Const> _FUNCTION_TYPE

● _FUNCTION_TYPE: * "string" | "number" | "boolean" | "symbol" | "undefined" | "object" | "function"

• = typeof _keys

Defined in js/js.utils.ts:215

<Const> _UNDEFINED_TYPE

● _UNDEFINED_TYPE: * "string" | "number" | "boolean" | "symbol" | "undefined" | "object" | "function"

• = typeof UNDEFINED

Defined in js/js.utils.ts:214

<Const> _assign

● _assign: assign = Object.assign

Defined in js/js.utils.ts:26

<Const> _binary

● _binary: function = partialFirst(_nary, 2) as any

Defined in js/js.utils.ts:403

Guarantees a binary function param: the original function

returns: the binary function

Type declaration

▸<T1,T2,R>(aFunction: function): BiFunction<T1, T2, R>

Type parameters:

T1

T2

R

Parameters:

Returns: BiFunction<T1, T2, R>

<Const> _bind

● _bind: Bind = __bind as any

Defined in js/js.utils.ts:570

Our simple implementation param: the original function

param: the this argument

param: the arguments

returns: the final function

<Const> _bindKey

● _bindKey: BindKey = __bindKey as any

Defined in js/js.utils.ts:681

The bind member magic

<Const> _bindMember

● _bindMember: BindMember = __bindMember as any

Defined in js/js.utils.ts:624

The bind member magic

<Const> _freeze

● _freeze: freeze = Object.freeze

Defined in js/js.utils.ts:28

<Const> _isFrozen

● _isFrozen: isFrozen = Object.isFrozen

Defined in js/js.utils.ts:29

<Const> _keys

● _keys: keys = Object.keys

Defined in js/js.utils.ts:25

<Const> _unary

● _unary: function = partialFirst(_nary, 1) as any

Defined in js/js.utils.ts:393

Guarantees a unary function param: the original function

returns: the unary function

Type declaration

▸<T,R>(aFunction: function): UnaryFunction<T, R>

Type parameters:

T

R

Parameters:

Returns: UnaryFunction<T, R>

Functions

__bind

▸ __bind(): any

Defined in js/js.utils.ts:556

Returns: any

__bindKey

▸ __bindKey(): ___bindKey

Defined in js/js.utils.ts:662

Our simple implementation

Returns: ___bindKey the final function

__bindMember

▸ __bindMember(): any

Defined in js/js.utils.ts:615

Our simple implementation

Returns: any the final function

<Const> _anyToString

▸ _anyToString(aValue: any): string

Defined in js/js.utils.ts:128

Parameters:

Returns: string

<Const> _arrayEquals

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

Defined in js/js.utils.ts:38

Type parameters:

T

Parameters:

Returns: boolean

<Const> _arrayFind

▸ _arrayFind<T>(aArray: T[], aPredicate: Predicate<T>): T

Defined in js/js.utils.ts:711

Locates an element in an array

Type parameters:

T

Parameters:

Returns: T

<Const> _assertArray

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

Defined in js/js.utils.ts:182

Type parameters:

T

Parameters:

Returns: T[]

<Const> _assertFromGenerator

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

Defined in js/js.utils.ts:173

Type parameters:

T

Parameters:

Returns: T

<Const> _assertObject

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

Defined in js/js.utils.ts:179

Type parameters:

T

Parameters:

Returns: T

<Const> _byProperty

▸ _byProperty<T,K>(aKey: K, aPredicate: Predicate<T[K]>): Predicate<T>

Defined in js/js.utils.ts:332

Generates a predicate that compares a named property of an object with another predicate

Type parameters:

T

K : keyof T

Parameters:

Returns: Predicate<T> the final predicate

_cloneDeep

▸ _cloneDeep(aValue: any): any

Defined in js/js.utils.ts:154

Parameters:

Returns: any

_createGetter

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

Defined in js/js.utils.ts:265

Constructs a getter description

Type parameters:

T

Parameters:

Returns: PropertyDescriptor the description of the getter

<Const> _deepEquals

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

Defined in js/js.utils.ts:108

Parameters:

Returns: boolean

<Const> _forEach

▸ _forEach<T>(aArray: T[], aConsumer: Consumer<T>): void

Defined in js/js.utils.ts:343

Just run a callback for each element in an array

Type parameters:

T

Parameters:

Returns: void

_forIn

▸ _forIn<T>(aObject: object, aConsumer: BiConsumer<T, string>): void

Defined in js/js.utils.ts:352

Run a callback for each key value pair

Type parameters:

T

Parameters:

Returns: void

_freezeDeep

▸ _freezeDeep(aValue: any): any

Defined in js/js.utils.ts:222

Parameters:

Returns: any

<Const> _isDeepEqualTo

▸ _isDeepEqualTo<T>(aComparison: T): Predicate<T>

Defined in js/js.utils.ts:702

Returns a function that tests if a value is equal to another value

Type parameters:

T

Parameters:

Returns: Predicate<T> the predicate

<Const> _lastElement

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

Defined in js/js.utils.ts:185

Type parameters:

T

Parameters:

Returns: T

_mergeObjects

▸ _mergeObjects<T>(aLeft: T, aRight: T): T

Defined in js/js.utils.ts:721

Merge objects together and consider undefined or empty objects as not overridable

Type parameters:

T

Parameters:

Returns: T the resulting object

_nary

▸ _nary(aArity: number, aFunction: Function): Function

Defined in js/js.utils.ts:374

Implements a wrapper function that limits the arguments to the given size

Parameters:

Returns: Function the limited function

<Const> _nthElement

▸ _nthElement<T>(aArray: T[], aIndex: number): T

Defined in js/js.utils.ts:188

Type parameters:

T

Parameters:

Returns: T

<Const> _objectAssign

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

Defined in js/js.utils.ts:144

Type parameters:

T

V

Parameters:

Returns: T

<Const> _objectEquals

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

Defined in js/js.utils.ts:72

Parameters:

Returns: boolean

<Const> _partialLeft

▸ _partialLeft(aFunction: function, ...aArgs: any[]): any

Defined in js/js.utils.ts:691

Our simple implementation

Parameters:

Returns: any the final function

<Const> _push

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

Defined in js/js.utils.ts:123

Type parameters:

T

Parameters:

Returns: T[]

_random

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

Defined in js/js.utils.ts:255

Parameters:

Returns: number

_reduceForIn

▸ _reduceForIn<T,R>(aObject: Record<string, T> | any, aFunction: function, aInitial: R): R

Defined in js/js.utils.ts:279

Run a callback for each key value pair

Type parameters:

T

R

Parameters:

Returns: R

_reduceToObject

▸ _reduceToObject<T,V>(aArray: T[], aKeyExtractor: UnaryFunction<T, string>, aTransformer?: UnaryFunction<T, V>): Record<string, V>

Defined in js/js.utils.ts:307