X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FUtils.ts;h=aeed9b0fa44b4a073bff682583c95695cbb954ac;hb=8a4f882a2486682b72195ad978ec1d81604b452b;hp=6f4517bee1b5aaf213698fbb976c421660ef1f6d;hpb=bfcd3a878051b75b9ed43421fe872121c43175f7;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts index 6f4517be..aeed9b0f 100644 --- a/src/utils/Utils.ts +++ b/src/utils/Utils.ts @@ -1,4 +1,4 @@ -import { getRandomValues, randomBytes, randomInt, randomUUID } from 'node:crypto' +import { getRandomValues, randomBytes, randomUUID } from 'node:crypto' import { env, nextTick } from 'node:process' import { @@ -12,19 +12,26 @@ import { minutesToSeconds, secondsToMilliseconds } from 'date-fns' +import { is } from 'rambda' -import { Constants } from './Constants.js' -import { type TimestampedData, WebSocketCloseEventStatusString } from '../types/index.js' +import { + type JsonType, + MapStringifyFormat, + type TimestampedData, + WebSocketCloseEventStatusString +} from '../types/index.js' export const logPrefix = (prefixString = ''): string => { return `${new Date().toLocaleString()}${prefixString}` } -export const generateUUID = (): string => { +export const generateUUID = (): `${string}-${string}-${string}-${string}-${string}` => { return randomUUID() } -export const validateUUID = (uuid: string): boolean => { +export const validateUUID = ( + uuid: `${string}-${string}-${string}-${string}-${string}` +): uuid is `${string}-${string}-${string}-${string}-${string}` => { return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(uuid) } @@ -77,14 +84,14 @@ export const isValidDate = (date: Date | number | undefined): date is Date | num export const convertToDate = ( value: Date | string | number | undefined | null -): Date | undefined | null => { +): Date | undefined => { if (value == null) { - return value + return undefined } if (isDate(value)) { return value } - if (isString(value) || typeof value === 'number') { + if (typeof value === 'string' || typeof value === 'number') { const valueToDate = new Date(value) if (isNaN(valueToDate.getTime())) { throw new Error(`Cannot convert to date: '${value}'`) @@ -97,14 +104,14 @@ export const convertToInt = (value: unknown): number => { if (value == null) { return 0 } - let changedValue: number = value as number if (Number.isSafeInteger(value)) { return value as number } if (typeof value === 'number') { return Math.trunc(value) } - if (isString(value)) { + let changedValue: number = value as number + if (typeof value === 'string') { changedValue = parseInt(value) } if (isNaN(changedValue)) { @@ -118,7 +125,7 @@ export const convertToFloat = (value: unknown): number => { return 0 } let changedValue: number = value as number - if (isString(value)) { + if (typeof value === 'string') { changedValue = parseFloat(value) } if (isNaN(changedValue)) { @@ -133,7 +140,7 @@ export const convertToBoolean = (value: unknown): boolean => { // Check the type if (typeof value === 'boolean') { return value - } else if (isString(value) && (value.toLowerCase() === 'true' || value === '1')) { + } else if (typeof value === 'string' && (value.toLowerCase() === 'true' || value === '1')) { result = true } else if (typeof value === 'number' && value === 1) { result = true @@ -152,15 +159,6 @@ export const getRandomFloat = (max = Number.MAX_VALUE, min = 0): number => { return (randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min } -export const getRandomInteger = (max = Constants.MAX_RANDOM_INTEGER, min = 0): number => { - max = Math.floor(max) - if (min !== 0) { - min = Math.ceil(min) - return Math.floor(randomInt(min, max + 1)) - } - return Math.floor(randomInt(max + 1)) -} - /** * Rounds the given number to the given scale. * The rounding is done using the "round half away from zero" method. @@ -206,72 +204,23 @@ export const extractTimeSeriesValues = (timeSeries: TimestampedData[]): number[] return timeSeries.map(timeSeriesItem => timeSeriesItem.value) } -type CloneableData = - | number - | string - | boolean - | null - | undefined - | Date - | CloneableData[] - | { [key: string]: CloneableData } - -type FormatKey = (key: string) => string - -const deepClone = ( - value: I, - formatKey?: FormatKey, - refs: Map = new Map() -): O => { - const ref = refs.get(value) - if (ref !== undefined) { - return ref - } - if (Array.isArray(value)) { - const clone: CloneableData[] = [] - refs.set(value, clone as O) - for (let i = 0; i < value.length; i++) { - clone[i] = deepClone(value[i], formatKey, refs) - } - return clone as O - } - if (value instanceof Date) { - return new Date(value.valueOf()) as O - } - if (typeof value !== 'object' || value === null) { - return value as unknown as O - } - const clone: Record = {} - refs.set(value, clone as O) - for (const key of Object.keys(value)) { - clone[typeof formatKey === 'function' ? formatKey(key) : key] = deepClone( - value[key], - formatKey, - refs - ) - } - return clone as O -} - export const clone = (object: T): T => { - return deepClone(object as CloneableData) as T + return structuredClone(object) } -export const isObject = (value: unknown): value is object => { - return value != null && typeof value === 'object' && !Array.isArray(value) +/** + * 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 => { + return is(Function, fn) && fn.constructor.name === 'AsyncFunction' } -export const isEmptyObject = (object: object): object is Record => { - 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 +export const isObject = (value: unknown): value is object => { + return value != null && !Array.isArray(value) && is(Object, value) } export const hasOwnProp = (value: unknown, property: PropertyKey): boolean => { @@ -282,20 +231,8 @@ export const isCFEnvironment = (): boolean => { return env.VCAP_APPLICATION != null } -const isString = (value: unknown): value is string => { - return typeof value === 'string' -} - -export const isEmptyString = (value: unknown): value is '' | undefined | null => { - return value == null || (isString(value) && value.trim().length === 0) -} - export const isNotEmptyString = (value: unknown): value is string => { - return isString(value) && value.trim().length > 0 -} - -export const isEmptyArray = (value: unknown): value is never[] => { - return Array.isArray(value) && value.length === 0 + return typeof value === 'string' && value.trim().length > 0 } export const isNotEmptyArray = (value: unknown): value is unknown[] => { @@ -327,18 +264,30 @@ export const secureRandom = (): number => { return getRandomValues(new Uint32Array(1))[0] / 0x100000000 } -export const JSONStringifyWithMapSupport = ( - object: Record | Array> | Map, - space?: number -): string => { +export const JSONStringify = < + T extends + | JsonType + | Array> + | Set> + | Map> +>( + object: T, + space?: string | number, + mapFormat?: MapStringifyFormat + ): string => { return JSON.stringify( object, (_, value: Record) => { - if (value instanceof Map) { - return { - dataType: 'Map', - value: [...value] + if (is(Map, value)) { + switch (mapFormat) { + case MapStringifyFormat.object: + return { ...Object.fromEntries>>(value.entries()) } + case MapStringifyFormat.array: + default: + return [...value] } + } else if (is(Set, value)) { + return [...value] as JsonType[] } return value }, @@ -384,28 +333,6 @@ export const isArraySorted = (array: T[], compareFn: (a: T, b: T) => number): return true } -// eslint-disable-next-line @typescript-eslint/no-explicit-any -export const once = ( - fn: (...args: A) => R, - context: T -): ((...args: A) => R) => { - let result: R - return (...args: A) => { - // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition - if (fn != null) { - result = fn.apply(context, args) - ;(fn as unknown as undefined) = (context as unknown as undefined) = undefined - } - return result - } -} - -export const min = (...args: number[]): number => - args.reduce((minimum, num) => (minimum < num ? minimum : num), Infinity) - -export const max = (...args: number[]): number => - args.reduce((maximum, num) => (maximum > num ? maximum : num), -Infinity) - export const throwErrorInNextTick = (error: Error): void => { nextTick(() => { throw error