tsu 1.0.2 → 1.1.2

package/package.json

@@ -1,46 +1,47 @@
 {
   "name": "tsu",
-  "version": "1.0.2",
+  "version": "1.1.2",
   "description": "A collection of TypeScript utilities.",
-  "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint",
-    "prepare": "tsdx build",
-    "docs:dev": "vuepress dev docs",
-    "docs:build": "vuepress build docs"
-  },
+  "author": "eb3n",
   "repository": {
     "type": "git",
     "url": "git+https://gitlab.com/eb3n/tsu.git"
   },
-  "main": "dist/index.js",
-  "module": "dist/tsu.esm.js",
-  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "watch": "yarn build -- --watch src",
+    "test": "jest",
+    "prepublishOnly": "yarn test && yarn build",
+    "docs:dev": "vuepress dev docs",
+    "docs:build": "vuepress build docs"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
-  "engines": {
-    "node": ">=10"
-  },
-  "author": "eb3n",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.29.1",
-    "@typescript-eslint/parser": "^4.29.1",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "prettier": "^2.3.2",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.3.0",
-    "typescript": "^4.3.5",
-    "vue": "^3.2.4",
-    "vuepress": "^2.0.0-beta.24"
-  }
+    "@types/jest": "^27.4.1",
+    "@typescript-eslint/eslint-plugin": "^5.14.0",
+    "@typescript-eslint/parser": "^5.14.0",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "ts-jest": "^27.1.3",
+    "tsup": "^5.12.0",
+    "typescript": "^4.6.2",
+    "vuepress": "^2.0.0-beta.41"
+  },
+  "dependencies": {}
 }

package/dist/array.d.ts

@@ -1,96 +0,0 @@
-import type { Arrayable, Nullable } from './types';
-/**
- * Removes the first n items of an array.
- *
- * @param n - The number of items to remove.
- * @param array - The array.
- * @returns The remaining items.
- */
-export declare function drop<T>(n: number, array: readonly T[]): T[];
-/**
- * Returns the first item of an array.
- *
- * @param array - The array.
- * @returns The first item.
- */
-export declare function head<T>(array: readonly T[]): T;
-/**
- * Returns all but the last item of an array.
- *
- * @param array - The array.
- * @returns The array without the last item.
- */
-export declare function init<T>(array: readonly T[]): T[];
-/**
- * Returns the last item of an array.
- *
- * @param array - The array.
- * @returns The last item.
- */
-export declare function last<T>(array: readonly T[]): T;
-/**
- * Returns the maximum number of an array.
- *
- * @param array - The array of numbers.
- * @returns The maximum number.
- */
-export declare function max(array: readonly number[]): number | undefined;
-/**
- * Returns the minimum number of an array.
- *
- * @param array - The array of numbers.
- * @returns The minimum number.
- */
-export declare function min(array: readonly number[]): number | undefined;
-/**
- * Splits an array into two based on a predicate function.
- *
- * @param filter - The predicate function.
- * @param array - The array.
- * @returns The array split in two.
- */
-export declare function partition<T>(filter: (x: T, idx: number, arr: readonly T[]) => boolean, array: readonly T[]): [T[], T[]];
-/**
- * Splits an array into two at a given index.
- *
- * @param i - The position to split at.
- * @param array - The array.
- * @returns The array split in two.
- */
-export declare function splitAt<T>(i: number, array: readonly T[]): [T[], T[]];
-/**
- * Returns the sum of the numbers of an array.
- *
- * @param array - The array of numbers.
- * @returns The sum.
- */
-export declare function sum(array: readonly number[]): number;
-/**
- * Returns all but the first item of an array.
- *
- * @param array - The array.
- * @returns The array without the first item.
- */
-export declare function tail<T>(array: readonly T[]): T[];
-/**
- * Returns the first n items of an array.
- *
- * @param n - The number of items to return.
- * @param array - The array.
- * @returns The first n items.
- */
-export declare function take<T>(n: number, array: readonly T[]): T[];
-/**
- * Wraps a single value of an array, if not already an array.
- *
- * @param maybeArray - The value to wrap, or the existing array.
- * @returns The item wrapped in an array, or the provided array.
- */
-export declare function toArray<T>(maybeArray: Nullable<Arrayable<T>>): T[];
-/**
- * Removes duplicate primitive values from an array.
- *
- * @param array - The array.
- * @returns The array without duplicated primitive values.
- */
-export declare function uniq<T>(array: readonly T[]): T[];

package/dist/function.d.ts

@@ -1,24 +0,0 @@
-import type { Fn, VoidFn } from './types';
-/**
- * Prevents a function from running until it hasn't been called for a certain time period.
- *
- * @param fn - The function.
- * @param delay - The time period (in ms).
- * @returns The debounced function.
- */
-export declare function debounce(fn: Fn, delay: number): VoidFn;
-/**
- * Optimises subsequent calls of a function by caching return values.
- *
- * @param fn - The function.
- * @returns The memoized function.
- */
-export declare function memoize<T>(fn: Fn<T>): Fn<T>;
-/**
- * Prevents a function from running for some time period after it was last called.
- *
- * @param fn - The function.
- * @param limit - The time period.
- * @returns The throttled function.
- */
-export declare function throttle(fn: Fn, limit: number): VoidFn;

package/dist/is.d.ts

