deverything 1.0.0 → 1.2.0

package/README.md

@@ -81,10 +81,11 @@ Contributions always welcome!
   - `arrayDiff()` get the difference of two arrays
   - `arrayIntersection()` get the intersection of two arrays
 - `capitalize()` word => Word
-- `cleanSpaces()` trims and turns double spaces into single space
 - `clamp()` clamp number in a range
+- `cleanSpaces()` trims and turns double spaces into single space
 - `enumKeys()` enum FRUIT { APPLE, PEAR } => ["APPLE", "PEAR"]
 - `enumValues()` enum FRUIT { APPLE = 1, PEAR = 3 } => [1, 3]
+- `filterAlphanumeric()` remove non-alphanumeric characters
 - `first()` get the first element of an array
 - `firstKey()` get the first key of an object
 - `firstValue()` get the first value of an object
@@ -101,7 +102,6 @@ Contributions always welcome!
 - `normalizeNumber()` normalizes between 0 and 1
 - `objectDiff()` get the difference between two objects
 - ⭐ `parseDate()` pass anything Date-Like, and get a JS Date back
-- `pretty()` stringify anything, without breaking on circular dependencies
 - `promiseWithTimeout()` takes a promise, a timeoutMs, and an option error as arguments. Returns a new Promise that either resolves with the value of the input promise or rejects with the provided error or a default error message if the input promise does not resolve or reject within the specified timeoutMs.
 - `scrambleText()` replace alpha chars with random chars
 - `seriesAll()` executes promises in series, and returns all results
@@ -109,6 +109,7 @@ Contributions always welcome!
 - `setUrlSearchParams()` set URL search params
 - `shuffle()` shuffles elements in an array
 - `sleep()` promise-based sleep
+- `stringify()` stringify anything, without breaking on circular dependencies
 - `toggleArrayValue()` remove/add value in array
 - `truncate()` truncate text, does not break emojis
 - `uniqueValues()` gets unique values in an array
@@ -116,6 +117,7 @@ Contributions always welcome!
 ### Formatters
 
 - `formatCamelCase()`
+- `formatCookies()` { cookie1: "1", cookie2: "2" } => "cookie1=1; cookie2=2"
 - `formatNumber()` 1000 => "1,000" or "1K" or 0.112 => "11.2%"
 - `formatPercentage()` 0.11 => "11%"
 - `formatProgress()` => "[2/10]"
@@ -128,6 +130,7 @@ These functions are optimized for low entropy random data generation useful for
 
 - `randomAddress()`
 - `randomAlphaNumericCode()`
+- `randomArray()`
 - ⭐ `randomArrayItem()` now supporting non-uniform distribution
 - `randomBankAccount()`
 - `randomBool()`
@@ -154,31 +157,28 @@ These functions are optimized for low entropy random data generation useful for
 - `randomHtmlColorName()`
 - `randomIBAN()`
 - `randomInt()`
-  - `randomPositiveInt()` > 0
-  - `randomNegativeInt()` < 0
-  - `randomMaxSafeInt()` Range of very BIG integers, which are still safe to use tho
+  - `randomBigInt()`
   - `randomMaxInt()` Range within the Maximum integer supported by js
+  - `randomMaxSafeInt()` Range of very BIG integers, which are still safe to use tho
+  - `randomNegativeInt()` < 0
+  - `randomPositiveInt()` > 0
 - `randomIP()`
 - `randomName()`
   - `randomFirstName()`
   - `randomLastName()`
   - `randomFullName()`
 - `randomNumericCode()`
+- `randomObject()`
 - `randomParagraph()`
 - `randomPassword()`
 - `randomPath()` /path/to/something
 - `randomPhoneNumber()`
 - `randomString()`
+- `randomSymbol()`
 - `randomUUID()` lightweight uuid generation, passing UUID validation
 - `randomValue()`
 - `randomWord()`
 
-### Checks
-
-Checks are functions that throw an error, if the validation fails
-
-- ⭐ `checkEnvVars()` Make sure env vars are set per-environment
-
 ### TypeScript Helpers & Generics
 
 - `Coords`

package/dist/index.d.ts

