Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @sap/cloud-sdk-util

cloud-sdk-utils

Package that contains general utility functions that we reuse multiple times in the SDK. While primarily designed for internal usage, they might also be benefical for consumers of the SDK.

Helpful Links

Index

Interfaces

Variables

Functions

Variables

Const cloudSdkExceptionLogger

cloudSdkExceptionLogger: Logger = container.get(exceptionLoggerId, {defaultMeta: { logger, test: 'exception' },format,exceptionHandlers: [exceptionTransport]})

Default logger for the SAP Cloud SDK for unhandled exceptions.

Const kibana

kibana: Format = combine(timestamp(),format(info => ({...info,msg: info.message,written_ts: new Date(info.timestamp).getTime(),written_at: info.timestamp}))(),json())

Format for logging in Kibana.

Const local

local: Format = combine(timestamp(),format(info => ({...info,level: info.level.toUpperCase()}))(),cli(),printf(info => {const messageContext = info.custom_fields && info.custom_fields.messageContext ? `${chalk.blue(`(${info.custom_fields.messageContext})`)}: ` : '';const trimmedMessage = info.message.replace(/^\s*/, '');const paddingLength = info.message.length - trimmedMessage.length + messageContext.length;if (info.error) {info.level = chalk.inverse(info.level);}return `${chalk.gray(`[${info.timestamp}]`)} ${info.level} ${messageContext.padStart(paddingLength, ' ')}${trimmedMessage}`;}))

Format for local logging.

Functions

Const assocSome

  • assocSome<T>(key: string, value?: any): (Anonymous function)

  • Calls rambda's assoc function if the provided value is neither null nor undefined. Note that this is different to JS idiomatic checks for truthy/falsy values, i.e. an empty string will result in assoc being called.

    Type parameters

    • T

    Parameters

    • key: string

      The key to associate with the given value.

    • Optional value: any

      The value to associate with the given key.

    Returns (Anonymous function)

    A copy of the input object with the new key-value pair if the value is neither null nor undefined.

Const asyncPipe

  • asyncPipe(...fns: any[]): (Anonymous function)

  • Works similar to Ramdas pipe function, but works on promises, which allows using async functions.

    Parameters

    • Rest ...fns: any[]

      The functions to be chained.

    Returns (Anonymous function)

Const createLogger

  • Create a logger for the given message context.

    Parameters

    • Optional messageContext: string | MessageContextObj & LoggerOptions

      Either a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.

    Returns Logger

    A newly created or an already existing logger for the given context.

Const disableExceptionLogger

  • disableExceptionLogger(): void

  • Disable logging of exceptions. Enabled by default.

    Returns void

Const enableExceptionLogger

  • enableExceptionLogger(): void

  • Enable logging of exceptions. Enabled by default.

    Returns void

errorWithCause

  • errorWithCause(message: string, cause: Error): Error

  • Creates a new error using the provided message and appends the causes stacktrace to the new error's stacktrace.

    Parameters

    • message: string

      The message of the new error.

    • cause: Error

      The original error.

    Returns Error

    A new error instance.

flat

  • flat<T>(arr: T[][]): T[]

  • Flatten a multidimensional array

    Type parameters

    • T

    Parameters

    • arr: T[][]

      Multidimensional array to be flattened

    Returns T[]

    Flattened array

Const mergeSome

  • mergeSome(a: MapType<any>, b?: MapType<any>): MapType<any>

  • Calls rambda's merge function if second object is neither null nor undefined.

    Parameters

    • a: MapType<any>

      The object to merge into.

    • Optional b: MapType<any>

      The object which to merge into a.

    Returns MapType<any>

    A copy of the merge(a, b) or a if b is undefined or null.

propertyExists

  • propertyExists(obj: object, ...properties: string[]): boolean

  • Checks if a chain of properties exists on the given object.

    Parameters

    • obj: object

      The object to be checked.

    • Rest ...properties: string[]

      Chained properties.

    Returns boolean

    True if the property chain leads to a truthy value, false otherwise.

Const renameKeys

  • renameKeys(keyMapping: MapType<string>, obj: MapType<any>): MapType<any>

  • Takes an object and returns a new object whose keys are renamed according to the provided key mapping. Any keys in the input object not present in the key mapping will be present in the output object as-is. If a key in the key mapping is not present in the input object, the output object will contain the key with value "undefined".

    Parameters

    • keyMapping: MapType<string>

      An object mapping keys of the input object to keys of the output object.

    • obj: MapType<any>

      The input object.

    Returns MapType<any>

    An object with renamed keys.

unique

  • unique<T>(words: T[]): T[]

  • Remove all duplicates from array

    Type parameters

    • T

    Parameters

    • words: T[]

      Array of strings that might contain duplicates

    Returns T[]

    Array of unique strings