deverything 2.1.2 → 3.0.0

package/README.md

@@ -92,10 +92,12 @@ Contributions always welcome!
 - `firstValue()` get the first value of an object
 - `getUrlSearchParam()` get URL search param
 - `getUrlSearchParams()` get URL search params
+- `groupByKey()`
 - `incrementalId()` autoincremental SQL-like, process-unique numeric id
 - `keysLength()` get the length of keys in an object
 - `last()` get the last element of an array
 - `lastIndex()` get the last index of an array
+- `mapByKey()`
 - ⭐ `merge()` deep merge objects
 - `moveToFirst()` move array element to first
 - `moveToIndex()` move array element to desired index
@@ -103,6 +105,7 @@ 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
+- `pluck()` make array of value from object keys
 - `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
 - `seriesAsync()` executes promises in series, and returns all results

package/dist/index.d.ts

@@ -211,10 +211,17 @@ declare const stringToUnicode: (text: string) => string;
 declare const array: <U extends (...args: any) => any>(length: number, mapFn?: U) => ReturnType<U>[];
 
 /**
- * Given 2 arrays, returns the elements that belong to each but not both at the same time.
+ * Given 2 arrays, returns the (unique) elements that belong to each but not both at the same time.
+ * @example
+ * arrayDiff([1, 2, 3], [2, 3, 4]); // [1, 4]
  */
 declare const arrayDiff: (arr1: any[], arr2: any[]) => any[];
 
+/**
+ * @description Given 2 arrays, returns the (unique) elements that belong to both arrays.
+ * @example
+ * arrayIntersection([1, 2, 3], [2, 3, 4]); // [2, 3]
+ */
 declare const arrayIntersection: <T>(arr1: T[], arr2: T[]) => T[];
 
 declare const capitalize: (string: string) => string;
@@ -296,12 +303,10 @@ declare const firstValue: <T extends PlainObject<any>>(arg: T) => ObjectValue<T>
  */
 declare const getCookieByName: (name: string) => string | undefined;
 
-/**
- * TODO: rename to allKeys
- * @deprecated use Object.keys instead unless you need to include symbols, but the function will be renamed to allKeys
- */
-declare const getKeys: <T extends PlainObject<any>>(obj: T) => (string | symbol)[];
-declare const getEnumerableOwnPropertySymbols: (obj: object) => symbol[];
+declare const getKeys: {
+    (o: object): string[];
+    (o: {}): string[];
+};
 
 declare const getUrlSearchParam: (urlString: Maybe<string>, param: string) => string | undefined;
 
@@ -320,7 +325,7 @@ declare const getUrlSearchParams: (urlString: Maybe<string>) => Record<string, s
  *   { externalId: 2, value: 100 },
  *   { mis_spelled_externalId: 2, value: 90 }, // not included in any group
  * ];
- * const ordersByInstrument = groupBy(items, "externalId");
+ * const ordersByInstrument = groupByKey(items, "externalId");
  * // {
  * //   1: [
  * //     { externalId: 1, value: 100 },
@@ -332,7 +337,7 @@ declare const getUrlSearchParams: (urlString: Maybe<string>) => Record<string, s
  * //   ],
  * // }
  */
-declare const groupBy: <T>(items: T[], key: keyof T) => Record<keyof T, T[]>;
+declare const groupByKey: <T, K extends keyof T>(items: T[], key: K) => Record<keyof T, T[]>;
 
 declare const incrementalId: () => number;
 
@@ -342,6 +347,19 @@ declare const last: <T>(arr: T[]) => T;
 
 declare const lastIndex: (array: any[]) => number;
 
+/**
+ *
+ * @description Given an array of objects, returns a record where the key is the value of the object's key
+ * NOTE: if two objects have the same key, the last one will be the one kept.
+ * Useful for quick lookups by key.
+ * @example
+ * const items = [{ id: 1, name: "Alice" }, { id: 2, name: "Bob" }];
+ * const itemsById = mapByKey(items, "id");
+ * itemsById[1]; // { id: 1, name: "Alice" }
+ * itemsById[2]; // { id: 2, name: "Bob" }
+ */
+declare const mapByKey: <T extends PlainObject<any>>(items: T[], key: keyof T) => Record<keyof T, T>;
+
 /**
  * @description Simple merge function that merges two objects, arrays get overwritten, no options
  *
@@ -378,10 +396,26 @@ declare const parseDate: (arg?: Maybe<DateLike>, options?: {
     asUTC?: boolean;
 }) => Date | undefined;
 
+/**
+ *
+ * @description Given an object, returns a new object with only the keys that are in the `keys` array.
+ * @example
+ * const obj = { a: 1, b: 2, c: 3 };
+ * pickObjectKeys(obj, ["a", "c"]); // { a: 1, c: 3 }
+ */
 declare const pickObjectKeys: <T extends PlainObject<any>>(obj: T, keys: ObjectKeys<T>) => Partial<T>;
 
+/**
+ *
+ * @description Given an object, returns a new object with only the keys that have the values in the `values` array.
+ * @example
+ * const obj = { a: 1, b: 2, c: 3 };
+ * pickObjectValues(obj, [1, 3]); // { a: 1, c: 3 }
+ */
 declare const pickObjectValues: <T extends PlainObject<any>>(obj: T, values: ObjectValues<T>) => Partial<T>;
 
+declare const pluck: <T extends PlainObject<any>>(items: T[], key: keyof T) => Exclude<T[keyof T], null | undefined>[];
+
 declare const promiseWithTimeout: <T>(promise: () => Promise<T>, timeoutMs: number, error?: Error) => Promise<T>;
 
 declare const removeUndefinedValues: (obj: PlainObject) => {
@@ -399,8 +433,9 @@ declare const scrambleText: (str: string) => string;
  */
 declare const serialize: <T extends PlainObject<any>>(obj: T) => string;
 
-type SeriesResult<T extends readonly unknown[]> = {
-    [K in keyof T]: T[K] extends () => infer U ? Awaited<U> : never;
+type AsyncFunction<T = any> = () => Promise<T>;
+type SeriesResult<T extends readonly AsyncFunction[]> = {
+    [K in keyof T]: T[K] extends AsyncFunction<infer U> ? Awaited<U> : never;
 };
 /**
  *
@@ -413,7 +448,7 @@ type SeriesResult<T extends readonly unknown[]> = {
  *  async () => 4,
  * ]); => [1, 2, 3, 4]
  */
-declare const seriesAsync: <T extends readonly unknown[]>(series: readonly [...T]) => Promise<SeriesResult<T>>;
+declare const seriesAsync: <T extends readonly AsyncFunction<any>[]>(series: readonly [...T]) => Promise<SeriesResult<T>>;
 
 /**
  * Sets a value in an object using a dot-separated path.
@@ -802,4 +837,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: <T>(arg?: Maybe<T>) => arg is T;
 
-export { BoolMap, Coords, DateLike, DateRange, Datey, Defined, Dimensions, HashMap, ISODate, ISODay, ISOMonth, ISOYear, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PickDefined, PickRequired, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, VoidFn, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, chunkedDynamic, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, formatIndexProgress, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getDateSeries, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, groupBy, incrementalId, isArray, isArrayIncluded, isBetween, isBigInt, isBigIntString, 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, isOutsideInt4, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isSequence, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, noop, 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, randomEmptyValue, 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, removeUndefinedValues, scrambleText, serialize, seriesAsync, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, startOfUTCDay, stringToCSSUnicode, stringToUnicode, stringify, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };
+export { BoolMap, Coords, DateLike, DateRange, Datey, Defined, Dimensions, HashMap, ISODate, ISODay, ISOMonth, ISOYear, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PickDefined, PickRequired, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, VoidFn, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, chunkedDynamic, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, formatIndexProgress, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getDateSeries, getKeys, getUrlSearchParam, getUrlSearchParams, groupByKey, incrementalId, isArray, isArrayIncluded, isBetween, isBigInt, isBigIntString, 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, isOutsideInt4, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isSequence, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, mapByKey, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, noop, normaliseArray, normaliseNumber, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pluck, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArray, randomArrayItem, randomBankAccount, randomBigInt, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEmptyValue, 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, removeUndefinedValues, scrambleText, serialize, seriesAsync, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, startOfUTCDay, stringToCSSUnicode, stringToUnicode, stringify, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };