@oscarpalmer/atoms 0.156.0 → 0.158.0

package/types/array/slice.d.ts

@@ -0,0 +1,82 @@
+import type { PlainObject } from '../models';
+/**
+ * Drop items from the start of an array until they match a value
+ * @param array Original array
+ * @param key Key to get an item's value for matching
+ * @param value Value to match against
+ * @returns New array with items dropped
+ */
+export declare function drop<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[];
+/**
+ * Drop items from the start of an array until they match a value
+ * @param array Original array
+ * @param callback Callback to get an item's value for matching
+ * @param value Value to match against
+ * @return New array with items dropped
+ */
+export declare function drop<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): Item[];
+/**
+ * Drop items from the start of an array while they match a filter
+ * @param array Original array
+ * @param callback Filter callback to match items
+ * @return New array with items dropped
+ */
+export declare function drop<Item extends PlainObject>(array: Item[], callback: (item: Item, index: number, array: Item[]) => boolean): Item[];
+/**
+ * Drop a specified number of items, from the start if `>= 0`, or from the end if `< 0`
+ * @param array Original array
+ * @param count Number of items to drop
+ * @returns New array with items dropped
+ */
+export declare function drop(array: unknown[], count: number): unknown[];
+/**
+ * Slice an array, returning a new array with a specified range of items
+ * @param array Original array
+ * @param start Start index _(inclusive)_
+ * @param end End index _(exclusive)_
+ * @return New array with sliced items
+ */
+export declare function slice<Item>(array: Item[], start: number, end: number): Item[];
+/**
+ * Slice an array, returning a new array with a specified number of items
+ * @param array Original array
+ * @param count Maximum sixe of the new array
+ * @return New array with sliced items
+ */
+export declare function slice<Item>(array: Item[], count: number): Item[];
+/**
+ * Slice an array
+ * @param array Array to slice
+ * @returns Sliced array
+ */
+export declare function slice<Item>(array: Item[]): Item[];
+/**
+ * Take items from the start of an array until they match a value
+ * @param array Original array
+ * @param key Key to get an item's value for matching
+ * @param value Value to match against
+ * @returns New array with taken items
+ */
+export declare function take<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[];
+/**
+ * Take items from the start of an array until they match a value
+ * @param array Original array
+ * @param callback Callback to get an item's value for matching
+ * @param value Value to match against
+ * @return New array with taken items
+ */
+export declare function take<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): Item[];
+/**
+ * Take items from the start of an array while they match a filter
+ * @param array Original array
+ * @param callback Filter callback to match items
+ * @return New array with taken items
+ */
+export declare function take<Item extends PlainObject>(array: Item[], callback: (item: Item, index: number, array: Item[]) => boolean): Item[];
+/**
+ * Take a specified number of items, from the start if `>= 0`, or from the end if `< 0`
+ * @param array Original array
+ * @param count Number of items to take
+ * @returns New array with taken items
+ */
+export declare function take(array: unknown[], count: number): unknown[];

package/types/function/index.d.ts

@@ -17,3 +17,4 @@ export declare function debounce<Callback extends GenericCallback>(callback: Cal
 export declare function throttle<Callback extends GenericCallback>(callback: Callback, time?: number): CancelableCallback<Callback>;
 export { noop } from '../internal/function/misc';
 export { memoize, type Memoized, type MemoizedOptions } from './memoize';
+export { once } from './once';

package/types/function/once.d.ts

@@ -0,0 +1,17 @@
+import type { GenericAsyncCallback, GenericCallback, OnceAsyncCallback, OnceCallback } from '../models';
+/**
+ * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls
+ * @param callback Callback to use once
+ * @returns Once callback
+ */
+declare function asyncOnce<Callback extends GenericAsyncCallback>(callback: Callback): OnceAsyncCallback<Callback>;
+/**
+ * Create a function that can only be called once, returning the same value on subsequent calls
+ * @param callback Callback to use once
+ * @returns Once callback
+ */
+export declare function once<Callback extends GenericCallback>(callback: Callback): OnceCallback<Callback>;
+export declare namespace once {
+    var async: typeof asyncOnce;
+}
+export {};

package/types/models.d.ts

@@ -83,6 +83,37 @@ export type NumericalKeys<Value> = {
 export type NumericalValues<Item extends PlainObject> = {
     [Key in keyof Item as Item[Key] extends number ? Key : never]: Item[Key];
 };
+/**
+ * An asynchronous function that can only be called once, returning the same value on subsequent calls
+ */
+export type OnceAsyncCallback<Callback extends GenericAsyncCallback> = {
+    /**
+     * Did the callback's promise reject?
+     */
+    readonly error: boolean;
+    /**
+     * Has the callback finished?
+     */
+    readonly finished: boolean;
+} & Callback & OnceCallbackProperties;
+/**
+ * A callback function that can only be called once, returning the same value on subsequent calls
+ */
+export type OnceCallback<Callback extends GenericCallback> = Callback & OnceCallbackProperties;
+type OnceCallbackProperties = {
+    /**
+     * Has the callback been called?
+     */
+    readonly called: boolean;
+    /**
+     * Has the callback's value been cleared?
+     */
+    readonly cleared: boolean;
+    /**
+     * Clear the callback's cached value
+     */
+    clear: () => void;
+};
 /**
  * A generic object
  */