user scramble key - macmcmeans/localDataStorage GitHub Wiki

A user scramble key obfuscates the true value of a key and must be explicitly set with each method requiring it, such as safeset and safeget. The default global scramble key will be used in data obfuscation methods where the user scramble key is not explicitly declared.

While key values are treated as strings and stored accordingly in localStorage, with localDataStorage a key value can be one of many types. Likewise, a user scramble key can be an Array, BigInt, Boolean, Date, Float, Integer, Null, Object or... a typical String type.

User scramble keys are neither stored nor recorded, while the global scramble key is accessible and stored in the API.

Any key's value that was obfuscated with a scramble key can only be retrieved using the same key, and if lost or forgotten, cannot successfully be retrieved at all.