@zthun/helpful-fn 0.20.0 → 0.21.0

package/dist/types/anchor/anchor.d.ts

@@ -1,12 +1,42 @@
+/**
+ * Represents a vertical anchor.
+ */
 export declare enum ZVerticalAnchor {
+    /**
+     * Top boundary.
+     */
     Top = "top",
+    /**
+     * Centerpoint between the top and bottom.
+     */
     Middle = "middle",
+    /**
+     * Bottom boundary.
+     */
     Bottom = "bottom"
 }
 export declare enum ZHorizontalAnchor {
+    /**
+     * Left boundary.
+     */
     Left = "left",
+    /**
+     * Centerpoint between the left and right boundary.
+     */
     Center = "center",
+    /**
+     * Right boundary.
+     */
     Right = "right"
 }
+/**
+ * Represents an anchor point.
+ *
+ * An anchor point is a point that stays constant while things are
+ * resizing.
+ */
 export type ZAnchor = [ZVerticalAnchor, ZHorizontalAnchor];
+/**
+ * Represents a special type of anchor that excludes the center points.
+ */
 export type ZSideAnchor = ZVerticalAnchor.Top | ZVerticalAnchor.Bottom | ZHorizontalAnchor.Left | ZHorizontalAnchor.Right;

package/dist/types/count-buckets/count-buckets.d.ts

@@ -1 +1,31 @@
+/**
+ * Calculates the total number of buckets you need to
+ * store a number of items where each bucket can hold a
+ * maximum weight of items.
+ *
+ * You can use this function to calculate groupings of
+ * items based on total counts and sizes.  A good example
+ * usage would be to calculate the total number of pages
+ * on a paginated list of items given a page size and item
+ * count.
+ *
+ * @param weight -
+ *        The maximum weight a bucket can store.
+ * @param items -
+ *        The total number of items you need to store where each item
+ *        counts as 1 towards the weight.
+ * @param min -
+ *        The bounded minimum value.  If the total number of buckets
+ *        evaluates to less than this value, then this value is returned.
+ * @param max -
+ *        The bounded maximum value.  If the total number of buckets
+ *        evaluates to more than this value, then this value is returned.
+ *
+ * @returns
+ *        The number of buckets you need to store the total number
+ *        of items given that a single bucket can hold a max weight of items.
+ *        If either weight or items is NaN, then NaN will be returned regardless
+ *        of the opposite value.  Passing a negative number is the same as
+ *        passing 0.
+ */
 export declare function countBuckets(weight: number, items: number, min?: number, max?: number): number;

package/dist/types/create-guid/create-guid.d.ts

@@ -1 +1,7 @@
+/**
+ * Creates a globally unique identifier.
+ *
+ * @returns
+ *        A new generated globally unique identifier.
+ */
 export declare const createGuid: () => string;

package/dist/types/first-defined/first-defined.d.ts

@@ -1 +1,16 @@
+/**
+ * Returns the first value in args such that args is not null or undefined.
+ *
+ * @param fallback -
+ *        The fallback value in the case that all values in args are null/undefined.
+ * @param first -
+ *        The first value to check.
+ * @param remaining -
+ *        The remaining values beyond the first to check.
+ *
+ * @returns
+ *        The first value if it is not null or undefined.  If first is undefined or null, then the first item
+ *        in remaining such that remaining[i] is not null or undefined is returned.  If first and all values of
+ *        remaining are null or undefined, then fallback is returned.
+ */
 export declare function firstDefined<T = any>(fallback: T, first: T | null | undefined, ...remaining: (T | null | undefined)[]): T;

package/dist/types/join-defined/join-defined.d.ts

@@ -1,7 +1,63 @@
 export type JoinListInputParameter<T> = T | [T, boolean] | null | undefined;
+/**
+ * Similar to a string join, but filters out null and undefined items.
+ *
+ * @param delimiter -
+ *        The delimiter that separates the items.
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by delimiter.
+ */
 export declare function joinDefined<T>(delimiter: string, ...items: JoinListInputParameter<T>[]): string;
+/**
+ * Alias to joinList with a string delimiter.
+ *
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by space delimiter.
+ */
 export declare const spaceJoinDefined: <T>(...items: JoinListInputParameter<T>[]) => string;
+/**
+ * Alias of spaceJoinList.
+ *
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by a space delimiter.
+ */
 export declare const cssJoinDefined: <T>(...items: JoinListInputParameter<T>[]) => string;
+/**
+ * Alias of joinList with a comma delimiter.
+ *
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by a comma delimiter.
+ */
 export declare const commaJoinDefined: <T>(...items: JoinListInputParameter<T>[]) => string;
+/**
+ * Alias of joinList with a semi-colon delimiter.
+ *
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by a semi-colon delimiter.
+ */
 export declare const semiColonJoinDefined: <T>(...items: JoinListInputParameter<T>[]) => string;
+/**
+ * Alias of joinList with a pipe delimiter.
+ *
+ * @param items -
+ *        The items to join.
+ *
+ * @returns
+ *        A string that joins the items that are defined, separated by a pipe delimiter.
+ */
 export declare const pipeJoinDefined: <T>(...items: JoinListInputParameter<T>[]) => string;

package/dist/types/orientation/orientation.d.ts

@@ -1,4 +1,19 @@
+/**
+ * Represents a direction orientation.
+ */
 export declare enum ZOrientation {
+    /**
+     * Row orientation.
+     *
+     * This type of orientation is a row
+     * style orientation or flex-row orientation.
+     */
     Horizontal = "horizontal",
+    /**
+     * Vertical orientation.
+     *
+     * This type of orientation is a column
+     * style orientation or block orientation.
+     */
     Vertical = "vertical"
 }

package/dist/types/set-first/set-first.d.ts

@@ -1 +1,14 @@
+/**
+ * Represents a setter function for when you want to set a single value, but you have an array instead.
+ *
+ * This is useful when you want to support lists of items, but you need
+ * backwards compatibility for setting a single item.
+ *
+ * @param setValue -
+ *        The setter function that takes a single value.
+ * @param fallback -
+ *        The fallback value in the case that there are no values.
+ * @param value -
+ *        The value list to retrieve the first item from.
+ */
 export declare function setFirst<T>(setValue: (val: T) => any, fallback: T, value: T[] | null | undefined): void;

package/dist/types/sleep/sleep.d.ts

@@ -1,2 +1,22 @@
+/**
+ * Halts the current thread to invoke an event loop.
+ *
+ * @param ms -
+ *        The total number of milliseconds to sleep.
+ *
+ * @returns
+ *        A promise that resolves after ms milliseconds.
+ */
 export declare function sleep(ms?: number): Promise<void>;
+/**
+ * Halts the current thread to invoke an event loop.
+ *
+ * @param ms -
+ *        The total number of milliseconds to sleep.
+ * @param val -
+ *        The value to resolve with.
+ *
+ * @returns
+ *        A promise that resolves after ms milliseconds.
+ */
 export declare function sleep<T>(ms: number, val: T): Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/helpful-fn",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Helpful, isolated pure functions that are not found in other libraries such as lodash.",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -28,5 +28,5 @@
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "feb47a92ad66ed6865461f9d95677ef096fd20b8"
+  "gitHead": "ee5bff46d3b9574b6b9c3fafd42127356eb95930"
 }