to-key
Convert any value to a string that can be used as the key of an object.
npm
Install withnpm i to-key --save
Usage
var toKey = ; ;//=> 'foobarbazfexfexonetwo'
This can be used for caching results when the results are predictable based on user input or other settings.
Example
We'll assume that someFn
in the example does some heavy processing on whatever arguments are passed that can be avoided if we can instead return the cached value of a previous call.
var cache = {}; { var key = ; if cache return cachekey; var result = ; cachekey = result; return result;}
Why do this?
Given the following:
A
is time it takes (to-key or whatever you use) to stringify any arguments are passedB
is the amount of time it takes to retrieve a stored value from the cacheC
is the time it takes your application to process arguments and store a new value on the cache
It's a good approach when (A + B) < C
. In my applications. You can also use logic that conditionally uses cached results based on the complexity of the arguments passed.
Run tests
Install dev dependencies:
npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Author
Jon Schlinkert
License
Copyright (c) 2015 Jon Schlinkert
Released under the MIT license
This file was generated by verb on February 16, 2015.