topkat-utils
v1.2.111
Published
FAST AND FUNCTIONAL UTILS
Downloads
1,374
Readme
|\_____/| ▀▀▀█▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ |\_____/|
| ||| | █ █▀▀█ █▀▀█ █ █ ▄▀▀▄ ▀▀█▀▀ █ █ ▀▀█▀▀ █ █ █▀▀▀ | ||| |
\◥■■=■■◤/ █ █ █ █▀▀▀ █▀▀▄ █▀▀█ █ █ █ █ █ █ ▀▀▀█ \◥■■=■■◤/
\__^__/ ▀ ▀▀▀▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀▀▀▀ ▀ ▀ ▀▀▀ ▀▀▀▀ \__^__/
⚡️ Fast, functional and typed utils ⚡️
const topkatUtils = {
isset, // check undefined or null values but not falsey
random, // random number between two values
cln, // clean string for print. Eg: undefined, null, NaN => '-'
pad, // simple padStart for numbers
isObject, // check is value is a "straight" object (not null, not date, not an array, not undefined...)
/** return the number or the closest number of the range
* * nb min max => returns
* * 7 5 10 => 7 // in the range
* * 2 5 10 => 5 // below the min value
* * 99 5 10 => 10// above the max value
*/
minMax, //
generateToken(length, isUnique, mode: 'alphanumeric' | 'hexadecimal' = 'alphanumeric'): string,
// average between array of values. Eg: [5, 15] => 10
average,
// sum values in an array
sumArray,
// sort an array of urls (useful for expressJs or react router. It avoid generic route home/ to take precedence over a more specific route like home/dshboard1)
sortUrlsByDeepnessInArrayOrObject,
// like nodeJs path.join() but for urls
urlPathJoin,
// miniTemplater(`Hello {{name}}`, { name: 'John' }) => `Hello John`
miniTemplater,
asArray,
compareArrays,
// is number between
isBetween,
simpleObjectMaskOrSelect,
// get the environment variables (Eg. NODE_ENV) with parsed values ("true" => true, "4" => 4). On env variables all values are strings
ENV,
parseBool,
registerConfig,
configFn,
findByAddress,
objForceWrite,
objForceWriteIfNotSet,
strAsArray,
getArrayInCommon,
getArrayDiff,
getNotInArrayA,
noDuplicateFilter,
pushIfNotExist,
isNotEmptyArray,
randomItemInArray,
//allias
arrayUniqueValue,
deepClone,
cloneObject,
JSONstringyParse,
has,
isObject,
mergeDeep,
flattenObject,
unflattenObject,
recursiveGenericFunction,
recursiveGenericFunctionSync,
findByAddressAll,
objFilterUndefined,
readOnly,
reassignForbidden,
readOnlyForAll,
mergeDeepOverrideArrays,
mergeDeepConfigurable,
objFilterUndefinedRecursive,
removeUndefinedKeys, // alias
sortObjKeyAccordingToValue,
ensureObjectProp,
filterKeys,
deleteByAddress,
ensureIsArrayAndPush,
removeCircularJSONstringify,
cleanStackTrace,
shuffleArray,
randomizeArray: shuffleArray,
round2,
camelCase,
snakeCase,
kebabCase,
dashCase: kebabCase,
underscoreCase: snakeCase,
titleCase,
pascalCase,
lowerCase,
upperCase,
capitalize1st,
camelCaseToWords,
nbOccurenceInString,
firstMatch,
allMatches,
getValuesBetweenSeparator,
getValuesBetweenStrings,
escapeRegexp,
validator,
required: validator, // alias for readability
validatorReturnErrArray,
isValid,
isType,
isDateObject,
issetOr,
isEmptyOrNotSet,
errIfNotSet,
err500IfNotSet,
errIfEmptyOrNotSet,
err500IfEmptyOrNotSet,
errXXXIfNotSet,
isEmpty,
checkAllObjectValuesAreEmpty,
checkCtxIntegrity,
// ALIASES
orIsset: issetOr,
// DATE
getDateAsInt12,
humanReadableTimestamp,
getDateAsInt,
getDateAsObject,
isDateIntOrStringValid,
isDateIsoOrObjectValid,
dateStringToArray,
dateArrayFormatted: dateArray,
dateFormatted,
dateSlash: dateFormatted,
dateOffset,
getTimeAsInt,
getIntAsTime,
isTimeStringValid,
// isDateObject <= see validator.js
getDuration,
doDateOverlap,
getDatesForDaysArrayBetweenTwoDates,
getEndTimeFromDurationAndStartTime,
getDate12FromDateAndTime,
getMonthAsInt,
isSunday,
isMonday,
isTuesday,
isWednesday,
isThursday,
isFriday,
isSaturday,
isWeekend,
nextMonday,
nextTuesday,
nextWednesday,
nextThursday,
nextFriday,
nextSaturday,
nextSunday,
addMinutes,
addHours,
addDays,
addMonths,
addYears,
getYear,
getDayOfMonth,
getHours,
getMinutes,
firstDayOfMonth,
lastDayOfMonth,
eachDayOfInterval,
eachMonthOfInterval,
differenceInMilliseconds,
differenceInSeconds,
differenceInMinutes,
differenceInHours,
differenceInDays,
differenceInWeeks,
differenceInMonths,
getClosestExistingDateOfMonth,
getNextMonthlyDate,
getHolidayReferenceYear,
getFirstDayOfHolidayReferenceYear,
getLastDayOfHolidayReferenceYear,
// ALIASES
getDateAsArrayFormatted: dateArray,
getDateAsArray: dateStringToArray,
convertDateAsInt: getDateAsInt,
convertDateAsObject: getDateAsObject,
// LOGGER
C,
cliProgressBar,
cliLoadingSpinner,
outputLogs: logger,
// STRING
convertAccentedCharacters,
// TIMEOUT
executeInDelayedLoop,
timeout,
runAsync,
waitUntilTrue,
// TRANSACTION
transaction,
waitForTransaction,
getId,
mergeMixins,
// MONGO
mongoFilterMerger,
mongoPush,
tryCatch,
}
Please contact me if you need further informations ( issue on github :) )