Skip to content

User Scramble Key

W. "Mac" McMeans edited this page Apr 20, 2022 · 12 revisions

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.

localStorage Keys

The usual suspects:

set / get      clear      key      remove

The esoteric ones:

Array Keys:
push / pull, pullall      poke      contains      where

Broadcasting:
broadcast

Bypass:
forceset / forceget

Data Transfer:
import / export

Duplicates:
countdupes, showdupes, listdupes

Internals:
cancrunch      crunch / uncrunch

shufflestring / unshufflestring

xorstring

Management:
keys

Memory Consumption:

Memory Quota:
showquota

Query:
haskey, hasval, hastype

Security:
safeset / safeget

setscramblekey / getscramblekey

Type Check:
isarray      isbigint      isboolean      iscrunch

isdate      isfloat      isinteger      isnull

isnumber      isobject      isstring

showtype

Utility:
chopget      copy      softset      rename

Properties:

channel      length      quota      version

Settings:

verbosity

Memory Keys

Standard:

_set / _get      _clear      _key      _remove

Unconventional:

Data Sync:
_backup / _restore

Management:
_keys

Security:
_safeset / _safeget

Type Check:
_isarray      _isbigint      _isboolean      _iscrunch

_isdate      _isfloat      _isinteger      _isnull

_isnumber      _isobject      _isstring

_showtype

Utility:
_chopget      _copy      _softset      _rename

Clone this wiki locally