DatastoreOptions

datastore.DatastoreOptions

Optional settings passed to createDatastore: encryption and custom serialization.

Table of contents

Properties

• encryptionKey
• serializer

Properties

encryptionKey

• encryptionKey?: string | ArrayBuffer | Uint8Array

AES key material. Length must be 16, 32, or 64 bytes/characters for 128 / 256 / 512-bit modes respectively. Wrong keys do not always fail at open—reads may be corrupt (see module doc).

serializer

• serializer?: Serializer

Custom serialize / deserialize hooks; defaults to JSON. Example skeleton:

const jsonSerializer = {
  valueToString(data) {
      if (typeof (data) === 'undefined') {
          return '';
      }
      return JSON.stringify(data);
  },
  valueFromString: function (data) {
      if (data === null || data.length === 0) {
          return undefined;
      }
      return JSON.parse(data);
  },
};