@@ -5,7 +5,18 @@ type Coords = {
 
 type DateLike = Date | string | number;
 type Datey = Date | string;
+/**
+ * @example "2021-01-01T00:00:00.000Z"
+ */
 type ISODate = string;
+/**
+ * @example "2021-01-01"
+ */
+type ISODay = string;
+/**
+ * @example "America/New_York"
+ */
+type Timezone = string;
 type DateRange = {
     startDate: DateLike;
     endDate: DateLike;
@@ -80,6 +91,13 @@ declare const startOfTomorrow: () => Date;
 
 declare const formatCamelCase: (str: string) => string;
 
+/**
+ *
+ * @example formatCookies({}) => ""
+ * @example formatCookies({ session: "123", _ga: 123 }) => "session=123; _ga=123"
+ */
+declare const formatCookies: (object: PlainObject) => string;
+
 /**
  *
  * @example formatNumber(1000, { compact: true }) // 1K
@@ -154,12 +172,20 @@ declare const cyclicalItem: <T>(array: T[], index: number) => T;
 /**
  * Print or log helper that does not break on circular references, and expands nested objects.
  */
-declare const dir: (arg: any, depth?: number) => void;
+declare const dir: (arg: any, { maxDepth }?: {
+    maxDepth?: number | undefined;
+}) => void;
 
 declare const enumKeys: <T extends object>(arg: T) => ObjectKeys<T>;
 
 declare const enumValues: <T extends object>(enumObject: T) => ObjectValues<T>;
 
+/**
+ * @returns a string with only alphanumeric characters
+ * @example filterAlphanumeric("!abc()") // returns "abc"
+ */
+declare const filterAlphanumeric: (string: string) => string;
+
 declare const first: <T>(arr?: T[] | undefined) => T | undefined;
 
 declare const firstKey: <T extends PlainObject<any>>(arg: T) => keyof T;
@@ -224,8 +250,6 @@ declare const pickObjectKeys: <T extends PlainObject<any>>(obj: T, keys: ObjectK
 
 declare const pickObjectValues: <T extends PlainObject<any>>(obj: T, values: ObjectValues<T>) => Partial<T>;
 
-declare const pretty: (arg?: any) => string;
-
 declare const promiseWithTimeout: <T>(promise: () => Promise<T>, timeoutMs: number, error?: Error) => Promise<T>;
 
 declare const scrambleText: (str: string) => string;
@@ -244,12 +268,13 @@ declare const serialize: <T extends PlainObject<any>>(obj: T) => string;
  * @description Run a series of (async) functions in order and return the results
  * @example
  * const results = await seriesAll([
- *  () => Promise.resolve(1),
- *  () => sleep(100).then(() => 2),
+ *  Promise.resolve(1),
+ *  sleep(100).then(() => 2),
  *  () => Promise.resolve(3),
- * ]); => [1, 2, 3]
+ *  async () => 4,
+ * ]); => [1, 2, 3, 4]
  */
-declare const seriesAll: <T>(series: Function[]) => Promise<T[]>;
+declare const seriesAll: <T>(series: (Promise<T> | (() => Promise<T>))[]) => Promise<T[]>;
 
 /**
  * Sets a value in an object using a dot-separated path.
@@ -266,6 +291,8 @@ declare const shuffle: <T>(array: T[]) => T[];
 
 declare const sleep: (timeMs: number) => Promise<void>;
 
+declare const stringify: (arg?: any) => string;
+
 declare const toggleArrayValue: <T>(array: T[], value: T) => T[];
 /**
  * @deprecated Use toggleArrayValue instead
@@ -354,6 +381,8 @@ declare const randomAlphaNumericCode: ({ length, }?: {
     length?: number | undefined;
 }) => string;
 
+declare const randomArray: () => (string | number | boolean | symbol | Date | BigInt | null | undefined)[];
+
 declare const randomArrayItem: <T>(array: T[], { weights }?: {
     weights?: number[] | undefined;
 }) => T;
@@ -442,6 +471,7 @@ declare const randomInt: ({ min, max, }?: {
     min?: number | undefined;
     max?: number | undefined;
 }) => number;
+declare const randomBigInt: () => BigInt;
 declare const randomPositiveInt: ({ min, max, }?: {
     min?: number | undefined;
     max?: number | undefined;
@@ -475,10 +505,10 @@ declare const randomNumericCode: ({ length }?: {
     length?: number | undefined;
 }) => string;
 
-/**
- * @deprecated use incrementalId() instead, as this one is not random and could cause confusion
- */
-declare const randomNumericId: () => number;
+declare const randomObject: ({ maxDepth, circular, }?: {
+    maxDepth?: number | undefined;
+    circular?: boolean | undefined;
+}) => PlainObject<any>;
 
 /**
  * Generates a random paragraph of text.
@@ -507,6 +537,8 @@ declare const randomString: ({ length, }?: {
     length?: number | undefined;
 }) => string;
 
+declare const randomSymbol: () => symbol;
+
 /**
  * This is a light-weight version of the `generateUuid` function
  * To be used only for test purposed and NOT for production
@@ -516,6 +548,8 @@ declare const randomString: ({ length, }?: {
  */
 declare const randomUUID: () => string;
 
+declare const randomValue: () => string | number | boolean | symbol | Date | BigInt | null | undefined;
+
 declare const randomWord: () => string;
 declare const randomNoun: () => string;
 declare const randomVerb: () => string;
@@ -543,6 +577,9 @@ declare const isEmptyObject: (arg: PlainObject) => boolean;
 
 declare const isFile: (arg?: any) => arg is File;
 
+/**
+ * @returns true if the argument can be called like a function -> fn() or await fn()
+ */
 declare const isFunction: (arg: any) => arg is Function;
 
 declare const isFutureDate: (arg: DateLike) => boolean;
@@ -609,4 +646,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: (arg?: Maybe<any>) => boolean;
 
-export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, ISODate, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, TrueMap, WithDatey, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, first, firstKey, firstValue, formatCamelCase, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, incrementalId, isArray, isArrayIncluded, isBetween, isBoolean, isBrowser, isBuffer, isClient, isEmail, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isEven, isFile, isFunction, isFutureDate, isInt, isJsDate, isKey, isLastIndex, isNegative, isNegativeInt, isNotEmptyString, isNumber, isNumeric, isNumericId, isObject, isOdd, isOutside, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, normaliseArray, normaliseNumber, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pretty, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArrayItem, randomBankAccount, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEnumKey, randomEnumValue, randomFile, randomFirstName, randomFloat, randomFormattedPercentage, randomFullName, randomFutureDate, randomHandle, randomHexColor, randomHexValue, randomHtmlColorName, randomIBAN, randomIP, randomInt, randomLastName, randomLat, randomLng, randomMaxDate, randomMaxInt, randomMaxSafeInt, randomName, randomNegativeInt, randomNoun, randomNumericCode, randomNumericId, randomParagraph, randomPassword, randomPastDate, randomPath, randomPhoneNumber, randomPositiveInt, randomString, randomUUID, randomVerb, randomWord, scrambleText, serialize, seriesAll, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };
+export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, ISODate, ISODay, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, WithDatey, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, incrementalId, isArray, isArrayIncluded, isBetween, isBoolean, isBrowser, isBuffer, isClient, isEmail, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isEven, isFile, isFunction, isFutureDate, isInt, isJsDate, isKey, isLastIndex, isNegative, isNegativeInt, isNotEmptyString, isNumber, isNumeric, isNumericId, isObject, isOdd, isOutside, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, normaliseArray, normaliseNumber, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArray, randomArrayItem, randomBankAccount, randomBigInt, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEnumKey, randomEnumValue, randomFile, randomFirstName, randomFloat, randomFormattedPercentage, randomFullName, randomFutureDate, randomHandle, randomHexColor, randomHexValue, randomHtmlColorName, randomIBAN, randomIP, randomInt, randomLastName, randomLat, randomLng, randomMaxDate, randomMaxInt, randomMaxSafeInt, randomName, randomNegativeInt, randomNoun, randomNumericCode, randomObject, randomParagraph, randomPassword, randomPastDate, randomPath, randomPhoneNumber, randomPositiveInt, randomString, randomSymbol, randomUUID, randomValue, randomVerb, randomWord, scrambleText, serialize, seriesAll, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, stringToCSSUnicode, stringToUnicode, stringify, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };