From 92461f2598b5d3b889145db13b04cdcffd11a255 Mon Sep 17 00:00:00 2001 From: Scott Kyle Date: Thu, 17 Mar 2016 15:07:15 -0700 Subject: [PATCH] Update API docs with encryptionKey --- docs/realm.js | 3 +++ tests/js/encryption-tests.js | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/realm.js b/docs/realm.js index d150cdfc..96f116dc 100644 --- a/docs/realm.js +++ b/docs/realm.js @@ -32,6 +32,7 @@ class Realm { * `config.schemaVersion` is incremented, in which case the Realm will be automatically * migrated to use the new schema. * @param {Realm~Configuration} [config] - **Required** when first creating the Realm. + * @throws {Error} If anything in the provided `config` is invalid. */ constructor(config) {} @@ -112,6 +113,8 @@ Realm.defaultPath; * This describes the different options used to create a {@link Realm} instance. * @typedef Realm~Configuration * @type {Object} + * @property {ArrayBuffer|ArrayBufferView} [encryptionKey] - The 512-bit (64-byte) encryption + * key used to encrypt and decrypt all data in the Realm. * @property {string} [path={@link Realm.defaultPath}] - The path to the file where the * Realm database should be stored. * @property {Array} [schema] - Specifies all the diff --git a/tests/js/encryption-tests.js b/tests/js/encryption-tests.js index 651f98ff..44b87749 100644 --- a/tests/js/encryption-tests.js +++ b/tests/js/encryption-tests.js @@ -32,7 +32,7 @@ module.exports = BaseTest.extend({ TestCase.assertThrows(function() { new Realm({schema: [Schemas.TestObject], encryptionKey: new Int8Array(63)}); - }, "Encryption Key must be 64 byes"); + }, "Encryption Key must be 64 bytes"); }, testEncryptionValidKey: function() { var key = new Int8Array(64);