} from 'date-fns'
import { Constants } from './Constants.js'
-import { type TimestampedData, WebSocketCloseEventStatusString } from '../types/index.js'
+import {
+ type EmptyObject,
+ type TimestampedData,
+ WebSocketCloseEventStatusString
+} from '../types/index.js'
export const logPrefix = (prefixString = ''): string => {
return `${new Date().toLocaleString()}${prefixString}`
}
export const sleep = async (milliSeconds: number): Promise<NodeJS.Timeout> => {
- return await new Promise<NodeJS.Timeout>((resolve) =>
+ return await new Promise<NodeJS.Timeout>(resolve =>
setTimeout(resolve as () => void, milliSeconds)
)
}
}
// More efficient time validation function than the one provided by date-fns
-export const isValidTime = (date: unknown): boolean => {
+export const isValidDate = (date: Date | number | undefined): date is Date | number => {
if (typeof date === 'number') {
return !isNaN(date)
} else if (isDate(date)) {
}
export const convertToDate = (
- value: Date | string | number | null | undefined
-): Date | null | undefined => {
+ value: Date | string | number | undefined | null
+): Date | undefined => {
if (value == null) {
- return value
+ return undefined
}
if (isDate(value)) {
return value
}
if (isString(value) || typeof value === 'number') {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const valueToDate = new Date(value)
if (isNaN(valueToDate.getTime())) {
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
throw new Error(`Cannot convert to date: '${value}'`)
}
return valueToDate
return Math.trunc(value)
}
if (isString(value)) {
- changedValue = parseInt(value as string)
+ changedValue = parseInt(value)
}
if (isNaN(changedValue)) {
throw new Error(`Cannot convert to integer: '${String(value)}'`)
}
let changedValue: number = value as number
if (isString(value)) {
- changedValue = parseFloat(value as string)
+ changedValue = parseFloat(value)
}
if (isNaN(changedValue)) {
throw new Error(`Cannot convert to float: '${String(value)}'`)
// Check the type
if (typeof value === 'boolean') {
return value
- } else if (isString(value) && ((value as string).toLowerCase() === 'true' || value === '1')) {
+ } else if (isString(value) && (value.toLowerCase() === 'true' || value === '1')) {
result = true
} else if (typeof value === 'number' && value === 1) {
result = true
export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => {
max = Math.floor(max)
- if (min != null && min !== 0) {
+ if (min !== 0) {
min = Math.ceil(min)
return Math.floor(randomInt(min, max + 1))
}
}
export const getRandomFloatRounded = (max = Number.MAX_VALUE, min = 0, scale = 2): number => {
- if (min != null && min !== 0) {
+ if (min !== 0) {
return roundTo(getRandomFloat(max, min), scale)
}
return roundTo(getRandomFloat(max), scale)
}
export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] => {
- return timeSeries.map((timeSeriesItem) => timeSeriesItem.value)
-}
-
-export const isObject = (item: unknown): boolean => {
- return item != null && typeof item === 'object' && !Array.isArray(item)
+ return timeSeries.map(timeSeriesItem => timeSeriesItem.value)
}
type CloneableData =
return clone as O
}
if (value instanceof Date) {
- return new Date(value.valueOf()) as O
+ return new Date(value.getTime()) as O
}
if (typeof value !== 'object' || value === null) {
return value as unknown as O
return clone as O
}
-export const cloneObject = <T>(object: T): T => {
+export const clone = <T>(object: T): T => {
return deepClone(object as CloneableData) as T
}
-export const hasOwnProp = (object: unknown, property: PropertyKey): boolean => {
- return isObject(object) && Object.hasOwn(object as object, property)
+/**
+ * Detects whether the given value is an asynchronous function or not.
+ *
+ * @param fn - Unknown value.
+ * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
+ * @internal
+ */
+export const isAsyncFunction = (fn: unknown): fn is (...args: unknown[]) => Promise<unknown> => {
+ return typeof fn === 'function' && fn.constructor.name === 'AsyncFunction'
}
-export const isCFEnvironment = (): boolean => {
- return env.VCAP_APPLICATION != null
+export const isObject = (value: unknown): value is object => {
+ return value != null && typeof value === 'object' && !Array.isArray(value)
}
-export const isIterable = <T>(obj: T): boolean => {
- return obj != null ? typeof obj[Symbol.iterator as keyof T] === 'function' : false
+export const isEmptyObject = (object: object): object is EmptyObject => {
+ if (object.constructor !== Object) {
+ return false
+ }
+ // Iterates over the keys of an object, if
+ // any exist, return false.
+ // eslint-disable-next-line no-unreachable-loop
+ for (const _ in object) {
+ return false
+ }
+ return true
}
-const isString = (value: unknown): boolean => {
- return typeof value === 'string'
+export const hasOwnProp = (value: unknown, property: PropertyKey): boolean => {
+ return isObject(value) && Object.hasOwn(value, property)
}
-export const isEmptyString = (value: unknown): boolean => {
- return value == null || (isString(value) && (value as string).trim().length === 0)
+export const isCFEnvironment = (): boolean => {
+ return env.VCAP_APPLICATION != null
}
-export const isNotEmptyString = (value: unknown): boolean => {
- return isString(value) && (value as string).trim().length > 0
+const isString = (value: unknown): value is string => {
+ return typeof value === 'string'
}
-export const isUndefined = (value: unknown): boolean => {
- return value === undefined
+export const isEmptyString = (value: unknown): value is '' | undefined | null => {
+ return value == null || (isString(value) && value.trim().length === 0)
}
-export const isEmptyArray = (object: unknown): boolean => {
- return Array.isArray(object) && object.length === 0
+export const isNotEmptyString = (value: unknown): value is string => {
+ return isString(value) && value.trim().length > 0
}
-export const isNotEmptyArray = (object: unknown): boolean => {
- return Array.isArray(object) && object.length > 0
+export const isEmptyArray = (value: unknown): value is never[] => {
+ return Array.isArray(value) && value.length === 0
}
-export const isEmptyObject = (obj: object): boolean => {
- if (obj?.constructor !== Object) {
- return false
- }
- // Iterates over the keys of an object, if
- // any exist, return false.
- // eslint-disable-next-line no-unreachable-loop
- for (const _ in obj) {
- return false
- }
- return true
+export const isNotEmptyArray = (value: unknown): value is unknown[] => {
+ return Array.isArray(value) && value.length > 0
}
export const insertAt = (str: string, subStr: string, pos: number): string =>
}
export const JSONStringifyWithMapSupport = (
- obj: Record<string, unknown> | Array<Record<string, unknown>> | Map<unknown, unknown>,
+ object: Record<string, unknown> | Array<Record<string, unknown>> | Map<unknown, unknown>,
space?: number
): string => {
return JSON.stringify(
- obj,
+ object,
(_, value: Record<string, unknown>) => {
if (value instanceof Map) {
return {
}
}
if (
- !isUndefined(
- WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString]
- )
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString] != null
) {
return WebSocketCloseEventStatusString[code as keyof typeof WebSocketCloseEventStatusString]
}
): ((...args: A) => R) => {
let result: R
return (...args: A) => {
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (fn != null) {
result = fn.apply<T, A, R>(context, args)
;(fn as unknown as undefined) = (context as unknown as undefined) = undefined