@@ -1,63 +0,0 @@
-import type { Fn, Obj } from './types';
-/**
- * Identifies if a value is an array.
- *
- * @param val - The value.
- * @returns If the value is an array.
- */
-export declare function isArray(val: unknown): val is any[];
-/**
- * Identifies if a value is a boolean.
- *
- * @param val - The value.
- * @returns If the value is a boolean.
- */
-export declare function isBoolean(val: unknown): val is boolean;
-/**
- * Identifies if the code is being run in the browser.
- *
- * @returns If the code is being run on a browser.
- */
-export declare function isBrowser(): boolean;
-/**
- * Identifies if a value is defined.
- *
- * @param val - The value.
- * @returns If the value is defined.
- */
-export declare function isDefined<T = unknown>(val?: T): val is T;
-/**
- * Identifies if a value is a function.
- *
- * @param val - The value.
- * @returns If the value is a function.
- */
-export declare function isFunction<T extends Fn>(val: unknown): val is T;
-/**
- * Identifies if a value is a number.
- *
- * @param val - The value.
- * @returns If the value is a number.
- */
-export declare function isNumber(val: unknown): val is number;
-/**
- * Identifies if a value is an object.
- *
- * @param val - The value.
- * @returns If the value is an object.
- */
-export declare function isObject(val: unknown): val is Obj;
-/**
- * Identifies if a value is a string.
- *
- * @param val - The value.
- * @returns If the value is a string.
- */
-export declare function isString(val: unknown): val is string;
-/**
- * Identifies if a value is the global window.
- *
- * @param val - The value.
- * @returns If the value is the global window.
- */
-export declare function isWindow(val: unknown): val is Window;

package/dist/maths.d.ts

@@ -1,37 +0,0 @@
-/**
- * Identifies if a number is even.
- *
- * @param n - The number.
- * @returns If the number is even.
- */
-export declare function isEven(n: number): boolean;
-/**
- * Identifies if a number is odd.
- *
- * @param n - The number.
- * @returns If the number is odd.
- */
-export declare function isOdd(n: number): boolean;
-/**
- * Opinionated implementation of modulo (%).
- *
- * @param n - The dividend.
- * @param m - The divisor.
- * @returns The remainder of dividing n by m.
- */
-export declare function modulo(n: number, m: number): number;
-/**
- * Generates a random integer between bounds.
- *
- * @param max - The exclusive maximum bound.
- * @param min - The inclusive minimum bound.
- * @returns The random integer.
- */
-export declare function randomNumber(max: number, min?: number): number;
-/**
- * Rolls an n-sided die.
- *
- * @param n - The number of sides on the die.
- * @returns If the die roll was 0.
- */
-export declare function randomChance(n: number): boolean;

package/dist/misc.d.ts

@@ -1,13 +0,0 @@
-/**
- * Does nothing.
- *
- * @returns Nothing.
- */
-export declare function noop(): void;
-/**
- * Halts program execution for a specified time.
- *
- * @param duration - The time to wait (in ms).
- * @returns The halting promise.
- */
-export declare function sleep(duration: number): Promise<void>;

package/dist/object.d.ts

@@ -1,10 +0,0 @@
-import type { Obj } from './types';
-declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-/**
- * Recursively merges multiple objects into one.
- *
- * @param objects - The objects to merge.
- * @returns The merged object.
- */
-export declare function deepMerge<T extends Obj<any>[]>(...objects: T): UnionToIntersection<T[number]>;
-export {};

package/dist/scroll.d.ts

@@ -1,17 +0,0 @@
-declare type ScrollConfig = {
-    to: Element | string | number;
-    offset?: number;
-    duration?: number;
-    container?: Element | string | null;
-};
-/**
- * Scrolls the page or provided container to a target element or y-coordinate.
- *
- * @param config - The scroll config.
- * @param config.to - The scroll target.
- * @param config.offset - The offset from the scroll target (in px).
- * @param config.duration - The scroll duration (in ms).
- * @param config.container - The container to scroll in.
- */
-export declare function scroll({ to, offset, duration, container }: ScrollConfig): void;
-export {};

package/dist/string.d.ts

@@ -1,59 +0,0 @@
-/**
- * Capitalises the first letter of one word, or all words, in a string.
- *
- * @param str - The string.
- * @param allWords - If all words should be capitalised.
- * @returns The capitalised string.
- */
-export declare function capitalise(str: string, allWords?: boolean): string;
-/**
- * Separates a string into an array of characters.
- *
- * @param str - The string.
- * @returns The string's characters.
- */
-export declare function chars(str: string): string[];
-/**
- * Identifies strings which only contain whitespace.
- *
- * @param str - The string.
- * @returns If the string is blank.
- */
-export declare function isBlank(str: string): boolean;
-/**
- * Identifies empty strings.
- *
- * @param str - The string.
- * @returns If the string is empty.
- */
-export declare function isEmpty(str: string): boolean;
-/**
- * Converts a kebab case string to camel case.
- *
- * @param str - The kebab case string.
- * @returns The camel case string.
- */
-export declare function toCamel(str: string): string;
-/**
- * Converts a camel case string to kebab case.
- *
- * @param str - The camel case string.
- * @returns The kebab case string.
- */
-export declare function toKebab(str: string): string;
-/**
- * Converts a string which contains a number to the number itself.
- *
- * @param str - The string.
- * @returns The number.
- */
-export declare function toNumber(str: string): number;
-/**
- * Truncates a string to a provided length.
- *
- * @param str - The string.
- * @param length - The length.
- * @param truncateStr - The prefix to apply after truncation.
- * @returns The truncated string.
- */
-export declare function truncate(str: string, length: number, truncateStr?: string): string;