Commit Graph

143 Commits

Author SHA1 Message Date
blagoev 6c5960ee7b fix merge 2017-09-28 10:37:45 +03:00
blagoev 37105e7f00 Merge branch '2.0.x' into kneth/lazy-enable-sync 2017-09-28 10:29:37 +03:00
Thomas Goyne e608255282 Update JSDocs for arrays of primitives (#1357) 2017-09-27 17:57:41 -07:00
Kenneth Geisshirt 2caa14abf2 Don't expose an initializer function. 2017-09-27 20:16:44 +02:00
Kenneth Geisshirt fba3b3fc38 Merge branch '2.0.x' of github.com:realm/realm-js into kneth/v1_v2-upgrade 2017-09-27 18:10:39 +02:00
Kenneth Geisshirt f94f351bfb Adding documentation, TS definition and change log. 2017-09-27 17:53:09 +02:00
Thomas Goyne 2298609ce5 Merge remote-tracking branch 'origin/master' into tg/merge-master-to-2.0.x
* origin/master: (23 commits)
  Fix api doc error
  fix progress notifications registrations
  Fix typo in Github issue template
  Fix port conflict between RN >= 0.48 and RPC server (#1294)
  Disable testAddListener when running in chrome
  Ensure RN has an event loop running for async tests
  Make permission tests better handle server delays
  Fix race conditions in testAddListener
  Separate build and test steps in xcode to reduce chance of hitting "Early unexpected exit"
  Ignore errors when sourcing nvm.sh
  Don't forward arguments to nvh.sh
  Skip sourcing nvm.sh if it's already available
  Fix some shellcheck warnings
  Ensure node 6.5.0 is installed on CI
  Build realm from source for each test-runner test
  Improve error reporting for incorrect argument counts for Realm methods
  Use the same error messages in the RPC code as the regular code
  Silence an unused variable warning when building with sync disabled
  Check the exception message in all Realm tests which assert an exception is thrown
  Don't discard the actual error message in validated_get_X
  ...
2017-09-25 09:40:56 -07:00
Kenneth Geisshirt 49392bd4c6 Merge branch '2.0.x' of github.com:realm/realm-js into kneth/v1_v2-upgrade 2017-09-25 16:04:43 +02:00
Kenneth Geisshirt 61ad47faf5 Fixing a few typos 2017-09-25 16:03:14 +02:00
Morten Krogh fe9677b1c5 Added documentation abut exceptions for open_ssl_verify_callback. 2017-09-25 11:57:18 +02:00
Morten Krogh 73dd90a05f Merge branch 'mk/ssl-verify-callback-2' of github.com:realm/realm-js into mk/ssl-verify-callback-2 2017-09-25 11:08:36 +02:00
Morten Krogh fbe619c255 Changed ssl_verify_callback to open_ssl_verify_callback.
Changed the preverifyOk to acceptedByOpenSSL and made it a Boolean.
Changed jsdoc formatting.
2017-09-25 11:05:16 +02:00
Kenneth Geisshirt 39fe8c6280 Creating a proper IncompatibleSyncedRealmError class. 2017-09-23 00:05:33 +02:00
Kenneth Geisshirt 0332fc7e66 Update realm.js
Fixing old typos.
2017-09-22 19:39:00 +02:00
Kenneth Geisshirt 4b2acf3b79 Updating documentation and test. 2017-09-22 13:50:17 +02:00
blagoev f8f6661fe2 Fix api doc error 2017-09-22 13:14:02 +03:00
Morten Krogh c1e198cbab Documentation and comments for ssl_verify_callback. 2017-09-22 11:21:36 +02:00
Kenneth Geisshirt eeb78d8e1b Merge branch 'master' of github.com:realm/realm-js into 2.0.x 2017-09-18 09:46:36 +02:00
Kenneth Geisshirt b3ff7ada62 Documenting sync.config properties (#1312)
* Documenting sync.config properties
* Updating TypeScript definitions
2017-09-15 15:22:44 +02:00
astigsen 208aa8ee46 Added support for in-memory realms (#1304)
* Added support for in-memory realms
2017-09-13 20:42:23 +02:00
blagoev 064b487c07 Merge branch 'master' into blagoev/promise3 2017-09-13 14:27:04 +03:00
blagoev 6cdbe503b7 fix docs 2017-09-13 13:55:27 +03:00
blagoev f7db865458 Fix typescript definitions
Fixes #1306
2017-09-13 12:37:44 +03:00
Maximilian Alexander 78515e3b48 adding promisified apis 2017-09-12 20:10:52 +03:00
Ashwin Phatak 532f517ded Add Realm.deleteModel API (#573) 2017-09-12 14:45:36 +05:30
blagoev 0e07287396 Update progress api docs 2017-09-11 15:50:44 +03:00
Kenneth Geisshirt 356033a8c4 Merge branch 'tg/update-object-store' of github.com:realm/realm-js into 2.0.x 2017-09-08 14:56:01 +02:00
Ashwin Phatak 119cd79e5d Add Realm.deleteFile API (#363) 2017-09-07 10:12:59 +05:30
Thomas Goyne 736277084e Fix creating admin token users 2017-08-31 13:49:45 -07:00
Kristian Dupont 402bf48f88 Permissions api (#1244)
* Add basic permissions skeleton

* ...

* Update permissions api

* Wait for server to process management realm, add offer api

* Fix test of apply and get permissions, add offer test

* Accept permission offer

* Accept permission offer test

* Invalidate permission offer

* Add basic docs (still need some links etc)

* Refactor tests

* Only run permission tests where sync is enabled

* Use legal syntax for user name generation

* Add changelog entry

* Streamline permission tests

* Fix casing for access level names etc.

* Add basic definitions to index.d.ts

* Use settimeout for resolving promise from listener

* Complete typescript defs

* Improve docs

* Allow 'any' as default recipient in getGrantedPermissions

* Fix getSpecialPurposeRealm on iOS

* Response to PR comments

* Respond to PR comments

* Fix offer description

* Skip permission tests in chrome debugger :-/
2017-08-29 15:23:22 +02:00
Kenneth Geisshirt 85fb49b354 Adding methods and property to manually control write transactions (#1216)
* Adding methods and property to manually control write transactions
2017-08-21 17:48:53 +02:00
Kenneth Geisshirt bd28c05936 Add shouldCompactOnLaunch option to configuration (#1209)
* Adding shouldCompactOnLaunch option to configuration
* Adding Realm.compact()
2017-08-18 14:22:29 +02:00
Yavor Georgiev 5dd9264225
Add `Realm.empty` 2017-07-12 13:02:21 +02:00
Yavor Georgiev e0facc77ff Fix jsdoc build (#1133)
Using a path relative to the `docs/conf.json` file seems to fix the `FATAL: Unable to load template: Cannot find module 'docs/jsdoc-template/template/publish'` issue.

See 0830c6e2f9.
2017-07-11 13:33:38 +02:00
blagoev fb3979110d fix docs 2017-07-11 12:41:36 +03:00
Yavor Georgiev ab29ac4490 Fix linter issues (#1132) 2017-07-10 16:53:00 +02:00
Yavor Georgiev 1ba9b434b4 Add a new optional server parameter to User.adminUser (#1111)
* add a new optional server parameter to User.adminUser

This enables `User.openManagementRealm()` for admin token users.

* changelog

* API docs
2017-07-10 15:04:55 +02:00
blagoev db7284ee97 fix parameter placement 2017-07-10 12:34:50 +03:00
blagoev 516c39deaf Docs for retrieveAccount method (#1127)
* Docs for retrieveAccount method

* fix setTimeout call
2017-07-08 19:30:25 +02:00
Marius Rackwitz 9e0a9a3bd3 Add support for accessing linking objects / backlinks (#1101)
* Add support for linkingObjects

* Test linkingObjects

* Borrow names helper from list tests

* include computed properties when serializing the schema for the RN debugger

* add API docs

* review comments

* Expose admin users to JS (#1100)

The JS binding used to conflate `SyncUser::is_admin()` with the user being created by calling `Realm.Sync.User.adminToken()`, but now that we expose a user’s role on the server under `is_admin()` this supposition is no longer correct.

#1097 attempted to fix one such case, but fixing it only uncovered another: in `UserClass<T>::all_users()`.  I’ve gone through all the callsites of `SyncUser::is_admin()` to make sure they don’t assume an admin token user.

* [1.8.3] Bump version

* add linkingObjects method to Realm.Object

* changelog
2017-06-29 11:59:10 +02:00
astigsen db4e184524 Added method to find index of object in collections (#1094)
* Added method to find index of object in collections

* rework as the indexOf method
2017-06-26 13:43:49 +02:00
Yavor Georgiev 39e312f301
add API docs for Realm.Object.objectSchema() 2017-06-26 11:47:23 +02:00
blagoev 5b17e14378 Fix api reference for callbacks 2017-05-31 14:22:53 +03:00
Ari Lazier 9258d95550 Adapter Docs (#930)
* adapter docs

* fix undefined bug
2017-05-18 13:40:25 +02:00
Kristian Dupont 22d4b2e391 Fix doc mistake (#1028)
* Fix doc mistake

* Remove throw doc in Realm.open
2017-05-18 13:11:51 +02:00
Kristian Dupont 57414f641d Update docs for Realm.open and Realm.openAsync (#1027)
* Update docs for Realm.open and Realm.openAsync

* Update realm.js
2017-05-18 12:40:26 +02:00
Radu Tutueanu f6564ca68f Add the variables to the syncConfig 2017-05-05 13:50:45 +02:00
Kristian Dupont c4535bdf1a Improve api docs (#920)
* Set docs title in configuration

* Add markdown plugin to jsdoc

* Add query language tutorial to docs

* jsdoc template submodule updated

* Add query docs

* Document placeholders and composition operators

* Add logo

* Add note about boolean checks

* Fixes as per PR comments
2017-03-22 12:54:35 +01:00
Kristian Dupont aa38d28eb0 Two more indentation fixes 2017-03-20 10:43:42 +01:00
Kristian Dupont 1bdc50ebf6 Fix indentation in sync docs source 2017-03-20 10:40:56 +01:00
Kristian Dupont 94f8d5a891 Add optional userInfo param to registerWithProvider (#915)
* Add optional userInfo param to registerWithProvider

* Fixes per PR comments
2017-03-17 14:13:03 +01:00
Kristian Dupont 04bb250208 Fix method name in sync docs (#898) 2017-03-08 11:21:28 +01:00
Kristian Dupont 70437745f0 Add Session and some missing User docs (#828)
* Add Session and some missing User docs

* Remove accidentally pasted line

* Add permissions docs

* Respond to PR comments

* Remove docs for user.create
2017-02-01 21:45:55 +01:00
Yavor Georgiev 408f5588f8 Add Permissions models and User Management Realm API (#824)
* Add Permissions models and User Management Realm API

* docs and changelog

* fix bad merge

* add test

* fix jsdoc annotation

* rename permissions to management schema
2017-01-31 22:56:09 +01:00
Ari Lazier 02d51d6efe doc additions (#724)
* doc additions

* Update sync.js

* Update sync.js

Mirror previous update to call parameter in callback `change_event` to match classname
2016-12-20 17:00:39 +01:00
Ari Lazier 3fb20537b5 update notifier docs 2016-12-06 17:42:15 +01:00
Radu Tutueanu 8d5acd7da5 Fix docs and test according to new api 2016-11-16 13:36:41 +01:00
Ari Lazier bfce11918b temporarily remove sync docs 2016-11-15 10:48:15 -08:00
Søren Vind 06b27bf8c0 Add documentation for new methods 2016-11-15 05:19:36 -08:00
Søren Vind 06d277aacd Bumped version of ESLint, added eslinting of specs, make all linting pass 2016-11-14 10:48:50 -08:00
Søren Vind 14e75f12bc Documentation for .all and .current 2016-11-11 14:54:12 -08:00
Yavor Georgiev 622482029a Pass AuthError in Realm.Sync.User methods callbacks (#619)
* Pass AuthError in Realm.Sync.User methods callbacks

The new Realm.Sync.AuthError class exposes properties common to the Problem family of classes in the Realm Object Server

* extract AuthError in a separate file

* whitespace
2016-10-25 00:12:12 +02:00
Ari Lazier 9d0df0de3d Sync and fine grained notifications 2016-10-04 15:07:14 -07:00
Scott Kyle ab05c5f732 Add introduced version to objectForPrimaryKey doc 2016-06-17 02:38:09 -07:00
Scott Kyle 979c035dbb Add isValid() method doc for collections 2016-06-16 17:50:30 -07:00
Scott Kyle 3c657c3bbf Update docs and CHANGELOG with objectForPrimaryKey 2016-06-03 16:59:50 -07:00
Scott Kyle bd863f7590 Remove qualification about date precision in API docs 2016-05-19 13:33:00 -07:00
Scott Kyle 9fff367ce0 Reword close() API doc based on PR feedback 2016-05-04 11:47:11 -07:00
Scott Kyle 4cecb0a612 Add close() method API doc 2016-05-04 02:39:06 -07:00
Scott Kyle 77a55ee024 Add API docs for the schema property 2016-05-02 18:28:54 -07:00
Scott Kyle 02dfed99bd Add API docs for migration functions 2016-05-02 13:49:40 -07:00
Scott Kyle 15b69e381d Add API docs for readOnly 2016-05-02 13:21:02 -07:00
Scott Kyle f59e1d972c API doc update for Realm.Object class 2016-05-02 13:12:49 -07:00
Scott Kyle b50870b040 API doc updates for path and schemaVersion properties 2016-05-02 13:12:49 -07:00
Scott Kyle 0e74362e4c Merge pull request #340 from realm/sk-collection
Make List and Results inherit from Collection
2016-03-21 15:27:18 -07:00
Scott Kyle d18ea5630d Adjust some of the Collection API docs 2016-03-21 15:13:55 -07:00
Ari Lazier dc5d9e80f1 tweak docs 2016-03-21 13:34:34 -07:00
Ari Lazier 2d6360e1f2 update docs 2016-03-21 13:34:34 -07:00
Scott Kyle 95ac0594df Add Realm.schemaVersion API doc
This may need to be adjusted depending on the decisions surrounding this API.
2016-03-21 13:34:12 -07:00
Ari Lazier 1b0ec38339 Update realm.js 2016-03-21 13:26:33 -07:00
Ari Lazier 80c532cf3e docs 2016-03-21 11:49:16 -07:00
Scott Kyle 5faa71e1e0 Add API docs for all Collection methods
Resolves #298
2016-03-20 11:57:40 -07:00
Scott Kyle 92461f2598 Update API docs with encryptionKey 2016-03-17 15:14:56 -07:00
Scott Kyle aa5529e059 Update List splice doc to be more clear about count 2016-03-17 15:12:18 -07:00
Scott Kyle 933326c410 Add List splice method to API docs
It was mysteriously missing!
2016-03-17 14:49:12 -07:00
Scott Kyle 27073a9e66 Properly configure ESLint for syntax checking
Added a test case to run on CI as well.
2016-03-16 13:01:38 -07:00
Scott Kyle 91960152df Capitalize Realm in API docs 2016-03-07 12:23:04 -08:00
Scott Kyle 52f296c3ac Update API docs with info about constructors 2016-03-04 14:13:28 -08:00
Scott Kyle 89ce54799f Merge pull request #271 from realm/sk-docs-update
Update API docs with sorted/filtered changes
2016-02-21 19:03:49 -08:00
Scott Kyle c1e5cb03cf Update API docs with sorted/filtered changes 2016-02-21 17:51:58 -08:00
Karson Miller 5e9333b699 no message 2016-02-18 15:30:44 -08:00
Scott Kyle ea2c119f4d Remove some API doc qualifiers 2016-02-12 16:57:13 -08:00
Scott Kyle b63dfd1c04 API documentation
This includes the initial draft of API docs that are generated by JSDoc using a template that was greatly improved to best handle this content.
2016-02-12 16:57:13 -08:00