diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f922e38b..f49b825e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ If you'd like to send us sensitive sample code to help troubleshoot your issue, ## Contributing Enhancements -We love contributions to Realm! If you'd like to contribute code, documentation, or any other improvements, please [file a Pull Request](https://github.com/realm/realm-js/pulls) on our GitHub repository. Make sure to accept our [CLA](#cla) +We love contributions to Realm! If you'd like to contribute code, documentation, or any other improvements, please [file a Pull Request](https://github.com/realm/realm-js/pulls) on our GitHub repository. Make sure to accept our [CLA](#cla). ### Commit Messages diff --git a/README.md b/README.md index 15963472..64d85591 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ By participating, you are expected to uphold this code. Please report unacceptab ## Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for more details! +See [CONTRIBUTING.md](https://github.com/realm/realm-js/blob/master/CONTRIBUTING.md) for more details! ## License 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);