From 8cdaa49ff7cf5d950b721977466d3c08d18cfa29 Mon Sep 17 00:00:00 2001 From: Adam C Hamlin Date: Sat, 8 Jul 2023 11:06:18 -0400 Subject: [PATCH] feat: Add collect and collectFirst funcs --- cdn/radash.esm.js | 25 ++++++++++++++++- cdn/radash.js | 25 +++++++++++++++++ cdn/radash.min.js | 2 +- docs/array/collect.mdx | 31 ++++++++++++++++++++ docs/array/collectFirst.mdx | 33 ++++++++++++++++++++++ package.json | 2 +- src/array.ts | 47 +++++++++++++++++++++++++++++++ src/index.ts | 2 ++ src/tests/array.test.ts | 56 +++++++++++++++++++++++++++++++++++++ 9 files changed, 220 insertions(+), 3 deletions(-) create mode 100644 docs/array/collect.mdx create mode 100644 docs/array/collectFirst.mdx diff --git a/cdn/radash.esm.js b/cdn/radash.esm.js index 4eb90ee3..abc8b318 100644 --- a/cdn/radash.esm.js +++ b/cdn/radash.esm.js @@ -335,6 +335,29 @@ function shift(arr, n) { return arr; return [...arr.slice(-shiftNumber, arr.length), ...arr.slice(0, -shiftNumber)]; } +function collect(arr, tx) { + const res = []; + let idx = 0; + for (const el of arr) { + const transformed = tx(el, idx); + if (transformed !== void 0) { + res.push(transformed); + } + idx += 1; + } + return res; +} +function collectFirst(arr, tx) { + let idx = 0; + for (const el of arr) { + const transformed = tx(el, idx); + if (transformed !== void 0) { + return transformed; + } + idx += 1; + } + return void 0; +} const reduce = async (array, asyncReducer, initValue) => { const initProvided = initValue !== void 0; @@ -926,4 +949,4 @@ const trim = (str, charsToTrim = " ") => { return str.replace(regex, ""); }; -export { all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isNumber, isObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject }; +export { all, alphabetical, assign, boil, callable, camel, capitalize, chain, clone, cluster, collect, collectFirst, compose, construct, counting, crush, dash, debounce, defer, diff, draw, first, flat, fork, get, group, guard, intersects, invert, isArray, isDate, isEmpty, isEqual, isFloat, isFunction, isInt, isNumber, isObject, isPrimitive, isPromise, isString, isSymbol, iterate, keys, last, list, listify, lowerize, map, mapEntries, mapKeys, mapValues, max, memo, merge, min, objectify, omit, parallel, partial, partob, pascal, pick, proxied, random, range, reduce, replace, replaceOrAppend, retry, select, series, set, shake, shift, shuffle, sift, sleep, snake, sort, sum, template, throttle, title, toFloat, toInt, toggle, trim, tryit as try, tryit, uid, unique, upperize, zip, zipToObject }; diff --git a/cdn/radash.js b/cdn/radash.js index e9f6f4fc..740eefb1 100644 --- a/cdn/radash.js +++ b/cdn/radash.js @@ -338,6 +338,29 @@ var radash = (function (exports) { return arr; return [...arr.slice(-shiftNumber, arr.length), ...arr.slice(0, -shiftNumber)]; } + function collect(arr, tx) { + const res = []; + let idx = 0; + for (const el of arr) { + const transformed = tx(el, idx); + if (transformed !== void 0) { + res.push(transformed); + } + idx += 1; + } + return res; + } + function collectFirst(arr, tx) { + let idx = 0; + for (const el of arr) { + const transformed = tx(el, idx); + if (transformed !== void 0) { + return transformed; + } + idx += 1; + } + return void 0; + } const reduce = async (array, asyncReducer, initValue) => { const initProvided = initValue !== void 0; @@ -939,6 +962,8 @@ var radash = (function (exports) { exports.chain = chain; exports.clone = clone; exports.cluster = cluster; + exports.collect = collect; + exports.collectFirst = collectFirst; exports.compose = compose; exports.construct = construct; exports.counting = counting; diff --git a/cdn/radash.min.js b/cdn/radash.min.js index 14a4d770..9add6e37 100644 --- a/cdn/radash.min.js +++ b/cdn/radash.min.js @@ -1 +1 @@ -var radash=function(u){"use strict";const E=t=>!!t&&t.constructor===Symbol,w=Array.isArray,k=t=>!!t&&t.constructor===Object,N=t=>t==null||typeof t!="object"&&typeof t!="function",y=t=>!!(t&&t.constructor&&t.call&&t.apply),K=t=>typeof t=="string"||t instanceof String,W=t=>h(t)&&t%1===0,J=t=>h(t)&&t%1!==0,h=t=>{try{return Number(t)===t}catch{return!1}},T=t=>Object.prototype.toString.call(t)==="[object Date]",j=t=>!(!t||!t.then||!y(t.then)),X=t=>{if(t===!0||t===!1||t==null)return!0;if(h(t))return t===0;if(T(t))return isNaN(t.getTime());if(y(t)||E(t))return!1;const e=t.length;if(h(e))return e===0;const n=t.size;return h(n)?n===0:Object.keys(t).length===0},z=(t,e)=>{if(Object.is(t,e))return!0;if(t instanceof Date&&e instanceof Date)return t.getTime()===e.getTime();if(t instanceof RegExp&&e instanceof RegExp)return t.toString()===e.toString();if(typeof t!="object"||t===null||typeof e!="object"||e===null)return!1;const n=Reflect.ownKeys(t),r=Reflect.ownKeys(e);if(n.length!==r.length)return!1;for(let s=0;st.reduce((n,r)=>{const s=e(r);return n[s]||(n[s]=[]),n[s].push(r),n},{});function H(...t){return!t||!t.length?[]:new Array(Math.max(...t.map(({length:e})=>e))).fill([]).map((e,n)=>t.map(r=>r[n]))}function Q(t,e){if(!t||!t.length)return{};const n=y(e)?e:w(e)?(r,s)=>e[s]:(r,s)=>e;return t.reduce((r,s,i)=>(r[s]=n(s,i),r),{})}const O=(t,e)=>!t||(t.length??0)===0?null:t.reduce(e),V=(t,e)=>(t||[]).reduce((n,r)=>n+(e?e(r):r),0),G=(t,e=void 0)=>t?.length>0?t[0]:e,x=(t,e=void 0)=>t?.length>0?t[t.length-1]:e,S=(t,e,n=!1)=>{if(!t)return[];const r=(i,c)=>e(i)-e(c),s=(i,c)=>e(c)-e(i);return t.slice().sort(n===!0?s:r)},tt=(t,e,n="asc")=>{if(!t)return[];const r=(i,c)=>`${e(i)}`.localeCompare(e(c)),s=(i,c)=>`${e(c)}`.localeCompare(e(i));return t.slice().sort(n==="desc"?s:r)},et=(t,e)=>t?t.reduce((n,r)=>{const s=e(r);return n[s]=(n[s]??0)+1,n},{}):{},nt=(t,e,n)=>{if(!t)return[];if(e===void 0)return[...t];for(let r=0;rr)=>t.reduce((r,s)=>(r[e(s)]=n(s),r),{}),rt=(t,e,n)=>t?t.reduce((r,s,i)=>(n(s,i)&&r.push(e(s,i)),r),[]):[];function st(t,e){const n=e??(r=>r);return O(t,(r,s)=>n(r)>n(s)?r:s)}function ut(t,e){const n=e??(r=>r);return O(t,(r,s)=>n(r){const n=Math.ceil(t.length/e);return new Array(n).fill(null).map((r,s)=>t.slice(s*e,s*e+e))},ct=(t,e)=>{const n=t.reduce((r,s)=>{const i=e?e(s):s;return r[i]||(r[i]=s),r},{});return Object.values(n)};function*A(t,e,n=s=>s,r=1){const s=y(n)?n:()=>n,i=e?t:0,c=e??t;for(let o=i;o<=c&&(yield s(o),!(o+r>c));o+=r);}const C=(t,e,n,r)=>Array.from(A(t,e,n,r)),ot=t=>t.reduce((e,n)=>(e.push(...n),e),[]),lt=(t,e,n)=>{if(!t||!e)return!1;const r=n??(i=>i),s=e.reduce((i,c)=>(i[r(c)]=!0,i),{});return t.some(i=>s[r(i)])},L=(t,e)=>t?t.reduce((n,r)=>{const[s,i]=n;return e(r)?[[...s,r],i]:[s,[...i,r]]},[[],[]]):[[],[]],ft=(t,e,n)=>!e&&!t?[]:e?t?n?t.reduce((r,s)=>{const i=e.find(c=>n(s)===n(c));return i?r.push(i):r.push(s),r},[]):t:[]:t,at=(t,e,n)=>{if(!t&&!e)return[];if(!e)return[...t];if(!t)return[e];for(let r=0;r{if(!t&&!e)return[];if(!t)return[e];if(!e)return[...t];const s=n?(o,a)=>n(o,a)===n(e,a):o=>o===e;return t.find(s)?t.filter((o,a)=>!s(o,a)):(r?.strategy??"append")==="append"?[...t,e]:[e,...t]},gt=t=>t?.filter(e=>!!e)??[],M=(t,e,n)=>{let r=n;for(let s=1;s<=t;s++)r=e(r,s);return r},ht=(t,e,n=r=>r)=>{if(!t?.length&&!e?.length)return[];if(t?.length===void 0)return[...e];if(!e?.length)return[...t];const r=e.reduce((s,i)=>(s[n(i)]=!0,s),{});return t.filter(s=>!r[n(s)])};function mt(t,e){if(t.length===0)return t;const n=e%t.length;return n===0?t:[...t.slice(-n,t.length),...t.slice(0,-n)]}const wt=async(t,e,n)=>{const r=n!==void 0;if(!r&&t?.length<1)throw new Error("Cannot reduce empty array with no init value");const s=r?t:t.slice(1);let i=r?n:t[0];for(const[c,o]of s.entries())i=await e(i,o,c);return i},yt=async(t,e)=>{if(!t)return[];let n=[],r=0;for(const s of t){const i=await e(s,r++);n.push(i)}return n},pt=async t=>{const e=[],n=(i,c)=>e.push({fn:i,rethrow:c?.rethrow??!1}),[r,s]=await m(t)(n);for(const{fn:i,rethrow:c}of e){const[o]=await m(i)(r);if(o&&c)throw o}if(r)throw r;return s};class Z extends Error{constructor(e=[]){super();const n=e.find(r=>r.name)?.name??"";this.name=`AggregateError(${n}...)`,this.message=`AggregateError with ${e.length} errors`,this.stack=e.find(r=>r.stack)?.stack??this.stack,this.errors=e}}const bt=async(t,e,n)=>{const r=e.map((d,b)=>({index:b,item:d})),s=async d=>{const b=[];for(;;){const l=r.pop();if(!l)return d(b);const[f,g]=await m(n)(l.item);b.push({error:f,result:g,index:l.index})}},i=C(1,t).map(()=>new Promise(s)),c=await Promise.all(i),[o,a]=L(S(c.flat(),d=>d.index),d=>!!d.error);if(o.length>0)throw new Z(o.map(d=>d.error));return a.map(d=>d.result)};async function kt(t){const e=w(t)?t.map(s=>[null,s]):Object.entries(t),n=await Promise.all(e.map(([s,i])=>i.then(c=>({result:c,exc:null,key:s})).catch(c=>({result:null,exc:c,key:s})))),r=n.filter(s=>s.exc);if(r.length>0)throw new Z(r.map(s=>s.exc));return w(t)?n.map(s=>s.result):n.reduce((s,i)=>({...s,[i.key]:i.result}),{})}const Ot=async(t,e)=>{const n=t?.times??3,r=t?.delay,s=t?.backoff??null;for(const i of A(1,n)){const[c,o]=await m(e)(a=>{throw{_exited:a}});if(!c)return o;if(c._exited)throw c._exited;if(i===n)throw c;r&&await $(r),s&&await $(s(i))}},$=t=>new Promise(e=>setTimeout(e,t)),m=t=>(...e)=>{try{const n=t(...e);return j(n)?n.then(r=>[void 0,r]).catch(r=>[r,void 0]):[void 0,n]}catch(n){return[n,void 0]}},At=(t,e)=>{const n=s=>{if(e&&!e(s))throw s},r=s=>s instanceof Promise;try{const s=t();return r(s)?s.catch(n):s}catch(s){return n(s)}},Ct=(...t)=>(...e)=>t.slice(1).reduce((n,r)=>r(n),t[0](...e)),$t=(...t)=>t.reverse().reduce((e,n)=>n(e)),Pt=(t,...e)=>(...n)=>t(...e,...n),_t=(t,e)=>n=>t({...e,...n}),Et=t=>new Proxy({},{get:(e,n)=>t(n)}),Nt=(t,e,n,r)=>function(...i){const c=n?n(...i):JSON.stringify({args:i}),o=t[c];if(o!==void 0&&(!o.exp||o.exp>new Date().getTime()))return o.value;const a=e(...i);return t[c]={exp:r?new Date().getTime()+r:null,value:a},a},Tt=(t,e={})=>Nt({},t,e.key??null,e.ttl??null),jt=({delay:t},e)=>{let n,r=!0;const s=(...i)=>{r?(clearTimeout(n),n=setTimeout(()=>{r&&e(...i),n=void 0},t)):e(...i)};return s.isPending=()=>n!==void 0,s.cancel=()=>{r=!1},s.flush=(...i)=>e(...i),s},zt=({interval:t},e)=>{let n=!0,r;const s=(...i)=>{n&&(e(...i),n=!1,r=setTimeout(()=>{n=!0,r=void 0},t))};return s.isThrottled=()=>r!==void 0,s},St=(t,e)=>{const n=()=>{};return new Proxy(Object.assign(n,t),{get:(r,s)=>r[s],set:(r,s,i)=>(r[s]=i,!0),apply:(r,s,i)=>e(Object.assign({},r))(...i)})},Bt=(t,e)=>{const n=e===void 0?0:e;if(t==null)return n;const r=parseFloat(t);return isNaN(r)?n:r},D=(t,e)=>{const n=e===void 0?0:e;if(t==null)return n;const r=parseInt(t);return isNaN(r)?n:r},Lt=(t,e=n=>n===void 0)=>t?Object.keys(t).reduce((r,s)=>(e(t[s])||(r[s]=t[s]),r),{}):{},P=(t,e)=>Object.keys(t).reduce((r,s)=>(r[e(s,t[s])]=t[s],r),{}),Mt=(t,e)=>Object.keys(t).reduce((r,s)=>(r[s]=e(t[s],s),r),{}),Zt=(t,e)=>t?Object.entries(t).reduce((n,[r,s])=>{const[i,c]=e(r,s);return n[i]=c,n},{}):{},Dt=t=>t?Object.keys(t).reduce((n,r)=>(n[t[r]]=r,n),{}):{},Ft=t=>P(t,e=>e.toLowerCase()),Rt=t=>P(t,e=>e.toUpperCase()),F=t=>{if(N(t))return t;if(typeof t=="function")return t.bind({});const e=new t.constructor;return Object.getOwnPropertyNames(t).forEach(n=>{e[n]=t[n]}),e},It=(t,e)=>{if(!t)return[];const n=Object.entries(t);return n.length===0?[]:n.reduce((r,s)=>(r.push(e(s[0],s[1])),r),[])},qt=(t,e)=>t?e.reduce((n,r)=>(Object.prototype.hasOwnProperty.call(t,r)&&(n[r]=t[r]),n),{}):{},vt=(t,e)=>t?!e||e.length===0?t:e.reduce((n,r)=>(delete n[r],n),{...t}):{},R=(t,e,n)=>{const r=e.split(/[\.\[\]]/g);let s=t;for(const i of r){if(s===null||s===void 0)return n;i.trim()!==""&&(s=s[i])}return s===void 0?n:s},I=(t,e,n)=>{if(!t)return{};if(!e||n===void 0)return t;const r=e.split(/[\.\[\]]/g).filter(c=>!!c.trim()),s=c=>{if(r.length>1){const o=r.shift(),a=D(r[0],null)!==null;c[o]=c[o]===void 0?a?[]:{}:c[o],s(c[o])}else c[r[0]]=n},i=F(t);return s(i),i},q=(t,e)=>!t||!e?t??e??{}:Object.entries({...t,...e}).reduce((n,[r,s])=>({...n,[r]:(()=>k(t[r])?q(t[r],s):s)()}),{}),v=t=>{if(!t)return[];const e=(n,r)=>k(n)?Object.entries(n).flatMap(([s,i])=>e(i,[...r,s])):w(n)?n.flatMap((s,i)=>e(s,[...r,`${i}`])):[r.join(".")];return e(t,[])},Ut=t=>t?B(v(t),e=>e,e=>R(t,e)):{},Kt=t=>t?Object.keys(t).reduce((e,n)=>I(e,n,t[n]),{}):{},_=(t,e)=>Math.floor(Math.random()*(e-t+1)+t),Wt=t=>{const e=t.length;if(e===0)return null;const n=_(0,e-1);return t[n]},Jt=t=>t.map(e=>({rand:Math.random(),value:e})).sort((e,n)=>e.rand-n.rand).map(e=>e.value),Xt=(t,e="")=>{const n="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"+e;return M(t,r=>r+n.charAt(_(0,n.length-1)),"")},Yt=(t,e=n=>`${n}`)=>{const{indexesByKey:n,itemsByIndex:r}=t.reduce((l,f,g)=>({indexesByKey:{...l.indexesByKey,[e(f)]:g},itemsByIndex:{...l.itemsByIndex,[g]:f}}),{indexesByKey:{},itemsByIndex:{}}),s=(l,f)=>n[e(l)]n[e(l)]>n[e(f)]?l:f,c=()=>r[0],o=()=>r[t.length-1],a=(l,f)=>r[n[e(l)]+1]??f??c(),d=(l,f)=>r[n[e(l)]-1]??f??o();return{min:s,max:i,first:c,last:o,next:a,previous:d,spin:(l,f)=>{if(f===0)return l;const g=Math.abs(f),ne=g>t.length?g%t.length:g;return C(0,ne-1).reduce(U=>f>0?a(U):d(U),l)}}},p=t=>{if(!t||t.length===0)return"";const e=t.toLowerCase();return e.substring(0,1).toUpperCase()+e.substring(1,e.length)},Ht=t=>{const e=t?.replace(/([A-Z])+/g,p)?.split(/(?=[A-Z])|[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.length===1?e[0]:e.reduce((n,r)=>`${n}${r.charAt(0).toUpperCase()}${r.slice(1)}`)},Qt=(t,e)=>{const n=t?.replace(/([A-Z])+/g,p).split(/(?=[A-Z])|[\.\-\s_]/).map(s=>s.toLowerCase())??[];if(n.length===0)return"";if(n.length===1)return n[0];const r=n.reduce((s,i)=>`${s}_${i.toLowerCase()}`);return e?.splitOnNumber===!1?r:r.replace(/([A-Za-z]{1}[0-9]{1})/,s=>`${s[0]}_${s[1]}`)},Vt=t=>{const e=t?.replace(/([A-Z])+/g,p)?.split(/(?=[A-Z])|[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.length===1?e[0]:e.reduce((n,r)=>`${n}-${r.toLowerCase()}`)},Gt=t=>{const e=t?.split(/[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.map(n=>n.charAt(0).toUpperCase()+n.slice(1)).join("")},xt=t=>t?t.split(/(?=[A-Z])|[\.\-\s_]/).map(e=>e.trim()).filter(e=>!!e).map(e=>p(e.toLowerCase())).join(" "):"",te=(t,e,n=/\{\{(.+?)\}\}/g)=>Array.from(t.matchAll(n)).reduce((r,s)=>r.replace(s[0],e[s[1]]),t),ee=(t,e=" ")=>{if(!t)return"";const n=e.replace(/[\W]{1}/g,"\\$&"),r=new RegExp(`^[${n}]+|[${n}]+$`,"g");return t.replace(r,"")};return u.all=kt,u.alphabetical=tt,u.assign=q,u.boil=O,u.callable=St,u.camel=Ht,u.capitalize=p,u.chain=Ct,u.clone=F,u.cluster=it,u.compose=$t,u.construct=Kt,u.counting=et,u.crush=Ut,u.dash=Vt,u.debounce=jt,u.defer=pt,u.diff=ht,u.draw=Wt,u.first=G,u.flat=ot,u.fork=L,u.get=R,u.group=Y,u.guard=At,u.intersects=lt,u.invert=Dt,u.isArray=w,u.isDate=T,u.isEmpty=X,u.isEqual=z,u.isFloat=J,u.isFunction=y,u.isInt=W,u.isNumber=h,u.isObject=k,u.isPrimitive=N,u.isPromise=j,u.isString=K,u.isSymbol=E,u.iterate=M,u.keys=v,u.last=x,u.list=C,u.listify=It,u.lowerize=Ft,u.map=yt,u.mapEntries=Zt,u.mapKeys=P,u.mapValues=Mt,u.max=st,u.memo=Tt,u.merge=ft,u.min=ut,u.objectify=B,u.omit=vt,u.parallel=bt,u.partial=Pt,u.partob=_t,u.pascal=Gt,u.pick=qt,u.proxied=Et,u.random=_,u.range=A,u.reduce=wt,u.replace=nt,u.replaceOrAppend=at,u.retry=Ot,u.select=rt,u.series=Yt,u.set=I,u.shake=Lt,u.shift=mt,u.shuffle=Jt,u.sift=gt,u.sleep=$,u.snake=Qt,u.sort=S,u.sum=V,u.template=te,u.throttle=zt,u.title=xt,u.toFloat=Bt,u.toInt=D,u.toggle=dt,u.trim=ee,u.try=m,u.tryit=m,u.uid=Xt,u.unique=ct,u.upperize=Rt,u.zip=H,u.zipToObject=Q,u}({}); +var radash=function(c){"use strict";const E=t=>!!t&&t.constructor===Symbol,w=Array.isArray,k=t=>!!t&&t.constructor===Object,N=t=>t==null||typeof t!="object"&&typeof t!="function",y=t=>!!(t&&t.constructor&&t.call&&t.apply),K=t=>typeof t=="string"||t instanceof String,W=t=>h(t)&&t%1===0,J=t=>h(t)&&t%1!==0,h=t=>{try{return Number(t)===t}catch{return!1}},T=t=>Object.prototype.toString.call(t)==="[object Date]",j=t=>!(!t||!t.then||!y(t.then)),X=t=>{if(t===!0||t===!1||t==null)return!0;if(h(t))return t===0;if(T(t))return isNaN(t.getTime());if(y(t)||E(t))return!1;const e=t.length;if(h(e))return e===0;const n=t.size;return h(n)?n===0:Object.keys(t).length===0},z=(t,e)=>{if(Object.is(t,e))return!0;if(t instanceof Date&&e instanceof Date)return t.getTime()===e.getTime();if(t instanceof RegExp&&e instanceof RegExp)return t.toString()===e.toString();if(typeof t!="object"||t===null||typeof e!="object"||e===null)return!1;const n=Reflect.ownKeys(t),r=Reflect.ownKeys(e);if(n.length!==r.length)return!1;for(let s=0;st.reduce((n,r)=>{const s=e(r);return n[s]||(n[s]=[]),n[s].push(r),n},{});function H(...t){return!t||!t.length?[]:new Array(Math.max(...t.map(({length:e})=>e))).fill([]).map((e,n)=>t.map(r=>r[n]))}function Q(t,e){if(!t||!t.length)return{};const n=y(e)?e:w(e)?(r,s)=>e[s]:(r,s)=>e;return t.reduce((r,s,i)=>(r[s]=n(s,i),r),{})}const O=(t,e)=>!t||(t.length??0)===0?null:t.reduce(e),V=(t,e)=>(t||[]).reduce((n,r)=>n+(e?e(r):r),0),G=(t,e=void 0)=>t?.length>0?t[0]:e,x=(t,e=void 0)=>t?.length>0?t[t.length-1]:e,S=(t,e,n=!1)=>{if(!t)return[];const r=(i,u)=>e(i)-e(u),s=(i,u)=>e(u)-e(i);return t.slice().sort(n===!0?s:r)},tt=(t,e,n="asc")=>{if(!t)return[];const r=(i,u)=>`${e(i)}`.localeCompare(e(u)),s=(i,u)=>`${e(u)}`.localeCompare(e(i));return t.slice().sort(n==="desc"?s:r)},et=(t,e)=>t?t.reduce((n,r)=>{const s=e(r);return n[s]=(n[s]??0)+1,n},{}):{},nt=(t,e,n)=>{if(!t)return[];if(e===void 0)return[...t];for(let r=0;rr)=>t.reduce((r,s)=>(r[e(s)]=n(s),r),{}),rt=(t,e,n)=>t?t.reduce((r,s,i)=>(n(s,i)&&r.push(e(s,i)),r),[]):[];function st(t,e){const n=e??(r=>r);return O(t,(r,s)=>n(r)>n(s)?r:s)}function ct(t,e){const n=e??(r=>r);return O(t,(r,s)=>n(r){const n=Math.ceil(t.length/e);return new Array(n).fill(null).map((r,s)=>t.slice(s*e,s*e+e))},ut=(t,e)=>{const n=t.reduce((r,s)=>{const i=e?e(s):s;return r[i]||(r[i]=s),r},{});return Object.values(n)};function*A(t,e,n=s=>s,r=1){const s=y(n)?n:()=>n,i=e?t:0,u=e??t;for(let o=i;o<=u&&(yield s(o),!(o+r>u));o+=r);}const C=(t,e,n,r)=>Array.from(A(t,e,n,r)),ot=t=>t.reduce((e,n)=>(e.push(...n),e),[]),lt=(t,e,n)=>{if(!t||!e)return!1;const r=n??(i=>i),s=e.reduce((i,u)=>(i[r(u)]=!0,i),{});return t.some(i=>s[r(i)])},v=(t,e)=>t?t.reduce((n,r)=>{const[s,i]=n;return e(r)?[[...s,r],i]:[s,[...i,r]]},[[],[]]):[[],[]],ft=(t,e,n)=>!e&&!t?[]:e?t?n?t.reduce((r,s)=>{const i=e.find(u=>n(s)===n(u));return i?r.push(i):r.push(s),r},[]):t:[]:t,at=(t,e,n)=>{if(!t&&!e)return[];if(!e)return[...t];if(!t)return[e];for(let r=0;r{if(!t&&!e)return[];if(!t)return[e];if(!e)return[...t];const s=n?(o,a)=>n(o,a)===n(e,a):o=>o===e;return t.find(s)?t.filter((o,a)=>!s(o,a)):(r?.strategy??"append")==="append"?[...t,e]:[e,...t]},gt=t=>t?.filter(e=>!!e)??[],B=(t,e,n)=>{let r=n;for(let s=1;s<=t;s++)r=e(r,s);return r},ht=(t,e,n=r=>r)=>{if(!t?.length&&!e?.length)return[];if(t?.length===void 0)return[...e];if(!e?.length)return[...t];const r=e.reduce((s,i)=>(s[n(i)]=!0,s),{});return t.filter(s=>!r[n(s)])};function mt(t,e){if(t.length===0)return t;const n=e%t.length;return n===0?t:[...t.slice(-n,t.length),...t.slice(0,-n)]}function wt(t,e){const n=[];let r=0;for(const s of t){const i=e(s,r);i!==void 0&&n.push(i),r+=1}return n}function yt(t,e){let n=0;for(const r of t){const s=e(r,n);if(s!==void 0)return s;n+=1}}const pt=async(t,e,n)=>{const r=n!==void 0;if(!r&&t?.length<1)throw new Error("Cannot reduce empty array with no init value");const s=r?t:t.slice(1);let i=r?n:t[0];for(const[u,o]of s.entries())i=await e(i,o,u);return i},bt=async(t,e)=>{if(!t)return[];let n=[],r=0;for(const s of t){const i=await e(s,r++);n.push(i)}return n},kt=async t=>{const e=[],n=(i,u)=>e.push({fn:i,rethrow:u?.rethrow??!1}),[r,s]=await m(t)(n);for(const{fn:i,rethrow:u}of e){const[o]=await m(i)(r);if(o&&u)throw o}if(r)throw r;return s};class L extends Error{constructor(e=[]){super();const n=e.find(r=>r.name)?.name??"";this.name=`AggregateError(${n}...)`,this.message=`AggregateError with ${e.length} errors`,this.stack=e.find(r=>r.stack)?.stack??this.stack,this.errors=e}}const Ot=async(t,e,n)=>{const r=e.map((d,b)=>({index:b,item:d})),s=async d=>{const b=[];for(;;){const l=r.pop();if(!l)return d(b);const[f,g]=await m(n)(l.item);b.push({error:f,result:g,index:l.index})}},i=C(1,t).map(()=>new Promise(s)),u=await Promise.all(i),[o,a]=v(S(u.flat(),d=>d.index),d=>!!d.error);if(o.length>0)throw new L(o.map(d=>d.error));return a.map(d=>d.result)};async function At(t){const e=w(t)?t.map(s=>[null,s]):Object.entries(t),n=await Promise.all(e.map(([s,i])=>i.then(u=>({result:u,exc:null,key:s})).catch(u=>({result:null,exc:u,key:s})))),r=n.filter(s=>s.exc);if(r.length>0)throw new L(r.map(s=>s.exc));return w(t)?n.map(s=>s.result):n.reduce((s,i)=>({...s,[i.key]:i.result}),{})}const Ct=async(t,e)=>{const n=t?.times??3,r=t?.delay,s=t?.backoff??null;for(const i of A(1,n)){const[u,o]=await m(e)(a=>{throw{_exited:a}});if(!u)return o;if(u._exited)throw u._exited;if(i===n)throw u;r&&await $(r),s&&await $(s(i))}},$=t=>new Promise(e=>setTimeout(e,t)),m=t=>(...e)=>{try{const n=t(...e);return j(n)?n.then(r=>[void 0,r]).catch(r=>[r,void 0]):[void 0,n]}catch(n){return[n,void 0]}},$t=(t,e)=>{const n=s=>{if(e&&!e(s))throw s},r=s=>s instanceof Promise;try{const s=t();return r(s)?s.catch(n):s}catch(s){return n(s)}},Pt=(...t)=>(...e)=>t.slice(1).reduce((n,r)=>r(n),t[0](...e)),_t=(...t)=>t.reverse().reduce((e,n)=>n(e)),Et=(t,...e)=>(...n)=>t(...e,...n),Nt=(t,e)=>n=>t({...e,...n}),Tt=t=>new Proxy({},{get:(e,n)=>t(n)}),jt=(t,e,n,r)=>function(...i){const u=n?n(...i):JSON.stringify({args:i}),o=t[u];if(o!==void 0&&(!o.exp||o.exp>new Date().getTime()))return o.value;const a=e(...i);return t[u]={exp:r?new Date().getTime()+r:null,value:a},a},zt=(t,e={})=>jt({},t,e.key??null,e.ttl??null),St=({delay:t},e)=>{let n,r=!0;const s=(...i)=>{r?(clearTimeout(n),n=setTimeout(()=>{r&&e(...i),n=void 0},t)):e(...i)};return s.isPending=()=>n!==void 0,s.cancel=()=>{r=!1},s.flush=(...i)=>e(...i),s},Ft=({interval:t},e)=>{let n=!0,r;const s=(...i)=>{n&&(e(...i),n=!1,r=setTimeout(()=>{n=!0,r=void 0},t))};return s.isThrottled=()=>r!==void 0,s},vt=(t,e)=>{const n=()=>{};return new Proxy(Object.assign(n,t),{get:(r,s)=>r[s],set:(r,s,i)=>(r[s]=i,!0),apply:(r,s,i)=>e(Object.assign({},r))(...i)})},Bt=(t,e)=>{const n=e===void 0?0:e;if(t==null)return n;const r=parseFloat(t);return isNaN(r)?n:r},M=(t,e)=>{const n=e===void 0?0:e;if(t==null)return n;const r=parseInt(t);return isNaN(r)?n:r},Lt=(t,e=n=>n===void 0)=>t?Object.keys(t).reduce((r,s)=>(e(t[s])||(r[s]=t[s]),r),{}):{},P=(t,e)=>Object.keys(t).reduce((r,s)=>(r[e(s,t[s])]=t[s],r),{}),Mt=(t,e)=>Object.keys(t).reduce((r,s)=>(r[s]=e(t[s],s),r),{}),Zt=(t,e)=>t?Object.entries(t).reduce((n,[r,s])=>{const[i,u]=e(r,s);return n[i]=u,n},{}):{},Dt=t=>t?Object.keys(t).reduce((n,r)=>(n[t[r]]=r,n),{}):{},Rt=t=>P(t,e=>e.toLowerCase()),It=t=>P(t,e=>e.toUpperCase()),Z=t=>{if(N(t))return t;if(typeof t=="function")return t.bind({});const e=new t.constructor;return Object.getOwnPropertyNames(t).forEach(n=>{e[n]=t[n]}),e},qt=(t,e)=>{if(!t)return[];const n=Object.entries(t);return n.length===0?[]:n.reduce((r,s)=>(r.push(e(s[0],s[1])),r),[])},Ut=(t,e)=>t?e.reduce((n,r)=>(Object.prototype.hasOwnProperty.call(t,r)&&(n[r]=t[r]),n),{}):{},Kt=(t,e)=>t?!e||e.length===0?t:e.reduce((n,r)=>(delete n[r],n),{...t}):{},D=(t,e,n)=>{const r=e.split(/[\.\[\]]/g);let s=t;for(const i of r){if(s===null||s===void 0)return n;i.trim()!==""&&(s=s[i])}return s===void 0?n:s},R=(t,e,n)=>{if(!t)return{};if(!e||n===void 0)return t;const r=e.split(/[\.\[\]]/g).filter(u=>!!u.trim()),s=u=>{if(r.length>1){const o=r.shift(),a=M(r[0],null)!==null;u[o]=u[o]===void 0?a?[]:{}:u[o],s(u[o])}else u[r[0]]=n},i=Z(t);return s(i),i},I=(t,e)=>!t||!e?t??e??{}:Object.entries({...t,...e}).reduce((n,[r,s])=>({...n,[r]:(()=>k(t[r])?I(t[r],s):s)()}),{}),q=t=>{if(!t)return[];const e=(n,r)=>k(n)?Object.entries(n).flatMap(([s,i])=>e(i,[...r,s])):w(n)?n.flatMap((s,i)=>e(s,[...r,`${i}`])):[r.join(".")];return e(t,[])},Wt=t=>t?F(q(t),e=>e,e=>D(t,e)):{},Jt=t=>t?Object.keys(t).reduce((e,n)=>R(e,n,t[n]),{}):{},_=(t,e)=>Math.floor(Math.random()*(e-t+1)+t),Xt=t=>{const e=t.length;if(e===0)return null;const n=_(0,e-1);return t[n]},Yt=t=>t.map(e=>({rand:Math.random(),value:e})).sort((e,n)=>e.rand-n.rand).map(e=>e.value),Ht=(t,e="")=>{const n="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"+e;return B(t,r=>r+n.charAt(_(0,n.length-1)),"")},Qt=(t,e=n=>`${n}`)=>{const{indexesByKey:n,itemsByIndex:r}=t.reduce((l,f,g)=>({indexesByKey:{...l.indexesByKey,[e(f)]:g},itemsByIndex:{...l.itemsByIndex,[g]:f}}),{indexesByKey:{},itemsByIndex:{}}),s=(l,f)=>n[e(l)]n[e(l)]>n[e(f)]?l:f,u=()=>r[0],o=()=>r[t.length-1],a=(l,f)=>r[n[e(l)]+1]??f??u(),d=(l,f)=>r[n[e(l)]-1]??f??o();return{min:s,max:i,first:u,last:o,next:a,previous:d,spin:(l,f)=>{if(f===0)return l;const g=Math.abs(f),se=g>t.length?g%t.length:g;return C(0,se-1).reduce(U=>f>0?a(U):d(U),l)}}},p=t=>{if(!t||t.length===0)return"";const e=t.toLowerCase();return e.substring(0,1).toUpperCase()+e.substring(1,e.length)},Vt=t=>{const e=t?.replace(/([A-Z])+/g,p)?.split(/(?=[A-Z])|[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.length===1?e[0]:e.reduce((n,r)=>`${n}${r.charAt(0).toUpperCase()}${r.slice(1)}`)},Gt=(t,e)=>{const n=t?.replace(/([A-Z])+/g,p).split(/(?=[A-Z])|[\.\-\s_]/).map(s=>s.toLowerCase())??[];if(n.length===0)return"";if(n.length===1)return n[0];const r=n.reduce((s,i)=>`${s}_${i.toLowerCase()}`);return e?.splitOnNumber===!1?r:r.replace(/([A-Za-z]{1}[0-9]{1})/,s=>`${s[0]}_${s[1]}`)},xt=t=>{const e=t?.replace(/([A-Z])+/g,p)?.split(/(?=[A-Z])|[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.length===1?e[0]:e.reduce((n,r)=>`${n}-${r.toLowerCase()}`)},te=t=>{const e=t?.split(/[\.\-\s_]/).map(n=>n.toLowerCase())??[];return e.length===0?"":e.map(n=>n.charAt(0).toUpperCase()+n.slice(1)).join("")},ee=t=>t?t.split(/(?=[A-Z])|[\.\-\s_]/).map(e=>e.trim()).filter(e=>!!e).map(e=>p(e.toLowerCase())).join(" "):"",ne=(t,e,n=/\{\{(.+?)\}\}/g)=>Array.from(t.matchAll(n)).reduce((r,s)=>r.replace(s[0],e[s[1]]),t),re=(t,e=" ")=>{if(!t)return"";const n=e.replace(/[\W]{1}/g,"\\$&"),r=new RegExp(`^[${n}]+|[${n}]+$`,"g");return t.replace(r,"")};return c.all=At,c.alphabetical=tt,c.assign=I,c.boil=O,c.callable=vt,c.camel=Vt,c.capitalize=p,c.chain=Pt,c.clone=Z,c.cluster=it,c.collect=wt,c.collectFirst=yt,c.compose=_t,c.construct=Jt,c.counting=et,c.crush=Wt,c.dash=xt,c.debounce=St,c.defer=kt,c.diff=ht,c.draw=Xt,c.first=G,c.flat=ot,c.fork=v,c.get=D,c.group=Y,c.guard=$t,c.intersects=lt,c.invert=Dt,c.isArray=w,c.isDate=T,c.isEmpty=X,c.isEqual=z,c.isFloat=J,c.isFunction=y,c.isInt=W,c.isNumber=h,c.isObject=k,c.isPrimitive=N,c.isPromise=j,c.isString=K,c.isSymbol=E,c.iterate=B,c.keys=q,c.last=x,c.list=C,c.listify=qt,c.lowerize=Rt,c.map=bt,c.mapEntries=Zt,c.mapKeys=P,c.mapValues=Mt,c.max=st,c.memo=zt,c.merge=ft,c.min=ct,c.objectify=F,c.omit=Kt,c.parallel=Ot,c.partial=Et,c.partob=Nt,c.pascal=te,c.pick=Ut,c.proxied=Tt,c.random=_,c.range=A,c.reduce=pt,c.replace=nt,c.replaceOrAppend=at,c.retry=Ct,c.select=rt,c.series=Qt,c.set=R,c.shake=Lt,c.shift=mt,c.shuffle=Yt,c.sift=gt,c.sleep=$,c.snake=Gt,c.sort=S,c.sum=V,c.template=ne,c.throttle=Ft,c.title=ee,c.toFloat=Bt,c.toInt=M,c.toggle=dt,c.trim=re,c.try=m,c.tryit=m,c.uid=Ht,c.unique=ut,c.upperize=It,c.zip=H,c.zipToObject=Q,c}({}); diff --git a/docs/array/collect.mdx b/docs/array/collect.mdx new file mode 100644 index 00000000..236f3dae --- /dev/null +++ b/docs/array/collect.mdx @@ -0,0 +1,31 @@ +--- +title: collect +group: 'Array' +description: Map+filter operation where undefined transformations are filtered out +--- + +## Basic usage + +Given an array and a transform function, returns a new array +with each transformed element that does not evaluate to undefined. + +```ts +import { collect } from 'radash' + +const gods = [ + { + name: 'Ra', + culture: 'egypt' + }, + { + name: 'Zeus', + culture: 'greek' + }, + { + name: 'Loki', + culture: 'greek' + } +] + +collect(gods, g => (g.culture === 'greek' ? g.name.toUpperCase() : undefined)) // => ['ZEUS', 'LOKI'] +``` diff --git a/docs/array/collectFirst.mdx b/docs/array/collectFirst.mdx new file mode 100644 index 00000000..03c2e50a --- /dev/null +++ b/docs/array/collectFirst.mdx @@ -0,0 +1,33 @@ +--- +title: collectFirst +group: 'Array' +description: Map+find operation where the first defined transformation is returned +--- + +## Basic usage + +Given an array and a transform function, immediately returns the first +transformed element that does not evaluate to undefined. + +```ts +import { collectFirst } from 'radash' + +const gods = [ + { + name: 'Ra', + culture: 'egypt' + }, + { + name: 'Zeus', + culture: 'greek' + }, + { + name: 'Loki', + culture: 'greek' + } +] + +collectFirst(gods, g => + g.culture === 'greek' ? g.name.toUpperCase() : undefined +) // => 'ZEUS' +``` diff --git a/package.json b/package.json index 0c109b57..28b185a9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "radash", - "version": "11.0.0", + "version": "11.1.0", "description": "Functional utility library - modern, simple, typed, powerful", "main": "dist/cjs/index.cjs", "module": "dist/esm/index.mjs", diff --git a/src/array.ts b/src/array.ts index 60db772e..195fcce3 100644 --- a/src/array.ts +++ b/src/array.ts @@ -548,3 +548,50 @@ export function shift(arr: Array, n: number) { return [...arr.slice(-shiftNumber, arr.length), ...arr.slice(0, -shiftNumber)] } + +/** + * A transform function for collect()/collectFirst() operations. + */ +type CollectTxFunction = (el: T, idx: number) => R | undefined + +/** + * Transform and return every element for which the tx function returns a defined value. + * + * @param arr the array of inputs to process + * @param tx the transform function + * @returns a new array containing all transformed elements which are not undefined. + */ +export function collect(arr: T[], tx: CollectTxFunction): R[] { + const res: R[] = [] + let idx = 0 + for (const el of arr) { + const transformed = tx(el, idx) + if (transformed !== undefined) { + res.push(transformed) + } + idx += 1 + } + return res +} + +/** + * Transform and immediately return the first element for which the tx function returns a defined value. + * + * @param arr the array of inputs to process + * @param tx the transform function + * @returns the first transformed element which is not undefined; else, undefined + */ +export function collectFirst( + arr: T[], + tx: CollectTxFunction +): R | undefined { + let idx = 0 + for (const el of arr) { + const transformed = tx(el, idx) + if (transformed !== undefined) { + return transformed + } + idx += 1 + } + return undefined +} diff --git a/src/index.ts b/src/index.ts index 6c0f6068..b1fb0398 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,6 +2,8 @@ export { alphabetical, boil, cluster, + collect, + collectFirst, counting, diff, first, diff --git a/src/tests/array.test.ts b/src/tests/array.test.ts index 92a177c2..52c47c03 100644 --- a/src/tests/array.test.ts +++ b/src/tests/array.test.ts @@ -777,4 +777,60 @@ describe('array module', () => { assert.deepEqual(result, ['b', 'a']) }) }) + + describe('collect function', () => { + test('should return all defined transformations', () => { + const arr = [{ num: 3 }, { num: -4 }, { num: -5 }] + const res = _.collect(arr, el => (el.num < 0 ? el.num * -1 : undefined)) + assert.deepEqual(res, [4, 5]) + }) + + test('should return empty list when no transformations defined', () => { + const arr = [{ num: 3 }, { num: -4 }, { num: -5 }] + const res = _.collect(arr, el => (el.num > 999 ? el.num * -1 : undefined)) + assert.deepEqual(res, []) + }) + + test('should return falsy transformations other than undefined', () => { + const arr = [ + { val: null }, + { val: '' }, + { val: 0 }, + { val: false }, + { val: undefined } + ] + const res = _.collect(arr, el => el.val) + assert.deepEqual(res, [null, '', 0, false]) + }) + }) + + describe('collectFirst function', () => { + test('should return the first defined transformation', () => { + const arr = [{ num: 3 }, { num: -4 }, { num: -5 }] + const res = _.collectFirst(arr, el => + el.num < 0 ? el.num * -1 : undefined + ) + assert.equal(res, 4) + }) + + test('shoudl return undefined when no transformations are defined', () => { + const arr = [{ num: 3 }, { num: -4 }, { num: -5 }] + const res = _.collectFirst(arr, el => + el.num > 999 ? el.num * -1 : undefined + ) + assert.isUndefined(res) + }) + + test('should return a falsy transformation other than undefined', () => { + const arr = [ + { val: undefined }, + { val: null }, + { val: '' }, + { val: 0 }, + { val: false } + ] + const res = _.collectFirst(arr, el => el.val) + assert.isNull(res) + }) + }) })