status-im/realm-js
2
0
Fork 0
mirror of https://github.com/status-im/realm-js.git synced 2025-01-15 00:54:21 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #337 from realm/sk-doc-updates

Browse Source 
Minor doc updates
This commit is contained in:
Scott Kyle 2016-03-17 15:48:45 -07:00
commit 900f0dbd80
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -17,7 +17,7 @@ If you'd like to send us sensitive sample code to help troubleshoot your issue,
## Contributing Enhancements ## 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 ### Commit Messages

2
README.md
View File

@ -67,7 +67,7 @@ By participating, you are expected to uphold this code. Please report unacceptab
## Contributing ## 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 ## License

3
docs/realm.js
View File

@ -32,6 +32,7 @@ class Realm {
* `config.schemaVersion` is incremented, in which case the Realm will be automatically * `config.schemaVersion` is incremented, in which case the Realm will be automatically
* migrated to use the new schema. * migrated to use the new schema.
* @param {Realm~Configuration} [config] - **Required** when first creating the Realm. * @param {Realm~Configuration} [config] - **Required** when first creating the Realm.
* @throws {Error} If anything in the provided `config` is invalid.
*/ */
constructor(config) {} constructor(config) {}
@ -112,6 +113,8 @@ Realm.defaultPath;
* This describes the different options used to create a {@link Realm} instance. * This describes the different options used to create a {@link Realm} instance.
* @typedef Realm~Configuration * @typedef Realm~Configuration
* @type {Object} * @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 * @property {string} [path={@link Realm.defaultPath}] - The path to the file where the
* Realm database should be stored. * Realm database should be stored.
* @property {Array<Realm~ObjectClass|Realm~ObjectSchema>} [schema] - Specifies all the * @property {Array<Realm~ObjectClass|Realm~ObjectSchema>} [schema] - Specifies all the

2
tests/js/encryption-tests.js
View File

@ -32,7 +32,7 @@ module.exports = BaseTest.extend({
TestCase.assertThrows(function() { TestCase.assertThrows(function() {
new Realm({schema: [Schemas.TestObject], encryptionKey: new Int8Array(63)}); new Realm({schema: [Schemas.TestObject], encryptionKey: new Int8Array(63)});
}, "Encryption Key must be 64 byes"); }, "Encryption Key must be 64 bytes");
}, },
testEncryptionValidKey: function() { testEncryptionValidKey: function() {
var key = new Int8Array(64); var key = new Int8Array(64);