Switches - macmcmeans/localDataStorage GitHub Wiki

The following optional switches may be used when instantiating localDataStorage:

/q - quiet mode

/w - warning mode

/t - interface test

Quiet mode will not output anything to the console when localDataStorage starts up. This mode is handy when you don't need to see warnings (or any other output).

In warning mode, the software will first check if the specified prefix has already been used with keys that exist in localStorage, and if so, a warning message is sent to the console. This mode is useful when you need to see warnings on startup, to prevent existing keys from being potentially overwritten.

When no switches are used, standard output will be sent to the console, but warnings will not appear even if they exist. When multiple switches are specified, quiet mode will be overridden.

EXAMPLES:

Show standard output, ignoring any warnings

• z = localDataStorage( 'mac' ); -->
  localDataStorage instantiated. The specified prefix (mac.) adds 4 bytes to every key name (stored using 8 bytes).
  
  

Show standard output, along with any warnings (in this case the prefix has already been used)

• z = localDataStorage( 'mac', '/w' ); -->
  localDataStorage instantiated. The specified prefix (mac.) adds 4 bytes to every key name (stored using 8 bytes).
  Attention! Keys with this prefix already exist in localStorage for this domain!
  
  

Show no output whatsoever

• z = localDataStorage( 'mac', '/q' ); -->
  
  

Using multiple switches

• z = localDataStorage( 'my-app-storage', '/q/w/t' ); -->
  Tested good: The localStorage API is available

When starting localDataStorage, you may specify the data store key prefix.