npm - tsu - Versions diffs - 0.1.0 - Mend

tsu 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright © 2021-Present HappyTiptoe
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,58 @@
+<div align="center">
+  <a href="https://gitlab.com/happytiptoe/tsu">
+    <img src="https://gitlab.com/happytiptoe/tsu/-/raw/main/assets/logo.png" alt="tsu - opinionated project scaffolder" width="251">
+  <br>
+  </a>
+  <h1>tsu</h1>
+  <h3>✨ TypeScript Utilities ✨</h3>
+</div>
+<div align="center">
+<a href="https://www.npmjs.com/package/tsu" target="__blank">
+  <img src="https://img.shields.io/npm/v/tsu?color=3eaa47&label=" alt="NPM version">
+</a>
+<a href="https://tsu.pages.dev" target="__blank">
+  <img src="https://img.shields.io/static/v1?label=&message=View%20documentation&color=3eaa47" alt="view documentation">
+</a>
+<br>
+<a href="https://gitlab.com/happytiptoe/tsu" target="__blank">
+  <img src="https://img.shields.io/gitlab/stars/happytiptoe/tsu?style=flat&color=131514" alt="gitlab stars">
+</a>
+<a href="https://npmjs.com/package/tsu">
+  <img src="https://img.shields.io/npm/l/tsu?color=131514" alt="license">
+</a>
+</div>
+## Installation
+Install with your favourite package manager:
+```sh
+# yarn
+yarn add tsu
+# pnpm
+pnpm add tsu
+# npm
+npm install tsu
+```
+Import as required:
+```js
+import { ... } from 'tsu'
+```
+## Documentation
+Full documentation is available [here](https://tsu.pages.dev/).
+## Credits
+- [antfu](https://github.com/antfu) - For the inspiration to make a utils library.
+- [yuanqing](https://github.com/yuanqing) - For the package name.
+## License
+[MIT](http://opensource.org/licenses/MIT)

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";var d=Object.defineProperty;var U=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var L=Object.prototype.hasOwnProperty;var B=(e,r)=>{for(var n in r)d(e,n,{get:r[n],enumerable:!0})},D=(e,r,n,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of R(r))!L.call(e,t)&&t!==n&&d(e,t,{get:()=>r[t],enumerable:!(o=U(r,t))||o.enumerable});return e};var q=e=>D(d({},"__esModule",{value:!0}),e);var _e={};B(_e,{average:()=>G,capitalise:()=>A,capitalize:()=>Le,ceil:()=>ee,chars:()=>Be,clamp:()=>c,clone:()=>a,copyToClipboard:()=>ve,debounce:()=>Oe,drop:()=>H,es:()=>ce,floor:()=>re,groups:()=>I,head:()=>P,init:()=>W,isArray:()=>m,isBlank:()=>De,isBoolean:()=>z,isBrowser:()=>l,isDefined:()=>_,isEmpty:()=>qe,isEmptyArray:()=>V,isEmptyObject:()=>J,isEven:()=>ne,isFunction:()=>g,isNull:()=>s,isNumber:()=>y,isObject:()=>T,isObjectLike:()=>p,isOdd:()=>oe,isString:()=>b,isTouchDevice:()=>Y,isUndefined:()=>Z,isWindow:()=>f,ks:()=>ae,last:()=>$,max:()=>te,memoise:()=>C,memoize:()=>Ae,min:()=>ie,noop:()=>Se,omit:()=>pe,once:()=>Ne,partition:()=>K,product:()=>ue,randomChance:()=>fe,randomNumber:()=>u,range:()=>X,remove:()=>Q,repeat:()=>Me,replaceChar:()=>He,round:()=>me,scroll:()=>Ce,shuffle:()=>be,sleep:()=>Ue,splitArray:()=>de,splitString:()=>Ie,sum:()=>h,tail:()=>Te,take:()=>ge,throttle:()=>Fe,toArray:()=>ye,toCamel:()=>Pe,toDp:()=>le,toKebab:()=>We,toNumber:()=>se,toOrdinal:()=>$e,toRomanNumerals:()=>Ke,truncate:()=>Xe,unchars:()=>ze,uniq:()=>he,uuid:()=>Re,vs:()=>xe});module.exports=q(_e);function H(e,r){return r<=0?[...e]:e.slice(r)}function I(e,r){if(r<=0)throw new Error("[tsu] Invalid group size. Is it greater than 0?");if(r>=e.length)return[[...e]];let n=[];for(let o=0;o<e.length;o+=r)n.push(e.slice(o,o+r));return n}function P(e){return e[0]}function W(e){return e.slice(0,e.length-1)}function $(e){return e[e.length-1]}function K(e,r){let n=[],o=[];for(let t=0;t<e.length;t++){let i=e[t];r(i,t,e)?n.push(i):o.push(i)}return[n,o]}function X(...e){let r,n,o;e.length===1?(n=e[0],r=0,o=1):(r=e[0],n=e[1],o=e[2]||1),o<=0&&(console.warn("[tsu] warning: a step less than or equal to 0 will be set to 1."),o=1);let t=[],i=r;for(;i<n;)t.push(i),i+=o||1;return t}function m(e){return Array.isArray(e)}function z(e){return typeof e=="boolean"}function l(){return typeof window<"u"}function _(e){return typeof e<"u"}function V(e){return m(e)&&e.length===0}function J(e){if(!T(e))return!1;for(let r in e)return!1;return!0}function g(e){return typeof e=="function"}function s(e){return Object.prototype.toString.call(e)==="[object Null]"}function y(e){return typeof e=="number"}function T(e){return Object.prototype.toString.call(e)==="[object Object]"}function p(e){return typeof e=="object"}function b(e){return typeof e=="string"}function Y(){return"ontouchstart"in window||navigator.maxTouchPoints>0}function Z(e){return typeof e>"u"}function f(e){return l()&&Object.prototype.toString.call(e)==="[object Window]"}function Q(e,r){let n=g(r)?r:t=>t===r,o=e.findIndex(n);return o!==-1?[...e.slice(0,o),...e.slice(o+1)]:e}function G(e){return e.length<1?0:h(e)/e.length}function ee(e,r=1){let n=e/r;return Math.ceil(n)*r}function c(e,r,n){return Math.min(n,Math.max(r,e))}function re(e,r=1){let n=e/r;return Math.floor(n)*r}function ne(e){return e%2===0}function oe(e){return e%2!==0}function te(...e){let r;return e.length===1&&Array.isArray(e[0])?r=e[0]:r=e,Math.max(...r)}function ie(...e){let r;return e.length===1&&Array.isArray(e[0])?r=e[0]:r=e,Math.min(...r)}function ue(e){if(e.length<1)return 0;let r=1;for(let n=0;n<e.length;n++)r*=e[n];return r}function u(...e){let r,n;return e.length===1?(r=0,n=e[0]):(r=e[0],n=e[1]),Math.floor(Math.random()*(n-r))+r}function fe(e){return u(e)===0}function me(e,r=1){let n=e/r;return Math.round(n)*r}function h(e){let r=0;for(let n=0;n<e.length;n++)r+=e[n];return r}function le(e,r=0){r<0&&console.warn("[tsu] warning: decimalPlaces less than 0 are set to 0."),r>100&&console.warn("[tsu] warning: decimalPlaces greater than 100 are set to 100.");let n=c(r,0,100);return Number(e.toFixed(n))}function se(e,r=[]){if(!e.length)return NaN;let n=["#","\xA3","\u20AC","$","%",",",...r],o=new RegExp(`[${n.join("")}]`,"g");return Number(e.replace(o,""))}function a(e){if(m(e)){let r=[];for(let n=0;n<e.length;n++)p(e[n])&&!s(e[n])?r[n]=a(e[n]):r[n]=e[n];return r}if(p(e)&&!s(e)){let r={};for(let n in e)p(e[n])&&!s(e[n])?r[n]=a(e[n]):r[n]=e[n];return r}return e}function pe(e,r){let n={...e};for(let o of r)delete n[o];return n}function ce(e){return Object.entries(e)}function ae(e){return Object.keys(e)}function xe(e){return Object.values(e)}function be(e){let r=a(e),n,o,t;for(n=r.length;n;n-=1)o=u(n),t=r[n-1],r[n-1]=r[o],r[o]=t;return r}function de(e,r){return r<=0?[[],[...e]]:r>e.length?[[...e],[]]:[e.slice(0,r),e.slice(r)]}function Te(e){return e.slice(1)}function ge(e,r){return r<=0?[]:e.slice(0,r)}function ye(e){return e?Array.isArray(e)?e:[e]:[]}function he(e){return Array.from(new Set(e))}function we(e){let r=document.createElement("textarea");r.value=e??"",r.style.position="absolute",r.style.opacity="0",document.body.appendChild(r),r.select(),document.execCommand("copy"),r.remove()}function ve(e){l()&&(window.navigator&&"clipboard"in window.navigator?navigator.clipboard.writeText(e):we(e))}function je(e){return e<.5?4*Math.pow(e,3):(e-1)*(2*e-2)*(2*e-2)+1}function ke(e,r,n,o){return e+(r-e)*je(n/o)}function Ee(e,r,n){let o;return y(e)?o=e:f(n)?o=e.getBoundingClientRect().top+r:o=e.getBoundingClientRect().top+r-n.getBoundingClientRect().top,o}function Ce({to:e,offset:r=0,duration:n=1e3,container:o=null}){let t=b(e)?document.querySelector(e):e,i=b(o)?document.querySelector(o):o||window,x=f(i)?window.pageYOffset||document.documentElement.scrollTop:i.scrollTop||0,M=f(i)?document.documentElement.scrollHeight-window.innerHeight:i.scrollHeight-i.clientHeight,F=Ee(t,x,i)+r,w=c(F,0,M),S=Date.now();function v(){let j=Date.now()-S,k=j<n,E=k?ke(x,w,j,n):w;k&&requestAnimationFrame(v),f(i)?window.scrollTo(0,E):i instanceof HTMLElement&&(i.scrollTop=E)}v()}function Oe(e,r){r<0&&console.warn("[tsu] warning: debounce delays less than 0 will be set to 0.");let n;return function(...o){clearTimeout(n),n=setTimeout(()=>{clearTimeout(n),e(...o)},r)}}function C(e){let r={};return function(...n){let o=JSON.stringify(n);if(o in r)return r[o];let t=e(...n);return r[o]=t,t}}var Ae=C;function Ne(e){let r=!1;return(...n)=>{r||(e(...n),r=!0)}}function Me(e,r){if(!(r<=0))for(let n=0;n<r;n++)e(n)}function Fe(e,r){r<0&&console.warn("[tsu] warning: throttle limits less than 0 will be set to 0.");let n=!1;return function(...o){n||(e(...o),n=!0,setTimeout(()=>{n=!1},r))}}function Se(){}async function Ue(e){return e<0&&console.warn("[tsu] warning: sleep durations less than 0 are set to 0."),new Promise(r=>{setTimeout(r,e)})}var O="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function Re(e=16){let r=O.length,n=e,o="";for(;n--;)o+=O[u(r)];return o}function A(e,r=!1,n=" "){return r?e.split(n).map(o=>o.charAt(0).toUpperCase()+o.slice(1)).join(n):e.charAt(0).toUpperCase()+e.slice(1)}var Le=A;function Be(e){return e.split("")}function De(e){return e.trim().length===0}function qe(e){return e.length===0}function He(e,r,n){return r<0||r>e.length-1?e:e.slice(0,r)+n+e.slice(r+1)}function Ie(e,r){return r<=0?["",e]:r>e.length?[e,""]:[e.slice(0,r),e.slice(r)]}function Pe(e){let r=/-(\w)/g;return e.replace(r,(n,o)=>o?o.toUpperCase():"")}function We(e){let r=/\B([A-Z])/g;return e.replace(r,"-$1").toLowerCase()}function $e(e){let n=["st","nd","rd"][(Math.abs(e)/10%10^1&&Math.abs(e)%10)-1]||"th";return`${e}${n}`}var N={1:"I",4:"IV",5:"V",9:"IX",10:"X",40:"XL",50:"L",90:"XC",100:"C",400:"CD",500:"D",900:"CM",1e3:"M"};function Ke(e,r=!1){let n=e,o="",t=Object.keys(N).map(Number).sort((i,x)=>x-i);for(let i of t)for(;n>=i;)o+=N[i],n-=i;return r?o.toLowerCase():o}function Xe(e,r,n="..."){return r<=0?n:e.slice(0,r)+n}function ze(e){return e.join("")}0&&(module.exports={average,capitalise,capitalize,ceil,chars,clamp,clone,copyToClipboard,debounce,drop,es,floor,groups,head,init,isArray,isBlank,isBoolean,isBrowser,isDefined,isEmpty,isEmptyArray,isEmptyObject,isEven,isFunction,isNull,isNumber,isObject,isObjectLike,isOdd,isString,isTouchDevice,isUndefined,isWindow,ks,last,max,memoise,memoize,min,noop,omit,once,partition,product,randomChance,randomNumber,range,remove,repeat,replaceChar,round,scroll,shuffle,sleep,splitArray,splitString,sum,tail,take,throttle,toArray,toCamel,toDp,toKebab,toNumber,toOrdinal,toRomanNumerals,truncate,unchars,uniq,uuid,vs});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,613 @@
+/**
+ * Removes the first `n` items of an array.
+ *
+ * @param array - The array.
+ * @param n - The number of items to remove.
+ * @returns The remaining items.
+ */
+declare function drop<T>(array: readonly T[], n: number): T[];
+/**
+ * Splits an array into groups of equal size.
+ *
+ * @param array - The array.
+ * @param n - The size of each group.
+ * @returns The array split into groups.
+ */
+declare function groups<T>(array: readonly T[], n: number): T[][];
+/**
+ * Returns the first item of an array.
+ *
+ * @param array - The array.
+ * @returns The first item.
+ */
+declare function head(array: readonly []): undefined;
+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.
+ */
+declare function init<T>(array: readonly T[]): T[];
+/**
+ * Returns the last item of an array.
+ *
+ * @param array - The array.
+ * @returns The last item.
+ */
+declare function last(array: readonly []): undefined;
+declare function last<T>(array: readonly T[]): T;
+/**
+ * Splits an array into two based on a predicate function.
+ *
+ * @param array - The array.
+ * @param filter - The predicate function.
+ * @returns The tuple of values that satisfy the predicate and those that don't.
+ */
+declare function partition<T, U = T>(array: readonly (T | U)[], filter: (current: T | U, idx: number, array: readonly (T | U)[]) => boolean): [T[], U[]];
+/**
+ * Generates a range of numbers.
+ *
+ * @param start - The inclusive start value.
+ * @param stop - The exlusive stop value.
+ * @param step - The step to increment by.
+ * @returns The range of numbers.
+ */
+declare function range(stop: number): number[];
+declare function range(start: number, stop: number, step?: number): number[];
+/**
+ * Removes an item from an array.
+ *
+ * @param array - The array.
+ * @param item - The item, or getter function for the item, to remove.
+ * @returns The array with the item removed, if found.
+ */
+declare function remove<T>(array: T[], itemOrGetter: T | ((item: T) => boolean)): T[];
+/**
+ * Randomly shuffles items in an array.
+ *
+ * @param array - The array.
+ * @returns A copy of the array with its items randomly shuffled.
+ */
+declare function shuffle<T>(array: T[]): T[];
+/**
+ * Splits an array into two at a specified index.
+ *
+ * @param array - The array.
+ * @param i - The position to split at.
+ * @returns The tuple of values before and after the split.
+ */
+declare function splitArray<T>(array: readonly T[], i: number): [T[], T[]];
+/**
+ * Returns all but the first item of an array.
+ *
+ * @param array - The array.
+ * @returns The array without the first item.
+ */
+declare function tail<T>(array: readonly T[]): T[];
+/**
+ * Returns the first `n` items of an array.
+ *
+ * @param array - The array.
+ * @param n - The number of items to return.
+ * @returns The first `n` items.
+ */
+declare function take<T>(array: readonly T[], n: number): T[];
+type Arrayable<T> = T | Array<T>;
+type Nullable<T> = T | null | undefined;
+type Fn<T = any> = (...args: any[]) => T;
+type VoidFn = Fn<void>;
+type Obj<V = unknown> = Record<string | symbol | number, V>;
+/**
+ * Wraps a single value in 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.
+ */
+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.
+ */
+declare function uniq<T>(array: readonly T[]): T[];
+/**
+ * Copies the provided string to the user's clipboard.
+ *
+ * @param str - The string to be copied to the clipboard.
+ */
+declare function copyToClipboard(str: string): void;
+interface 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.
+ */
+declare function scroll({ to, offset, duration, container }: ScrollConfig): void;
+/**
+ * Prevents function execution until it hasn't been called for a specified time period.
+ *
+ * @param fn - The function.
+ * @param delay - The time period (in ms).
+ * @returns The debounced function.
+ */
+declare function debounce(fn: Fn<void>, delay: number): Fn<void>;
+/**
+ * Optimises subsequent calls of a function by caching return values.
+ *
+ * @param fn - The function.
+ * @returns The memoised function.
+ */
+declare function memoise<T>(fn: Fn<T>): Fn<T>;
+declare const memoize: typeof memoise;
+/**
+ * Enforces that a function is only callable one time.
+ *
+ * @param fn - The function.
+ * @returns The one-time callable function.
+ */
+declare function once(fn: Fn<void>): Fn<void>;
+/**
+ * Executes a given function a specified number of times.
+ *
+ * @param fn - The function to execute for each iteration.
+ * @param n - The number of times to execute the function.
+ */
+declare function repeat(fn: (i: number) => void, n: number): void;
+/**
+ * Prevents function execution for a specified time period after it was last called.
+ *
+ * @param fn - The function.
+ * @param limit - The time period.
+ * @returns The throttled function.
+ */
+declare function throttle(fn: Fn<void>, limit: number): Fn<void>;
+/**
+ * Identifies if a value is an array.
+ *
+ * @param val - The value.
+ * @returns If the value is an array.
+ */
+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.
+ */
+declare function isBoolean(val: unknown): val is boolean;
+/**
+ * Identifies if the code is being run in a browser.
+ *
+ * @returns If the code is being run in a browser.
+ */
+declare function isBrowser(): boolean;
+/**
+ * Identifies if a value is defined.
+ *
+ * @param val - The value.
+ * @returns If the value is defined.
+ */
+declare function isDefined<T>(val: T): val is Exclude<T, null | undefined>;
+/**
+ * Identifies if a value is an empty array.
+ *
+ * @param val - The value.
+ * @returns If the value is an empty array.
+ */
+declare function isEmptyArray(val: unknown): val is [];
+/**
+ * Identifies if a value is an empty object.
+ *
+ * @param val - The value.
+ * @returns If the value is an empty object.
+ */
+declare function isEmptyObject(val: unknown): val is Obj<never>;
+/**
+ * Identifies if a value is a function.
+ *
+ * @param val - The value.
+ * @returns If the value is a function.
+ */
+declare function isFunction<T extends Fn>(val: unknown): val is T;
+/**
+ * Identifies if a value is null.
+ *
+ * @param val - The value.
+ * @returns If the value is null.
+ */
+declare function isNull(val: unknown): val is null;
+/**
+ * Identifies if a value is a number.
+ *
+ * @param val - The value.
+ * @returns If the value is a number.
+ */
+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.
+ */
+declare function isObject(val: unknown): val is Obj;
+/**
+ * Identifies if a value is an array, an object, a date, or null.
+ *
+ * @param val - The value.
+ * @returns If the value is an array, an object, a date, or null.
+ */
+declare function isObjectLike(val: unknown): val is object;
+/**
+ * Identifies if a value is a string.
+ *
+ * @param val - The value.
+ * @returns If the value is a string.
+ */
+declare function isString(val: unknown): val is string;
+/**
+ * Identifies if the code is being run on a touch device.
+ *
+ * @returns If the code is being run on a touch device.
+ */
+declare function isTouchDevice(): boolean;
+/**
+ * Identifies if a value is undefined.
+ *
+ * @param val - The value.
+ * @returns If the value is undefined.
+ */
+declare function isUndefined(val: unknown): val is undefined;
+/**
+ * Identifies if a value is the global window.
+ *
+ * @param val - The value.
+ * @returns If the value is the global window.
+ */
+declare function isWindow(val: unknown): val is Window;
+/**
+ * Does nothing.
+ *
+ * @returns Nothing.
+ */
+declare function noop(): void;
+/**
+ * Halts thread execution for a specified time period.
+ *
+ * @param duration - The time period (in ms).
+ * @returns The halting promise.
+ */
+declare function sleep(duration: number): Promise<void>;
+/**
+ * Generates a random string of a specified length.
+ *
+ * @param length - The length of the randomly generated string.
+ * @returns The randomly generated string.
+ */
+declare function uuid(length?: number): string;
+/**
+ * Returns the average of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The average.
+ */
+declare function average(ns: readonly number[]): number;
+/**
+ * Rounds a number up to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round up.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function ceil(n: number, factor?: number): number;
+/**
+ * Restricts a number between two bounds.
+ *
+ * @param n - The number to restrict.
+ * @param min - The minimum bound.
+ * @param max - The maximum bound.
+ * @returns The number restricted between the specified bounds.
+ */
+declare function clamp(n: number, min: number, max: number): number;
+/**
+ * Rounds a number down to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round down.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function floor(n: number, factor?: number): number;
+/**
+ * Identifies if a number is even.
+ *
+ * @param n - The number.
+ * @returns If the number is even.
+ */
+declare function isEven(n: number): boolean;
+/**
+ * Identifies if a number is odd.
+ *
+ * @param n - The number.
+ * @returns If the number is odd.
+ */
+declare function isOdd(n: number): boolean;
+/**
+ * Returns the maximum number of provided numbers or array of numbers.
+ *
+ * @param ns - The numbers or the array of numbers.
+ * @returns The maximum number.
+ */
+declare function max(...ns: number[] | [number[]]): number;
+/**
+ * Returns the minimum number of provided numbers or array of numbers.
+ *
+ * @param ns - The numbers or the array of numbers.
+ * @returns The minimum number.
+ */
+declare function min(...ns: number[] | [number[]]): number;
+/**
+ * Returns the product of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The product.
+ */
+declare function product(ns: readonly number[]): number;
+/**
+ * Rolls an n-sided die.
+ *
+ * @param n - The number of sides on the die.
+ * @returns If the die roll was 0.
+ */
+declare function randomChance(n: number): boolean;
+/**
+ * Generates a random integer between bounds.
+ *
+ * @param min - The inclusive minimum bound.
+ * @param max - The exclusive maximum bound.
+ * @returns The random integer.
+ */
+declare function randomNumber(max: number): number;
+declare function randomNumber(min: number, max: number): number;
+/**
+ * Rounds a number to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function round(n: number, factor?: number): number;
+/**
+ * Returns the sum of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The sum.
+ */
+declare function sum(ns: readonly number[]): number;
+/**
+ * Rounds a number to a specified number of decimal places.
+ *
+ * @param n - The number to round.
+ * @param decimalPlaces - The number of decimal places to round to.
+ * @returns The rounded number.
+ */
+declare function toDp(n: number, decimalPlaces?: number): number;
+/**
+ * Converts a string which contains a number into the number itself.
+ *
+ * @param str - The string.
+ * @param extensions - Additional symbols to consider in the conversion.
+ * @returns The number.
+ */
+declare function toNumber(str: string, extensions?: string[]): number;
+/**
+ * Deep clones an array or object.
+ *
+ * @param input - The array or object to clone.
+ * @returns A deep clone of the input array or object.
+ */
+declare function clone<T>(input: T): T;
+/**
+ * Creates a shallow copy of an object, omitting the specified keys.
+ *
+ * @param object - The object to copy.
+ * @param keysToOmit - The keys to omit from the copied object.
+ * @returns A shallow copy of the object, without the specified keys.
+ */
+declare function omit<T extends Record<string, any>, K extends keyof T>(object: T, keysToOmit: K[] | any[]): Pick<T, Exclude<keyof T, K>>;
+/**
+ * Strict-typed, shorthand `Object.entries`
+ *
+ * @param obj - The object to extract the entries from.
+ * @returns The entries.
+ */
+declare function es<T extends object>(obj: T): [keyof T, T[keyof T]][];
+/**
+ * Strict-typed, shorthand `Object.keys`
+ *
+ * @param obj - The object to extract the keys from.
+ * @returns The keys.
+ */
+declare function ks<T extends object>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>;
+/**
+ * Shorthand `Object.values`
+ *
+ * @param obj - The object to extract the values from.
+ * @returns The values.
+ */
+declare function vs<T>(obj: Obj<T>): T[];
+/**
+ * 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.
+ * @param delimiter - The delimiter to split the string by.
+ * @returns The capitalised string.
+ */
+declare function capitalise(str: string, allWords?: boolean, delimiter?: string): string;
+declare const capitalize: typeof capitalise;
+/**
+ * Separates a string into an array of characters.
+ *
+ * @param str - The string.
+ * @returns The string's characters.
+ */
+declare function chars(str: string): string[];
+/**
+ * Identifies strings which only contain whitespace.
+ *
+ * @param str - The string.
+ * @returns If the string is blank.
+ */
+declare function isBlank(str: string): boolean;
+/**
+ * Identifies empty strings.
+ *
+ * @param str - The string.
+ * @returns If the string is empty.
+ */
+declare function isEmpty(str: string): boolean;
+/**
+ * Replaces a character at a specified index in a string with a new character.
+ *
+ * @param str - The string.
+ * @param i - The index of the character to replace.
+ * @param char - The character to replace with.
+ * @returns The modified string with the character replaced.
+ */
+declare function replaceChar(str: string, i: number, char: string): string;
+/**
+ * Splits a string into two at a specified index.
+ *
+ * @param str - The string.
+ * @param i - The position to split at.
+ * @returns The tuple of strings before and after the split.
+ */
+declare function splitString(str: string, i: number): [string, string];
+/**
+ * Converts a kebab case string to camel case.
+ *
+ * @param str - The kebab case string.
+ * @returns The camel case string.
+ */
+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.
+ */
+declare function toKebab(str: string): string;
+/**
+ * Adds the respective ordinal suffix (-st, -nd, -rd or -th) to a number.
+ *
+ * @param n - The number.
+ * @returns The number with the ordinal suffix appended.
+ */
+declare function toOrdinal(n: number): string;
+/**
+ * Converts a given number to Roman numerals.
+ *
+ * @param n - The number to convert to Roman numerals.
+ * @param lowerCase - If the numerals should be in lowercase.
+ * @returns The Roman numeral representation of the given number.
+ */
+declare function toRomanNumerals(n: number, lowerCase?: boolean): string;
+/**
+ * Truncates a string to a provided length.
+ *
+ * @param str - The string.
+ * @param length - The length.
+ * @param suffix - The suffix to apply after truncation.
+ * @returns The truncated string.
+ */
+declare function truncate(str: string, length: number, suffix?: string): string;
+/**
+ * Joins an array of characters into a string.
+ *
+ * @param chars - The characters.
+ * @returns The string.
+ */
+declare function unchars(chars: string[]): string;
+export { type Arrayable, type Fn, type Nullable, type Obj, type VoidFn, average, capitalise, capitalize, ceil, chars, clamp, clone, copyToClipboard, debounce, drop, es, floor, groups, head, init, isArray, isBlank, isBoolean, isBrowser, isDefined, isEmpty, isEmptyArray, isEmptyObject, isEven, isFunction, isNull, isNumber, isObject, isObjectLike, isOdd, isString, isTouchDevice, isUndefined, isWindow, ks, last, max, memoise, memoize, min, noop, omit, once, partition, product, randomChance, randomNumber, range, remove, repeat, replaceChar, round, scroll, shuffle, sleep, splitArray, splitString, sum, tail, take, throttle, toArray, toCamel, toDp, toKebab, toNumber, toOrdinal, toRomanNumerals, truncate, unchars, uniq, uuid, vs };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,613 @@
+/**
+ * Removes the first `n` items of an array.
+ *
+ * @param array - The array.
+ * @param n - The number of items to remove.
+ * @returns The remaining items.
+ */
+declare function drop<T>(array: readonly T[], n: number): T[];
+/**
+ * Splits an array into groups of equal size.
+ *
+ * @param array - The array.
+ * @param n - The size of each group.
+ * @returns The array split into groups.
+ */
+declare function groups<T>(array: readonly T[], n: number): T[][];
+/**
+ * Returns the first item of an array.
+ *
+ * @param array - The array.
+ * @returns The first item.
+ */
+declare function head(array: readonly []): undefined;
+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.
+ */
+declare function init<T>(array: readonly T[]): T[];
+/**
+ * Returns the last item of an array.
+ *
+ * @param array - The array.
+ * @returns The last item.
+ */
+declare function last(array: readonly []): undefined;
+declare function last<T>(array: readonly T[]): T;
+/**
+ * Splits an array into two based on a predicate function.
+ *
+ * @param array - The array.
+ * @param filter - The predicate function.
+ * @returns The tuple of values that satisfy the predicate and those that don't.
+ */
+declare function partition<T, U = T>(array: readonly (T | U)[], filter: (current: T | U, idx: number, array: readonly (T | U)[]) => boolean): [T[], U[]];
+/**
+ * Generates a range of numbers.
+ *
+ * @param start - The inclusive start value.
+ * @param stop - The exlusive stop value.
+ * @param step - The step to increment by.
+ * @returns The range of numbers.
+ */
+declare function range(stop: number): number[];
+declare function range(start: number, stop: number, step?: number): number[];
+/**
+ * Removes an item from an array.
+ *
+ * @param array - The array.
+ * @param item - The item, or getter function for the item, to remove.
+ * @returns The array with the item removed, if found.
+ */
+declare function remove<T>(array: T[], itemOrGetter: T | ((item: T) => boolean)): T[];
+/**
+ * Randomly shuffles items in an array.
+ *
+ * @param array - The array.
+ * @returns A copy of the array with its items randomly shuffled.
+ */
+declare function shuffle<T>(array: T[]): T[];
+/**
+ * Splits an array into two at a specified index.
+ *
+ * @param array - The array.
+ * @param i - The position to split at.
+ * @returns The tuple of values before and after the split.
+ */
+declare function splitArray<T>(array: readonly T[], i: number): [T[], T[]];
+/**
+ * Returns all but the first item of an array.
+ *
+ * @param array - The array.
+ * @returns The array without the first item.
+ */
+declare function tail<T>(array: readonly T[]): T[];
+/**
+ * Returns the first `n` items of an array.
+ *
+ * @param array - The array.
+ * @param n - The number of items to return.
+ * @returns The first `n` items.
+ */
+declare function take<T>(array: readonly T[], n: number): T[];
+type Arrayable<T> = T | Array<T>;
+type Nullable<T> = T | null | undefined;
+type Fn<T = any> = (...args: any[]) => T;
+type VoidFn = Fn<void>;
+type Obj<V = unknown> = Record<string | symbol | number, V>;
+/**
+ * Wraps a single value in 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.
+ */
+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.
+ */
+declare function uniq<T>(array: readonly T[]): T[];
+/**
+ * Copies the provided string to the user's clipboard.
+ *
+ * @param str - The string to be copied to the clipboard.
+ */
+declare function copyToClipboard(str: string): void;
+interface 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.
+ */
+declare function scroll({ to, offset, duration, container }: ScrollConfig): void;
+/**
+ * Prevents function execution until it hasn't been called for a specified time period.
+ *
+ * @param fn - The function.
+ * @param delay - The time period (in ms).
+ * @returns The debounced function.
+ */
+declare function debounce(fn: Fn<void>, delay: number): Fn<void>;
+/**
+ * Optimises subsequent calls of a function by caching return values.
+ *
+ * @param fn - The function.
+ * @returns The memoised function.
+ */
+declare function memoise<T>(fn: Fn<T>): Fn<T>;
+declare const memoize: typeof memoise;
+/**
+ * Enforces that a function is only callable one time.
+ *
+ * @param fn - The function.
+ * @returns The one-time callable function.
+ */
+declare function once(fn: Fn<void>): Fn<void>;
+/**
+ * Executes a given function a specified number of times.
+ *
+ * @param fn - The function to execute for each iteration.
+ * @param n - The number of times to execute the function.
+ */
+declare function repeat(fn: (i: number) => void, n: number): void;
+/**
+ * Prevents function execution for a specified time period after it was last called.
+ *
+ * @param fn - The function.
+ * @param limit - The time period.
+ * @returns The throttled function.
+ */
+declare function throttle(fn: Fn<void>, limit: number): Fn<void>;
+/**
+ * Identifies if a value is an array.
+ *
+ * @param val - The value.
+ * @returns If the value is an array.
+ */
+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.
+ */
+declare function isBoolean(val: unknown): val is boolean;
+/**
+ * Identifies if the code is being run in a browser.
+ *
+ * @returns If the code is being run in a browser.
+ */
+declare function isBrowser(): boolean;
+/**
+ * Identifies if a value is defined.
+ *
+ * @param val - The value.
+ * @returns If the value is defined.
+ */
+declare function isDefined<T>(val: T): val is Exclude<T, null | undefined>;
+/**
+ * Identifies if a value is an empty array.
+ *
+ * @param val - The value.
+ * @returns If the value is an empty array.
+ */
+declare function isEmptyArray(val: unknown): val is [];
+/**
+ * Identifies if a value is an empty object.
+ *
+ * @param val - The value.
+ * @returns If the value is an empty object.
+ */
+declare function isEmptyObject(val: unknown): val is Obj<never>;
+/**
+ * Identifies if a value is a function.
+ *
+ * @param val - The value.
+ * @returns If the value is a function.
+ */
+declare function isFunction<T extends Fn>(val: unknown): val is T;
+/**
+ * Identifies if a value is null.
+ *
+ * @param val - The value.
+ * @returns If the value is null.
+ */
+declare function isNull(val: unknown): val is null;
+/**
+ * Identifies if a value is a number.
+ *
+ * @param val - The value.
+ * @returns If the value is a number.
+ */
+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.
+ */
+declare function isObject(val: unknown): val is Obj;
+/**
+ * Identifies if a value is an array, an object, a date, or null.
+ *
+ * @param val - The value.
+ * @returns If the value is an array, an object, a date, or null.
+ */
+declare function isObjectLike(val: unknown): val is object;
+/**
+ * Identifies if a value is a string.
+ *
+ * @param val - The value.
+ * @returns If the value is a string.
+ */
+declare function isString(val: unknown): val is string;
+/**
+ * Identifies if the code is being run on a touch device.
+ *
+ * @returns If the code is being run on a touch device.
+ */
+declare function isTouchDevice(): boolean;
+/**
+ * Identifies if a value is undefined.
+ *
+ * @param val - The value.
+ * @returns If the value is undefined.
+ */
+declare function isUndefined(val: unknown): val is undefined;
+/**
+ * Identifies if a value is the global window.
+ *
+ * @param val - The value.
+ * @returns If the value is the global window.
+ */
+declare function isWindow(val: unknown): val is Window;
+/**
+ * Does nothing.
+ *
+ * @returns Nothing.
+ */
+declare function noop(): void;
+/**
+ * Halts thread execution for a specified time period.
+ *
+ * @param duration - The time period (in ms).
+ * @returns The halting promise.
+ */
+declare function sleep(duration: number): Promise<void>;
+/**
+ * Generates a random string of a specified length.
+ *
+ * @param length - The length of the randomly generated string.
+ * @returns The randomly generated string.
+ */
+declare function uuid(length?: number): string;
+/**
+ * Returns the average of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The average.
+ */
+declare function average(ns: readonly number[]): number;
+/**
+ * Rounds a number up to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round up.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function ceil(n: number, factor?: number): number;
+/**
+ * Restricts a number between two bounds.
+ *
+ * @param n - The number to restrict.
+ * @param min - The minimum bound.
+ * @param max - The maximum bound.
+ * @returns The number restricted between the specified bounds.
+ */
+declare function clamp(n: number, min: number, max: number): number;
+/**
+ * Rounds a number down to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round down.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function floor(n: number, factor?: number): number;
+/**
+ * Identifies if a number is even.
+ *
+ * @param n - The number.
+ * @returns If the number is even.
+ */
+declare function isEven(n: number): boolean;
+/**
+ * Identifies if a number is odd.
+ *
+ * @param n - The number.
+ * @returns If the number is odd.
+ */
+declare function isOdd(n: number): boolean;
+/**
+ * Returns the maximum number of provided numbers or array of numbers.
+ *
+ * @param ns - The numbers or the array of numbers.
+ * @returns The maximum number.
+ */
+declare function max(...ns: number[] | [number[]]): number;
+/**
+ * Returns the minimum number of provided numbers or array of numbers.
+ *
+ * @param ns - The numbers or the array of numbers.
+ * @returns The minimum number.
+ */
+declare function min(...ns: number[] | [number[]]): number;
+/**
+ * Returns the product of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The product.
+ */
+declare function product(ns: readonly number[]): number;
+/**
+ * Rolls an n-sided die.
+ *
+ * @param n - The number of sides on the die.
+ * @returns If the die roll was 0.
+ */
+declare function randomChance(n: number): boolean;
+/**
+ * Generates a random integer between bounds.
+ *
+ * @param min - The inclusive minimum bound.
+ * @param max - The exclusive maximum bound.
+ * @returns The random integer.
+ */
+declare function randomNumber(max: number): number;
+declare function randomNumber(min: number, max: number): number;
+/**
+ * Rounds a number to the nearest multiple of the specified factor.
+ *
+ * @param n - The number to round.
+ * @param factor - The factor used for rounding.
+ * @returns The rounded number.
+ */
+declare function round(n: number, factor?: number): number;
+/**
+ * Returns the sum of a number array.
+ *
+ * @param ns - The number array.
+ * @returns The sum.
+ */
+declare function sum(ns: readonly number[]): number;
+/**
+ * Rounds a number to a specified number of decimal places.
+ *
+ * @param n - The number to round.
+ * @param decimalPlaces - The number of decimal places to round to.
+ * @returns The rounded number.
+ */
+declare function toDp(n: number, decimalPlaces?: number): number;
+/**
+ * Converts a string which contains a number into the number itself.
+ *
+ * @param str - The string.
+ * @param extensions - Additional symbols to consider in the conversion.
+ * @returns The number.
+ */
+declare function toNumber(str: string, extensions?: string[]): number;
+/**
+ * Deep clones an array or object.
+ *
+ * @param input - The array or object to clone.
+ * @returns A deep clone of the input array or object.
+ */
+declare function clone<T>(input: T): T;
+/**
+ * Creates a shallow copy of an object, omitting the specified keys.
+ *
+ * @param object - The object to copy.
+ * @param keysToOmit - The keys to omit from the copied object.
+ * @returns A shallow copy of the object, without the specified keys.
+ */
+declare function omit<T extends Record<string, any>, K extends keyof T>(object: T, keysToOmit: K[] | any[]): Pick<T, Exclude<keyof T, K>>;
+/**
+ * Strict-typed, shorthand `Object.entries`
+ *
+ * @param obj - The object to extract the entries from.
+ * @returns The entries.
+ */
+declare function es<T extends object>(obj: T): [keyof T, T[keyof T]][];
+/**
+ * Strict-typed, shorthand `Object.keys`
+ *
+ * @param obj - The object to extract the keys from.
+ * @returns The keys.
+ */
+declare function ks<T extends object>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>;
+/**
+ * Shorthand `Object.values`
+ *
+ * @param obj - The object to extract the values from.
+ * @returns The values.
+ */
+declare function vs<T>(obj: Obj<T>): T[];
+/**
+ * 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.
+ * @param delimiter - The delimiter to split the string by.
+ * @returns The capitalised string.
+ */
+declare function capitalise(str: string, allWords?: boolean, delimiter?: string): string;
+declare const capitalize: typeof capitalise;
+/**
+ * Separates a string into an array of characters.
+ *
+ * @param str - The string.
+ * @returns The string's characters.
+ */
+declare function chars(str: string): string[];
+/**
+ * Identifies strings which only contain whitespace.
+ *
+ * @param str - The string.
+ * @returns If the string is blank.
+ */
+declare function isBlank(str: string): boolean;
+/**
+ * Identifies empty strings.
+ *
+ * @param str - The string.
+ * @returns If the string is empty.
+ */
+declare function isEmpty(str: string): boolean;
+/**
+ * Replaces a character at a specified index in a string with a new character.
+ *
+ * @param str - The string.
+ * @param i - The index of the character to replace.
+ * @param char - The character to replace with.
+ * @returns The modified string with the character replaced.
+ */
+declare function replaceChar(str: string, i: number, char: string): string;
+/**
+ * Splits a string into two at a specified index.
+ *
+ * @param str - The string.
+ * @param i - The position to split at.
+ * @returns The tuple of strings before and after the split.
+ */
+declare function splitString(str: string, i: number): [string, string];
+/**
+ * Converts a kebab case string to camel case.
+ *
+ * @param str - The kebab case string.
+ * @returns The camel case string.
+ */
+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.
+ */
+declare function toKebab(str: string): string;
+/**
+ * Adds the respective ordinal suffix (-st, -nd, -rd or -th) to a number.
+ *
+ * @param n - The number.
+ * @returns The number with the ordinal suffix appended.
+ */
+declare function toOrdinal(n: number): string;
+/**
+ * Converts a given number to Roman numerals.
+ *
+ * @param n - The number to convert to Roman numerals.
+ * @param lowerCase - If the numerals should be in lowercase.
+ * @returns The Roman numeral representation of the given number.
+ */
+declare function toRomanNumerals(n: number, lowerCase?: boolean): string;
+/**
+ * Truncates a string to a provided length.
+ *
+ * @param str - The string.
+ * @param length - The length.
+ * @param suffix - The suffix to apply after truncation.
+ * @returns The truncated string.
+ */
+declare function truncate(str: string, length: number, suffix?: string): string;
+/**
+ * Joins an array of characters into a string.
+ *
+ * @param chars - The characters.
+ * @returns The string.
+ */
+declare function unchars(chars: string[]): string;
+export { type Arrayable, type Fn, type Nullable, type Obj, type VoidFn, average, capitalise, capitalize, ceil, chars, clamp, clone, copyToClipboard, debounce, drop, es, floor, groups, head, init, isArray, isBlank, isBoolean, isBrowser, isDefined, isEmpty, isEmptyArray, isEmptyObject, isEven, isFunction, isNull, isNumber, isObject, isObjectLike, isOdd, isString, isTouchDevice, isUndefined, isWindow, ks, last, max, memoise, memoize, min, noop, omit, once, partition, product, randomChance, randomNumber, range, remove, repeat, replaceChar, round, scroll, shuffle, sleep, splitArray, splitString, sum, tail, take, throttle, toArray, toCamel, toDp, toKebab, toNumber, toOrdinal, toRomanNumerals, truncate, unchars, uniq, uuid, vs };

package/dist/index.js ADDED Viewed

@@ -0,0 +1 @@

+ function B(e,r){return r<=0?[...e]:e.slice(r)}function q(e,r){if(r<=0)throw new Error("[tsu] Invalid group size. Is it greater than 0?");if(r>=e.length)return[[...e]];let n=[];for(let o=0;o<e.length;o+=r)n.push(e.slice(o,o+r));return n}function I(e){return e[0]}function W(e){return e.slice(0,e.length-1)}function K(e){return e[e.length-1]}function z(e,r){let n=[],o=[];for(let i=0;i<e.length;i++){let t=e[i];r(t,i,e)?n.push(t):o.push(t)}return[n,o]}function V(...e){let r,n,o;e.length===1?(n=e[0],r=0,o=1):(r=e[0],n=e[1],o=e[2]||1),o<=0&&(console.warn("[tsu] warning: a step less than or equal to 0 will be set to 1."),o=1);let i=[],t=r;for(;t<n;)i.push(t),t+=o||1;return i}function l(e){return Array.isArray(e)}function Z(e){return typeof e=="boolean"}function s(){return typeof window<"u"}function ee(e){return typeof e<"u"}function oe(e){return l(e)&&e.length===0}function ue(e){if(!w(e))return!1;for(let r in e)return!1;return!0}function v(e){return typeof e=="function"}function p(e){return Object.prototype.toString.call(e)==="[object Null]"}function j(e){return typeof e=="number"}function w(e){return Object.prototype.toString.call(e)==="[object Object]"}function c(e){return typeof e=="object"}function b(e){return typeof e=="string"}function xe(){return"ontouchstart"in window||navigator.maxTouchPoints>0}function de(e){return typeof e>"u"}function f(e){return s()&&Object.prototype.toString.call(e)==="[object Window]"}function De(e,r){let n=v(r)?r:i=>i===r,o=e.findIndex(n);return o!==-1?[...e.slice(0,o),...e.slice(o+1)]:e}function Ie(e){return e.length<1?0:k(e)/e.length}function We(e,r=1){let n=e/r;return Math.ceil(n)*r}function a(e,r,n){return Math.min(n,Math.max(r,e))}function Xe(e,r=1){let n=e/r;return Math.floor(n)*r}function _e(e){return e%2===0}function Je(e){return e%2!==0}function Ze(...e){let r;return e.length===1&&Array.isArray(e[0])?r=e[0]:r=e,Math.max(...r)}function Ge(...e){let r;return e.length===1&&Array.isArray(e[0])?r=e[0]:r=e,Math.min(...r)}function rr(e){if(e.length<1)return 0;let r=1;for(let n=0;n<e.length;n++)r*=e[n];return r}function u(...e){let r,n;return e.length===1?(r=0,n=e[0]):(r=e[0],n=e[1]),Math.floor(Math.random()*(n-r))+r}function ir(e){return u(e)===0}function fr(e,r=1){let n=e/r;return Math.round(n)*r}function k(e){let r=0;for(let n=0;n<e.length;n++)r+=e[n];return r}function pr(e,r=0){r<0&&console.warn("[tsu] warning: decimalPlaces less than 0 are set to 0."),r>100&&console.warn("[tsu] warning: decimalPlaces greater than 100 are set to 100.");let n=a(r,0,100);return Number(e.toFixed(n))}function ar(e,r=[]){if(!e.length)return NaN;let n=["#","\xA3","\u20AC","$","%",",",...r],o=new RegExp(`[${n.join("")}]`,"g");return Number(e.replace(o,""))}function x(e){if(l(e)){let r=[];for(let n=0;n<e.length;n++)c(e[n])&&!p(e[n])?r[n]=x(e[n]):r[n]=e[n];return r}if(c(e)&&!p(e)){let r={};for(let n in e)c(e[n])&&!p(e[n])?r[n]=x(e[n]):r[n]=e[n];return r}return e}function Ur(e,r){let n={...e};for(let o of r)delete n[o];return n}function Lr(e){return Object.entries(e)}function Dr(e){return Object.keys(e)}function Hr(e){return Object.values(e)}function Jr(e){let r=x(e),n,o,i;for(n=r.length;n;n-=1)o=u(n),i=r[n-1],r[n-1]=r[o],r[o]=i;return r}function Zr(e,r){return r<=0?[[],[...e]]:r>e.length?[[...e],[]]:[e.slice(0,r),e.slice(r)]}function Gr(e){return e.slice(1)}function rn(e,r){return r<=0?[]:e.slice(0,r)}function on(e){return e?Array.isArray(e)?e:[e]:[]}function un(e){return Array.from(new Set(e))}function M(e){let r=document.createElement("textarea");r.value=e??"",r.style.position="absolute",r.style.opacity="0",document.body.appendChild(r),r.select(),document.execCommand("copy"),r.remove()}function kn(e){s()&&(window.navigator&&"clipboard"in window.navigator?navigator.clipboard.writeText(e):M(e))}function F(e){return e<.5?4*Math.pow(e,3):(e-1)*(2*e-2)*(2*e-2)+1}function S(e,r,n,o){return e+(r-e)*F(n/o)}function U(e,r,n){let o;return j(e)?o=e:f(n)?o=e.getBoundingClientRect().top+r:o=e.getBoundingClientRect().top+r-n.getBoundingClientRect().top,o}function An({to:e,offset:r=0,duration:n=1e3,container:o=null}){let i=b(e)?document.querySelector(e):e,t=b(o)?document.querySelector(o):o||window,m=f(t)?window.pageYOffset||document.documentElement.scrollTop:t.scrollTop||0,O=f(t)?document.documentElement.scrollHeight-window.innerHeight:t.scrollHeight-t.clientHeight,A=U(i,m,t)+r,d=a(A,0,O),N=Date.now();function T(){let g=Date.now()-N,y=g<n,h=y?S(m,d,g,n):d;y&&requestAnimationFrame(T),f(t)?window.scrollTo(0,h):t instanceof HTMLElement&&(t.scrollTop=h)}T()}function Un(e,r){r<0&&console.warn("[tsu] warning: debounce delays less than 0 will be set to 0.");let n;return function(...o){clearTimeout(n),n=setTimeout(()=>{clearTimeout(n),e(...o)},r)}}function R(e){let r={};return function(...n){let o=JSON.stringify(n);if(o in r)return r[o];let i=e(...n);return r[o]=i,i}}var Ln=R;function Dn(e){let r=!1;return(...n)=>{r||(e(...n),r=!0)}}function Hn(e,r){if(!(r<=0))for(let n=0;n<r;n++)e(n)}function Pn(e,r){r<0&&console.warn("[tsu] warning: throttle limits less than 0 will be set to 0.");let n=!1;return function(...o){n||(e(...o),n=!0,setTimeout(()=>{n=!1},r))}}function Jn(){}async function Zn(e){return e<0&&console.warn("[tsu] warning: sleep durations less than 0 are set to 0."),new Promise(r=>{setTimeout(r,e)})}var E="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";function eo(e=16){let r=E.length,n=e,o="";for(;n--;)o+=E[u(r)];return o}function L(e,r=!1,n=" "){return r?e.split(n).map(o=>o.charAt(0).toUpperCase()+o.slice(1)).join(n):e.charAt(0).toUpperCase()+e.slice(1)}var uo=L;function mo(e){return e.split("")}function so(e){return e.trim().length===0}function co(e){return e.length===0}function xo(e,r,n){return r<0||r>e.length-1?e:e.slice(0,r)+n+e.slice(r+1)}function To(e,r){return r<=0?["",e]:r>e.length?[e,""]:[e.slice(0,r),e.slice(r)]}function yo(e){let r=/-(\w)/g;return e.replace(r,(n,o)=>o?o.toUpperCase():"")}function wo(e){let r=/\B([A-Z])/g;return e.replace(r,"-$1").toLowerCase()}function jo(e){let n=["st","nd","rd"][(Math.abs(e)/10%10^1&&Math.abs(e)%10)-1]||"th";return`${e}${n}`}var C={1:"I",4:"IV",5:"V",9:"IX",10:"X",40:"XL",50:"L",90:"XC",100:"C",400:"CD",500:"D",900:"CM",1e3:"M"};function Eo(e,r=!1){let n=e,o="",i=Object.keys(C).map(Number).sort((t,m)=>m-t);for(let t of i)for(;n>=t;)o+=C[t],n-=t;return r?o.toLowerCase():o}function Oo(e,r,n="..."){return r<=0?n:e.slice(0,r)+n}function No(e){return e.join("")}export{Ie as average,L as capitalise,uo as capitalize,We as ceil,mo as chars,a as clamp,x as clone,kn as copyToClipboard,Un as debounce,B as drop,Lr as es,Xe as floor,q as groups,I as head,W as init,l as isArray,so as isBlank,Z as isBoolean,s as isBrowser,ee as isDefined,co as isEmpty,oe as isEmptyArray,ue as isEmptyObject,_e as isEven,v as isFunction,p as isNull,j as isNumber,w as isObject,c as isObjectLike,Je as isOdd,b as isString,xe as isTouchDevice,de as isUndefined,f as isWindow,Dr as ks,K as last,Ze as max,R as memoise,Ln as memoize,Ge as min,Jn as noop,Ur as omit,Dn as once,z as partition,rr as product,ir as randomChance,u as randomNumber,V as range,De as remove,Hn as repeat,xo as replaceChar,fr as round,An as scroll,Jr as shuffle,Zn as sleep,Zr as splitArray,To as splitString,k as sum,Gr as tail,rn as take,Pn as throttle,on as toArray,yo as toCamel,pr as toDp,wo as toKebab,ar as toNumber,jo as toOrdinal,Eo as toRomanNumerals,Oo as truncate,No as unchars,un as uniq,eo as uuid,Hr as vs};

package/package.json ADDED Viewed

@@ -0,0 +1,54 @@
+{
+  "name": "tsu",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "TypeScript utilities",
+  "license": "MIT",
+  "author": "HappyTiptoe",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/HappyTiptoe/tsu.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/HappyTiptoe/tsu/issues"
+  },
+  "scripts": {
+    "build": "tsup",
+    "watch": "nr build --watch src",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "lint": "eslint 'src/**/*.{ts,tsx}'",
+    "lint:fix": "eslint 'src/**/*.{ts,tsx}' --fix",
+    "docs:dev": "vitepress dev docs --port 8888",
+    "docs:build": "vitepress build docs",
+    "prepublishOnly": "nr test; nr build"
+  },
+  "devDependencies": {
+    "@antfu/ni": "^28.2.0",
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.2.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "jiti": "^2.6.1",
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0",
+    "vite": "^7.3.1",
+    "vitepress": "^1.6.4",
+    "vitest": "^4.0.18"
+  }
+}