Gathering detailed insights and metrics for @hutechwebsite/neque-neque-voluptas-blanditiis
Gathering detailed insights and metrics for @hutechwebsite/neque-neque-voluptas-blanditiis
Installations
npm install @hutechwebsite/neque-neque-voluptas-blanditiisDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
20.12.2
NPM Version
10.5.0
Releases
4
Languages
1
JavaScript
JavaScript (100%)
Developer
hutechwebsite
Download Statistics
Total Downloads
124
Last Day
2
Last Week
5
Last Month
7
Last Year
124
GitHub Statistics
MIT License
2,659 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Apr 04, 2025
Maintainers
1
Package Meta Information
Latest Version
1.0.0
Package Id
@hutechwebsite/neque-neque-voluptas-blanditiis@1.0.0
Unpacked Size
71.88 kB
Size
17.18 kB
File Count
8
NPM Version
10.5.0
Node Version
20.12.2
Published on
May 07, 2024
Total Downloads
Cumulative downloads
Total Downloads
124
Last Day
0%
2
Compared to previous day
Last Week
0%
5
Compared to previous week
Last Month
-30%
7
Compared to previous month
Last Year
0%
124
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
27
@hutechwebsite/ab-quibusdam-pariatur-beatae@hutechwebsite/alias-rerum-dicta-ad@hutechwebsite/autem-delectus-sint-libero@hutechwebsite/beatae-animi-non-optio@hutechwebsite/cupiditate-sint-nam-perspiciatis@hutechwebsite/debitis-magnam-eos-mollitia@hutechwebsite/dignissimos-nesciunt-tempore-omnis@hutechwebsite/doloremque-magnam-quos-officiis@hutechwebsite/eos-laborum-quasi-consequatur@hutechwebsite/fugit-sunt-perspiciatis-assumenda@hutechwebsite/labore-deserunt-doloremque-voluptatum@hutechwebsite/odio-odio-quisquam-nisi@hutechwebsite/odit-nostrum-perferendis-enim@hutechwebsite/porro-velit-nam-alias@hutechwebsite/possimus-architecto-vitae-enim@hutechwebsite/quaerat-consectetur-deleniti-commodi@hutechwebsite/quo-est-iure-quam@hutechwebsite/recusandae-ut-velit-impedit@hutechwebsite/sequi-mollitia-aliquam-blanditiis@hutechwebsite/soluta-eius-nesciunt-a@hutechwebsite/suscipit-natus-veritatis-minima@hutechwebsite/veniam-corporis-architecto-earum@hutechwebsite/voluptate-illum-voluptatem-molestiae@hutechwebsite/voluptates-illum-cupiditate-quoscoding-course-apisaoviet-caculatorsaoviet-caculator-module
@hutechwebsite/neque-neque-voluptas-blanditiis
@hutechwebsite/neque-neque-voluptas-blanditiis is a consistently blazing fast memoization library for JavaScript. It handles multiple parameters (including default values) without any additional configuration, and offers a large number of options to satisfy any number of potential use-cases.
- Importing
- Usage
- Configuration options
- Usage with shortcut methods
- @hutechwebsite/neque-neque-voluptas-blanditiis.deep
- @hutechwebsite/neque-neque-voluptas-blanditiis.infinite
- @hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg
- @hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey
- @hutechwebsite/neque-neque-voluptas-blanditiis.maxAge
- @hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs
- @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize
- @hutechwebsite/neque-neque-voluptas-blanditiis.profile
- @hutechwebsite/neque-neque-voluptas-blanditiis.promise
- @hutechwebsite/neque-neque-voluptas-blanditiis.react
- @hutechwebsite/neque-neque-voluptas-blanditiis.serialize
- @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith
- @hutechwebsite/neque-neque-voluptas-blanditiis.shallow
- @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs
- @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey
- useMoize hook
- Composition
- Collecting statistics
- Introspection
- Direct cache manipulation
- Benchmarks
- Filesize
- Browser support
- Development
$ npm i @hutechwebsite/neque-neque-voluptas-blanditiis --save
Importing
ESM in browsers
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis';
ESM in NodeJS
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis/mjs/index.mjs';
CommonJS
1const @hutechwebsite/neque-neque-voluptas-blanditiis = require('@hutechwebsite/neque-neque-voluptas-blanditiis');
Usage
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const method = (a: number, b: number) => a + b; 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(method); 6 7me@hutechwebsite/neque-neque-voluptas-blanditiisd(2, 4); // 6 8me@hutechwebsite/neque-neque-voluptas-blanditiisd(2, 4); // 6, pulled from cache
All parameter types are supported, including circular objects, functions, etc. There are also a number of shortcut methods to me@hutechwebsite/neque-neque-voluptas-blanditiis for unique use-cases.
Configuration options
@hutechwebsite/neque-neque-voluptas-blanditiis optionally accepts an object of options as either the second parameter or as the first step in a curried function:
1// inline 2@hutechwebsite/neque-neque-voluptas-blanditiis(fn, options); 3 4// curried 5@hutechwebsite/neque-neque-voluptas-blanditiis(options)(fn);
The full shape of these options:
1type Options = { 2 // is the cache based on deep equality of each key argument 3 isDeepEqual: boolean; 4 // is the result a promise 5 isPromise: boolean; 6 // is the result a React component 7 isReact: boolean; 8 // should the parameters be serialized instead of directly referenced 9 isSerialized: boolean; 10 // is the cache based on shallow equality of each key argument 11 isShallowEqual: boolean; 12 // custom method to compare equality between two key arguments 13 matchesArg: (cachedKeyArg: any, keyArg: any) => boolean; 14 // custom method to compare equality across all key arguments 15 matchesKey: (cachedKey: any[], key: any[]) => boolean; 16 // amount of time in milliseconds before the cache will expire 17 maxAge: number; 18 // maximum number of arguments passed to use as key for caching 19 maxArgs: number; 20 // maximum size of cache for this method 21 maxSize: number; 22 // method fired when a new entry is added to cache 23 onCacheAdd: ( 24 cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache, 25 options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options, 26 @hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any 27 ) => void; 28 // method fire when either a new entry is added to cache or the LRU ordering of the cache has changed 29 onCacheChange: ( 30 cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache, 31 options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options, 32 @hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any 33 ) => void; 34 // method fired when an existing entry in cache is used 35 onCacheHit: ( 36 cache: @hutechwebsite/neque-neque-voluptas-blanditiis.Cache, 37 options: @hutechwebsite/neque-neque-voluptas-blanditiis.Options, 38 @hutechwebsite/neque-neque-voluptas-blanditiisd: (...args: any[]) => any 39 ) => void; 40 // method to fire when a cache entry expires (in combination with maxAge) 41 onExpire: (key: any[]) => void; 42 // the unique identifier to give the me@hutechwebsite/neque-neque-voluptas-blanditiisd method when collecting statistics 43 profileName: string; 44 // method to serialize the arguments to build a unique cache key 45 serializer: (key: any[]) => string; 46 // method to transform the args into a custom format for key storage in cache 47 transformArgs: (key: any[]) => any[]; 48 // should the cache entry be refreshed by calling the underlying function with the same parameters and 49 // updating the value stored in cache to be the new result 50 updateCacheForKey: (key: any[]) => boolean; 51 // should the cache entry's expiration be refreshed when the cache entry is hit (in combination with maxAge) 52 updateExpire: boolean; 53};
All default values can be found here.
isDeepEqual
defaults to false
Should deep equality be used to compare cache each key argument.
1type Arg = { 2 one: { 3 nested: string; 4 }; 5 two: string; 6}; 7 8const fn = ({ one, two }: Arg) => [one, two]; 9 10const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { isDeepEqual: true }); 11 12me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: { nested: 'one' }, two: 'two' }); 13me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: { nested: 'one' }, two: 'two' }); // pulls from cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.deep
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.deep(fn);
isPromise
defaults to false
Is the computed value in the function a Promise.
1const fn = async (item: Promise<string>) => await item; 2 3const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { isPromise: true });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.promise.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = -@hutechwebsite/neque-neque-voluptas-blanditiis.promise(fn);
The Promise itself will be stored in cache, so that cached returns will always maintain the Promise contract. For common usage reasons, if the Promise is rejected, the cache entry will be deleted.
isReact
defaults to false
Is the function passed a stateless functional React component.
1type Props = { 2 one: string; 3 two: number; 4}; 5 6const Component = ({ one, two }: Props) => ( 7 <div> 8 {one}: {two} 9 </div> 10); 11 12const Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo = @hutechwebsite/neque-neque-voluptas-blanditiis(Component, { isReact: true });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.react.
1const Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo = @hutechwebsite/neque-neque-voluptas-blanditiis.react(Component);
The method will do a shallow equal comparison of both props and legacy context of the component based on strict equality. If you want to do a deep equals comparison, set isDeepEqual to true.
NOTE: This will me@hutechwebsite/neque-neque-voluptas-blanditiis on each instance of the component passed, which is equivalent to PureComponent or React.memo. If you want to
me@hutechwebsite/neque-neque-voluptas-blanditiis on all instances (which is how this option worked prior to version 6), use the following options:
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(Component, { isShallowEqual: true, maxArgs: 2 });
isSerialized
defaults to false
Serializes the parameters passed into a string and uses this as the key for cache comparison.
1const fn = (mutableObject: { one: Record<string, any> }) => 2 mutableObject.property; 3 4const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { isSerialized: true });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.serialize.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.serialize(fn);
If serialize is combined with either maxArgs or transformArgs, the following order is used:
- limit by
maxArgs(if applicable) - transform by
transformArgs(if applicable) - serialize by
serializer
NOTE: This is much slower than the default key storage, and usually the same requirements can be meet with isDeepEqual, so use at your discretion.
isShallowEqual
defaults to false
Should shallow equality be used to compare cache each key argument.
1type Arg = { 2 one: string; 3 two: string; 4}; 5 6const fn = ({ one, two }: Arg) => [one, two]; 7 8const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { isShallowEqual: true }); 9 10me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: 'one', two: 'two' }); 11me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: 'one', two: 'two' }); // pulls from cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.shallow
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.shallow(fn);
matchesArg
defaults to SameValueZero equality
Custom method used to compare equality of keys for cache purposes by comparing each argument.
1type Arg = { 2 one: string; 3 two: string; 4}; 5 6const fn = ({ one, two }: Arg) => [one, two]; 7 8const hasOneProperty = (cacheKeyArg: Arg, keyArg: Arg) => 9 Object.keys(cacheKeyArg).length === 1 && Object.keys(keyArg).length === 1; 10 11const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { matchesArg: hasOneProperty }); 12 13me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: 'two' }; 14me@hutechwebsite/neque-neque-voluptas-blanditiisd({ two: 'three' }); // pulls from cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg(hasOneProperty)(fn);
NOTE: This comparison is used iteratively on each argument, rather than comparing the two keys as a whole. If you want to compare the key as a whole, you should use matchesKey.
matchesKey
Custom method used to compare equality of keys for cache purposes by comparing the entire key.
1type Arg = { 2 one: string; 3 two: string; 4}; 5 6const fn = ({ one, two }: Arg) => [one, two]; 7 8const isFooEqualAndHasBar = (cacheKey: [Arg], key: [Arg]) => 9 cacheKey[0].one === key[0].one && 10 cacheKey[1].hasOwnProperty('two') && 11 key[1].hasOwnProperty('two'); 12 13const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { matchesKey: isFooEqualAndHasBar }); 14 15me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: 'two' }, { two: null }); 16me@hutechwebsite/neque-neque-voluptas-blanditiisd({ one: 'two' }, { two: 'three' }); // pulls from cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey(isFooEqualAndHasBar)(fn);
NOTE: This comparison uses the two keys as a whole, which is usually less performant than the matchArg comparison used iteratively on each argument. Generally speaking you should use the matchArg option for equality comparison.
maxAge
The maximum amount of time in milliseconds that you want a computed value to be stored in cache for this method.
1const fn = (item: Record<string, any>) => item; 2 3const MAX_AGE = 1000 * 60 * 5; // five minutes; 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxAge: MAX_AGE });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.maxAge.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxAge(MAX_AGE)(fn);
TIP: A common usage of this is in tandem with isPromise for AJAX calls, and in that scenario the expected behavior is usually to have the maxAge countdown begin upon resolution of the promise. If this is your intended use case, you should also apply the updateExpire option.
maxArgs
The maximum number of arguments (starting from the first) used in creating the key for the cache.
1const fn = (item1: string, item2: string, item3: string) => 2 item1 + item2 + item3; 3 4const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxArgs: 2 }); 5 6me@hutechwebsite/neque-neque-voluptas-blanditiis('one', 'two', 'three'); 7me@hutechwebsite/neque-neque-voluptas-blanditiis('one', 'two', 'four'); // pulls from cache, as the first two args are the same
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs(2)(fn);
If maxArgs is combined with either serialize or transformArgs, the following order is used:
- limit by
maxArgs - transform by
transformArgs(if applicable) - serialize by
serializer(if applicable)
maxSize
defaults to 1
The maximum number of values you want stored in cache for this method. Clearance of the cache once the maxSize is reached is on a Least Recently Used basis.
1const fn = (item: string) => item; 2 3const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxSize: 5 });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5)(fn);
onCacheAdd
Method to fire when an item has been added to cache. Receives the cache, options, and me@hutechwebsite/neque-neque-voluptas-blanditiisd function as a parameters.
1const fn = (one: string, two: string) => [one, two]; 2 3const logCacheKeys = ( 4 cache: Cache, 5 options: Options, 6 @hutechwebsite/neque-neque-voluptas-blanditiisd: Moized<typeof fn> 7) => console.log(cache.keys); 8 9const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxSize: 2, onCacheAdd: logCacheKeys }); 10 11@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); // [["one","two"]] 12@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 13@hutechwebsite/neque-neque-voluptas-blanditiisd('two', 'one'); // [["two","one"], ["one","two"]] 14@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two');
NOTE: When combined with onCacheChange, this method will always fire first.
onCacheChange
Method to fire when an item has been either added to cache, or existing cache was reordered based on a cache hit. Receives the cache, options, and me@hutechwebsite/neque-neque-voluptas-blanditiisd function as a parameters.
1const fn = (one: string, two: string) => [one, two]; 2 3const logCacheKeys = ( 4 cache: Cache, 5 options: Options, 6 @hutechwebsite/neque-neque-voluptas-blanditiisd: Moized<typeof fn> 7) => console.log(cache.keys); 8 9const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxSize: 2, onCacheChange: logCacheKeys }); 10 11@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); // [["one","two"]] 12@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 13@hutechwebsite/neque-neque-voluptas-blanditiisd('two', 'one'); // [["two","one"], ["one","two"]] 14@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); // [["one","two"], ["two","one"]]
NOTE: When combined with onCacheAdd or onCacheHit, this method will always fire last.
onCacheHit
Method to fire when an existing cache item is found. Receives the cache, options, and me@hutechwebsite/neque-neque-voluptas-blanditiisd function as a parameters.
1const fn = (one: string, two: string) => [one, two]; 2 3const logCacheKeys = ( 4 cache: Cache, 5 options: Options, 6 @hutechwebsite/neque-neque-voluptas-blanditiisd: Moized<typeof fn> 7) => console.log(cache.keys); 8 9const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxSize: 2, onCacheHit: logCacheKeys }); 10 11@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 12@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); // [["one","two"]] 13@hutechwebsite/neque-neque-voluptas-blanditiisd('two', 'one'); 14@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); // [["two","one"], ["one","two"]]
NOTE: When combined with onCacheChange, this method will always fire first.
onExpire
A callback that is called when the cached entry expires.
1const fn = (item: string) => item; 2 3const logKey = (key: Key<string>) => console.log(key); 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxAge: 10000, onExpire: logKey });
If you return false from this method, it will prevent the key's removal and refresh the expiration in the same vein as updateExpire based on maxAge:
1const fn = (item: string) => item; 2 3let expirationAttempts = 0; 4 5const limitExpirationAttempts = (key: Key<string>) => { 6 expirationAttempts += 1; 7 8 return expirationAttempts < 2; 9}; 10 11const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { 12 maxAge: 10000, 13 onExpire: limitExpirationAttempts, 14}); 15 16me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); // will expire key after 30 seconds, or 3 expiration attempts
NOTE: You must set a maxAge for this option to take effect.
profileName
defaults to function name when it exists, or Anonymous {count} otherwise
Name to use as unique identifier for the function when collecting statistics.
1@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); 2 3const fn = (item: string) => item; 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { profileName: 'my fancy identity' });
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.profile.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.profile('profile-name')(fn);
NOTE: You must be collecting statistics for this option to provide value, as it is the identifier used for statistics collection.
serializer
defaults to serializeArguments in utils.js
Method used in place of the internal serializer when serializing the parameters for cache key comparison. The function accepts a single argument, the Array of args, and must also return an Array.
1const fn = (one: string, two: string) => [one, two]; 2 3const customSerializer = (args: string[]) => [JSON.stringify(args[0])]; 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { 6 isSerialized: true, 7 serializer, 8});
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith(customSerializer)(fn);
NOTE: You must set isSerialized for this option to take effect.
transformArgs
Transform the arguments passed before it is used as a key. The function accepts a single argument, the Array of args, and must also return an Array.
1const fn = (one: string | null, two: string | null, three: string | null) => [ 2 two, 3 three, 4]; 5 6const ignoreFirstArg = (args: (string | null)[]) => args.slice(1); 7 8const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { transformArgs: ignoreFirstArg }); 9 10@hutechwebsite/neque-neque-voluptas-blanditiis('one', 'two', 'three'); 11@hutechwebsite/neque-neque-voluptas-blanditiis(null, 'two', 'three'); // pulled from cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs(argTransformer)(fn);
If transformArgs is combined with either maxArgs or serialize, the following order is used:
- limit by
maxArgs(if applicable) - transform by
transformArgs - serialize by
serializer(if applicable)
updateCacheForKey
If you want to update the cache for a given key instead of leverage the value currently stored in cache.
1const fn = (item: string) => item; 2 3let lastUpdate = Date.now(); 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { 6 updateCacheForKey([item]: [string]) { 7 const now = Date.now(); 8 const last = lastUpdated; 9 10 lastUpdate = now; 11 12 // its been more than 5 minutes since last update 13 return last + 300000 < now; 14 }, 15}); 16 17me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); 18me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); // pulled from cache 19 20// 5 minutes later 21 22me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); // re-calls method and updates cache
This is also available via the shortcut method of @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey(shouldCacheUpdate)(fn);
updateExpire
When a maxAge is set, clear the scheduled expiration of the key when that key is retrieved, setting a new expiration based on the most recent retrieval from cache.
1const fn = (item: string) => item; 2 3const MAX_AGE = 1000 * 60 * 5; // five minutes 4 5const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn, { maxAge: MAX_AGE, updateExpire: true }); 6 7me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); 8 9setTimeout(() => { 10 /** 11 * hits cache, which updates the expire to be 5 minutes 12 * from this run instead of the first 13 */ 14 me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); 15}, 1000 * 60);
Usage with shortcut methods
@hutechwebsite/neque-neque-voluptas-blanditiis.deep
Pre-applies the isDeepEqual option.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.deep(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.infinite
Pre-applies the maxSize option with Infinity.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.infinite(fn);
NOTE: This mimics default behavior of @hutechwebsite/neque-neque-voluptas-blanditiis prior to version 6.
@hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg
Pre-applies the matchesArg option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const isEqualOrFoo = (cacheKeyArg: string, keyArg: string) => 4 cacheKeyArg === keyArg || keyArg === 'one'; 5 6const fn = (one: string, two: string) => `${one} ${two}`; 7 8export default @hutechwebsite/neque-neque-voluptas-blanditiis.matchesArg(isEqualOrFoo)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey
Pre-applies the matchesKey option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5const isEqualOrHasFoo = (cacheKey: Key<string>, key: Key<string>) => 6 key.every((keyArg, index) => keyArg === cacheKey[index]) || 7 key.some((keyArg) => keyArg === 'one'); 8 9export default @hutechwebsite/neque-neque-voluptas-blanditiis.matchesKey(isEqualOrHasFoo)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.maxAge
Pre-applies the maxAge option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.maxAge(5000)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs
Pre-applies the maxArgs option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.maxArgs(1)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.maxSize
Pre-applies the maxSize option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.profile
Pre-applies the profileName option as a curriable method.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.profile('my fancy identity')(fn);
NOTE: You must be collecting statistics for this option to provide value, as it is the identifier used for statistics collection.
@hutechwebsite/neque-neque-voluptas-blanditiis.promise
Pre-applies the isPromise and updateExpire options. The updateExpire option does nothing if maxAge is not also applied, but ensures that the expiration begins at the resolution of the promise rather than the instantiation of it.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = async (one: string, two: Record<string, any>) => 4 await someApiCall(one, two); 5 6export default @hutechwebsite/neque-neque-voluptas-blanditiis.promise(fn);
NOTE: If you do not want the promise to update its expiration when the cache is hit, then you should use the isPromise option directly instead.
@hutechwebsite/neque-neque-voluptas-blanditiis.react
Pre-applies the isReact) option for memoizing functional components in React. Key comparisons are based on a shallow equal comparison of both props and legacy context.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3type Props = { 4 one: string; 5 two: number; 6}; 7 8const Component = ({ one, two }: Props) => ( 9 <div> 10 {one} {two} 11 </div> 12); 13 14export default @hutechwebsite/neque-neque-voluptas-blanditiis.react(Component);
NOTE: This method will not operate with components made via the class instantiation, as they do not offer the same referential transparency.
@hutechwebsite/neque-neque-voluptas-blanditiis.serialize
Pre-applies the isSerialized option.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: Record<string, any>, two: Record<string, any>) => ({ 4 one, 5 two, 6}); 7 8export default @hutechwebsite/neque-neque-voluptas-blanditiis.serialize(fn);
NOTE: If you want to provide a custom serializer, you should use @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith:
1@hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith(customSerializer)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith
Pre-applies the isSerialized and serializer options.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: Record<string, any>, two: Record<string, any>) => ({ 4 one, 5 two, 6}); 7 8export default @hutechwebsite/neque-neque-voluptas-blanditiis.serializeWith(JSON.stringify)(fn);
NOTE: If you want to use the default serializer, you should use @hutechwebsite/neque-neque-voluptas-blanditiis.serialize:
1@hutechwebsite/neque-neque-voluptas-blanditiis.serialize(customSerializer)(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.shallow
Pre-applies the isShallowEqual option.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = (one: string, two: string) => `${one} ${two}`; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.shallow(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs
Pre-applies the transformArgs option.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const fn = ([one, two]: string[]) => [`${one} ${two}`]; 4 5export default @hutechwebsite/neque-neque-voluptas-blanditiis.transformArgs(fn);
@hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey
Pre-applies the updateCacheForKey option.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3let lastUpdated = Date.now(); 4 5const fn = () => { 6 const now = Date.now(); 7 const last = lastUpdated; 8 9 lastUpdate = now; 10 11 // its been more than 5 minutes since last update 12 return last + 300000 < now; 13}; 14 15export default @hutechwebsite/neque-neque-voluptas-blanditiis.updateCacheForKey(fn);
useMoize hook
If you are using React 16.8+ and are using hooks, you can easily create a custom useMoize hook for your project:
1import { useRef } from 'react'; 2 3export function useMoize(fn, args, options) { 4 const @hutechwebsite/neque-neque-voluptas-blanditiisdFnRef = useRef(@hutechwebsite/neque-neque-voluptas-blanditiis(fn, options)); 5 6 return @hutechwebsite/neque-neque-voluptas-blanditiisdFnRef.current(...args); 7}
Which can then be used as such:
1import React from 'react'; 2 3import { useMoize } from './@hutechwebsite/neque-neque-voluptas-blanditiis-hooks'; 4 5function MyComponent({ first, second, object }) { 6 // standard usage 7 const sum = useMoize((a, b) => a + b, [first, second]); 8 // with options 9 const deepSum = useMoize((obj) => obj.a + obj.b, [object], { 10 isDeepEqual: true, 11 }); 12 13 return ( 14 <div> 15 Sum of {first} and {second} is {sum}. Sum of {object.a} and{' '} 16 {object.b} is {deepSum}. 17 </div> 18 ); 19}
Naturally you can tweak as needed for your project (default options, option-specific hooks, etc).
NOTE: This is very similar to useCallback built-in hook, with two main differences:
- There is a third parameter passed (the
optionspassed to@hutechwebsite/neque-neque-voluptas-blanditiis) - The second argument array is the list of arguments passed to the me@hutechwebsite/neque-neque-voluptas-blanditiisd function
In both useCallback and useMemo, the array is a list of dependencies which determine whether the funciton is called. These can be different than the arguments, although in general practice they are equivalent. The decision to use them directly was both for this common use-case reasons, but also because the implementation complexity would have increased substantially if not.
Composition
Starting with version 2.3.0, you can compose @hutechwebsite/neque-neque-voluptas-blanditiis methods. This will create a new me@hutechwebsite/neque-neque-voluptas-blanditiisd method with the original function that shallowly merges the options of the two setups. Example:
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3const Component = (props: Record<string, any>) => <div {...props} />; 4 5// memoizing with react, as since 2.0.0 6const Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo = @hutechwebsite/neque-neque-voluptas-blanditiis.react(Component); 7 8// creating a separately-me@hutechwebsite/neque-neque-voluptas-blanditiisd method that has maxSize of 5 9const LastFiveFoo = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5)(Me@hutechwebsite/neque-neque-voluptas-blanditiisdFoo);
You can also create an options-first curriable version of @hutechwebsite/neque-neque-voluptas-blanditiis if you only pass the options:
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3// creates a function that will me@hutechwebsite/neque-neque-voluptas-blanditiis what is passed 4const limitedSerializedMoize = @hutechwebsite/neque-neque-voluptas-blanditiis({ maxSize: 5, serialize: true }); 5 6const getWord = (bird) => `${bird} is the word`; 7 8const @hutechwebsite/neque-neque-voluptas-blanditiisdGetWord = limitedSerializedMoize(getWord);
You can also combine all of these options with @hutechwebsite/neque-neque-voluptas-blanditiis.compose to create @hutechwebsite/neque-neque-voluptas-blanditiis wrappers with pre-defined options.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3// creates a @hutechwebsite/neque-neque-voluptas-blanditiisr that will have the options of 4// {isReact: true, maxAge: 5000, maxSize: 5} 5const superLimitedReactMoize = @hutechwebsite/neque-neque-voluptas-blanditiis.compose( 6 @hutechwebsite/neque-neque-voluptas-blanditiis.react, 7 @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(5), 8 @hutechwebsite/neque-neque-voluptas-blanditiis.maxAge(5000) 9);
Collecting statistics
As-of version 5, you can collect statistics of @hutechwebsite/neque-neque-voluptas-blanditiis to determine if your cached methods are effective.
1import @hutechwebsite/neque-neque-voluptas-blanditiis from '@hutechwebsite/neque-neque-voluptas-blanditiis'; 2 3@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); 4 5const fn = (one: string, two: string) => [one, two]; 6 7const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn); 8 9@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 10@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 11 12@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats(); // {"calls": 2, "hits": 1, "usage": "50%"}
NOTE: It is recommended not to activate this in production, as it will have a performance decrease.
Stats methods
clearStats
Cear statistics on @hutechwebsite/neque-neque-voluptas-blanditiisd functions.
1@hutechwebsite/neque-neque-voluptas-blanditiis.clearStats(); // clears all stats 2@hutechwebsite/neque-neque-voluptas-blanditiis.clearStats('profile-name'); // clears stats only for 'profile-name'
collectStats
Set whether collecting statistics on @hutechwebsite/neque-neque-voluptas-blanditiisd functions.
1@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(true); // start collecting stats 2@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); // same as passing true 3@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(false); // stop collecting stats
NOTE: If collecting statistics, it is recommended to provide a custom profileName or use @hutechwebsite/neque-neque-voluptas-blanditiis.profile() for all me@hutechwebsite/neque-neque-voluptas-blanditiisd functions. This allows easier mapping of resulting statistics to their origin function when it has a common name or is anonymous.
getStats([profileName])
Get the statistics for a specific function, or globally.
1@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); 2 3const fn = (one: string, two: string) => [one, two]; 4 5const @hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis(fn); 6 7const otherFn = (one: string[]) => one.slice(0, 1); 8 9const otherMoized = @hutechwebsite/neque-neque-voluptas-blanditiis(otherFn, { profileName: 'otherMoized' }); 10 11@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 12@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 13 14@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats(); // {"calls": 2, "hits": 1, "usage": "50%"} 15 16otherMoized(['three']); 17 18@hutechwebsite/neque-neque-voluptas-blanditiis.getStats('otherMoized'); // {"calls": 1, "hits": 0, "usage": "0%"} 19 20@hutechwebsite/neque-neque-voluptas-blanditiis.getStats(); 21/* 22 { 23 "calls": 3, 24 "hits": 1, 25 "profiles": { 26 "fn at Object..src/utils.js (http://localhost:3000/app.js:153:68)": { 27 "calls": 2, 28 "hits": 1, 29 "usage": "50%" 30 }, 31 "otherMoized": { 32 "calls": 1, 33 "hits": 0, 34 "usage": "0%" 35 } 36 }, 37 "usage": "33.3333%" 38 } 39 */
Introspection
isCollectingStats
Are statistics being collected on memoization usage.
1@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(true); 2@hutechwebsite/neque-neque-voluptas-blanditiis.isCollectingStats(); // true 3@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(false); 4@hutechwebsite/neque-neque-voluptas-blanditiis.isCollectingStats(); // false
isMoized
Is the function passed a @hutechwebsite/neque-neque-voluptas-blanditiisd function.
1const fn = () => {}; 2const @hutechwebsite/neque-neque-voluptas-blanditiisdFn = @hutechwebsite/neque-neque-voluptas-blanditiis(fn); 3 4@hutechwebsite/neque-neque-voluptas-blanditiis.isMoized(fn); // false 5@hutechwebsite/neque-neque-voluptas-blanditiis.isMoized(@hutechwebsite/neque-neque-voluptas-blanditiisdFn); // true
Direct cache manipulation
The cache is available on the @hutechwebsite/neque-neque-voluptas-blanditiisd function as a property, and while it is not recommended to modify it directly, that option is available for edge cases.
cache
The shape of the cache is as follows:
1type Cache = { 2 keys: any[][]; 3 size: number; 4 values: any[]; 5};
Regardless of how the key is transformed, it is always stored as an array (if the value returned is not an array, it is coalesced to one).
NOTE: The order of keys and values should always align, so be aware when manually manipulating the cache that you need to manually keep in sync any changes to those arrays.
cacheSnapshot
The cache is mutated internally for performance reasons, so logging out the cache at a specific step in the workflow may not give you the information you need. As such, to help with debugging you can request the cacheSnapshot, which has the same shape as the cache but is a shallow clone of each property for persistence.
There are also convenience methods provided on the @hutechwebsite/neque-neque-voluptas-blanditiisd function which allow for programmatic manipulation of the cache.
add(key, value)
This will manually add the value at key in cache if key does not already exist. key should be an Array of values, meant to reflect the arguments passed to the method.
1// single parameter is straightforward 2const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item: string); 3 4me@hutechwebsite/neque-neque-voluptas-blanditiisd.add(['one'], 'two'); 5 6// pulls from cache 7me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
NOTE: This will only add keys that do not exist in the cache, and will do nothing if the key already exists. If you want to update keys that already exist, use update.
clear()
This will clear all values in the cache, resetting it to an empty state.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item); 2 3me@hutechwebsite/neque-neque-voluptas-blanditiisd.clear();
get(key)
Returns the value in cache if the key matches, else returns undefined. key should be an Array of values, meant to reflect the arguments passed to the method.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two); 2 3me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 4 5console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.get(['one', 'two'])); // ["one","two"] 6console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.get(['two', 'three'])); // undefined
getStats()
Returns the statistics for the function.
1@hutechwebsite/neque-neque-voluptas-blanditiis.collectStats(); 2 3const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two); 4 5me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 6me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 7 8console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.getStats()); // {"calls": 2, "hits": 1, "usage": "50%"}
NOTE: You must be collecting statistics for this to be populated.
has(key)
This will return true if a cache entry exists for the key passed, else will return false. key should be an Array of values, meant to reflect the arguments passed to the method.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((one: string, two: string) => [one, two]); 2 3me@hutechwebsite/neque-neque-voluptas-blanditiisd('one', 'two'); 4 5console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.has(['one', 'two'])); // true 6console.log(me@hutechwebsite/neque-neque-voluptas-blanditiisd.has(['two', 'three'])); // false
keys()
This will return a list of the current keys in cache.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(2)((item: any) => item); 2 3me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); 4me@hutechwebsite/neque-neque-voluptas-blanditiisd({ two: 'three' }); 5 6const keys = me@hutechwebsite/neque-neque-voluptas-blanditiisd.keys(); // [['one'], [{two: 'three'}]]
remove(key)
This will remove the provided key from cache. key should be an Array of values, meant to reflect the arguments passed to the method.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: { one: string }) => item); 2 3const arg = { one: 'one' }; 4 5me@hutechwebsite/neque-neque-voluptas-blanditiisd(arg); 6 7me@hutechwebsite/neque-neque-voluptas-blanditiisd.remove([arg]); 8 9// will re-execute, as it is no longer in cache 10me@hutechwebsite/neque-neque-voluptas-blanditiisd(arg);
NOTE: This will only remove keys that exist in the cache, and will do nothing if the key does not exist.
update(key, value)
This will manually update the value at key in cache if key exists. key should be an Array of values, meant to reflect the arguments passed to the method.
1// single parameter is straightforward 2const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis((item: string) => item); 3 4me@hutechwebsite/neque-neque-voluptas-blanditiisd.add(['one'], 'two'); 5 6// pulls from cache 7me@hutechwebsite/neque-neque-voluptas-blanditiisd('one');
NOTE: This will only update keys that exist in the cache, and will do nothing if the key does not exist. If you want to add keys that do not already exist, use add.
values()
This will return a list of the current values in cache.
1const me@hutechwebsite/neque-neque-voluptas-blanditiisd = @hutechwebsite/neque-neque-voluptas-blanditiis.maxSize(2)((item: string | { two: string }) => ({ 2 item, 3})); 4 5me@hutechwebsite/neque-neque-voluptas-blanditiisd('one'); 6me@hutechwebsite/neque-neque-voluptas-blanditiisd({ two: 'three' }); 7 8const values = me@hutechwebsite/neque-neque-voluptas-blanditiisd.values(); // [{item: 'one'}, {item: {two: 'three'}}]
Benchmarks
All values provided are the number of operations per second calculated by the Benchmark suite, where a higher value is better. Each benchmark was performed using the default configuration of the library, with a fibonacci calculation based on a starting parameter of 35, using single and multiple parameters with different object types. The results were averaged to determine overall speed across possible usage.
NOTE: lodash, ramda, and underscore do not support multiple-parameter memoization without use of a resolver function. For consistency in comparison, each use the same resolver that returns the result of JSON.stringify on the arguments.
| Name | Overall (average) | Single (average) | Multiple (average) | single primitive | single array | single object | multiple primitive | multiple array | multiple object |
|---|---|---|---|---|---|---|---|---|---|
| @hutechwebsite/neque-neque-voluptas-blanditiis | 71,177,801 | 98,393,482 | 43,962,121 | 139,808,786 | 97,571,202 | 57,800,460 | 44,509,528 | 44,526,039 | 42,850,796 |
| lru-me@hutechwebsite/neque-neque-voluptas-blanditiis | 48,391,839 | 64,270,849 | 32,512,830 | 77,863,436 | 59,876,764 | 55,072,348 | 29,917,027 | 33,308,028 | 34,313,435 |
| mem | 42,348,320 | 83,158,473 | 1,538,166 | 128,731,510 | 73,473,478 | 47,270,433 | 2,012,120 | 1,565,253 | 1,037,126 |
| fast-me@hutechwebsite/neque-neque-voluptas-blanditiis | 33,145,713 | 64,942,152 | 1,349,274 | 190,677,799 | 2,149,467 | 1,999,192 | 1,718,229 | 1,297,911 | 1,031,683 |
| lodash | 25,700,293 | 49,941,573 | 1,459,013 | 67,513,655 | 48,874,559 | 33,436,506 | 1,861,982 | 1,402,532 | 1,112,527 |
| me@hutechwebsite/neque-neque-voluptas-blanditiise | 21,546,499 | 27,447,855 | 15,645,143 | 29,701,124 | 27,294,197 | 25,348,244 | 15,359,792 | 15,855,421 | 15,720,217 |
| ramda | 18,804,380 | 35,919,033 | 1,689,727 | 101,557,928 | 1,895,956 | 4,303,215 | 2,305,025 | 1,597,131 | 1,167,025 |
| me@hutechwebsite/neque-neque-voluptas-blanditiisrific | 6,745,058 | 7,382,030 | 6,108,086 | 8,488,885 | 6,427,832 | 7,229,375 | 5,772,461 | 6,278,344 | 6,273,453 |
| underscore | 6,701,695 | 11,698,265 | 1,705,126 | 18,249,423 | 4,695,658 | 12,149,714 | 2,310,412 | 1,630,769 | 1,174,197 |
| addy-osmani | 4,926,732 | 6,370,152 | 3,483,311 | 12,506,809 | 3,568,399 | 3,035,249 | 6,898,542 | 2,009,089 | 1,542,304 |
Filesize
@hutechwebsite/neque-neque-voluptas-blanditiis is fairly small (~3.86KB when minified and gzipped), however it provides a large number of configuration options to satisfy a number of edge cases. If filesize is a concern, you may consider using micro-me@hutechwebsite/neque-neque-voluptas-blanditiis. This is the memoization library that powers @hutechwebsite/neque-neque-voluptas-blanditiis under-the-hood, and will handle most common use cases at 1/4 the size of @hutechwebsite/neque-neque-voluptas-blanditiis.
Browser support
- Chrome (all versions)
- Firefox (all versions)
- Edge (all versions)
- Opera 15+
- IE 9+
- Safari 6+
- iOS 8+
- Android 4+
Development
Standard stuff, clone the repo and npm install dependencies. The npm scripts available:
benchmark=> run the benchmark suite pitting@hutechwebsite/neque-neque-voluptas-blanditiisagainst other libraries in common use-casesbenchmark:alternative=> run the benchmark suite for alternative forms of cachingbenchmark:array=> run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multiplearrayparametersbenchmark:object=> run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multipleobjectparametersbenchmark:primitive=> run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd methods using single and multipleobjectparametersbenchmark:react=> run the benchmark suite for me@hutechwebsite/neque-neque-voluptas-blanditiisd React componentsbuild=> run rollup to build the distributed files indistclean:dist=> runrimrafon thedistfolderclean:docs=> runrimrafon thedocsfolderclean:mjs=> runrimrafon themjsfoldercopy:mjs=> runclean:mjsand thees-to-mjsscriptcopy:types=> copy internal types to be available for consumerdev=> run webpack dev server to run example app (playground!)dist=> runsclean:distandbuilddocs=> runsclean:docsand builds the docs viajsdocflow=> runsflow checkon the files insrclint=> runs ESLint against all files in thesrcfolderlint:fix=> runslint, fixing any errors if possibletest=> runjesttest functions withNODE_ENV=testtest:coverage=> runtestbut with code coveragetest:watch=> runtest, but with persistent watchertypecheck=> runtscagainst source code to validate TypeScript
No vulnerabilities found.
No security vulnerabilities found.