Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1193 from stackmagic/foxx-repo-doc 

mention 'byId' supports not only ids but also keys (from #1181)
This commit is contained in:
Lucas Dohmen 2014-12-17 10:35:20 +01:00
parent cc3b97491d c9fe2a6a9d
commit 58e52e6a0c
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
js/server/modules/org/arangodb/foxx/repository.js
View File

@ -174,13 +174,16 @@ _.extend(Repository.prototype, {
/// @startDocuBlock JSF_foxx_repository_byId
/// `FoxxRepository#byId(id)`
///
/// Returns the model for the given ID.
/// Returns the model for the given ID ("collection/key") or "key".
///
/// @EXAMPLES
///
/// ```javascript
/// var myModel = repository.byId('test/12411');
/// myModel.get('name');
/// var byIdModel = repository.byId('test/12411');
/// byIdModel.get('name');
///
/// var byKeyModel = repository.byId('12412');
/// byKeyModel.get('name');
/// ```
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -326,13 +329,14 @@ _.extend(Repository.prototype, {
/// @startDocuBlock JSF_foxx_repository_removeById
/// `FoxxRepository#removeById(id)`
///
/// Remove the document with the given ID.
/// Expects an ID of an existing document.
/// Remove the document with the given ID ("collection/key") or "key".
/// Expects an ID or key of an existing document.
///
/// @EXAMPLES
///
/// ```javascript
/// repository.removeById('test/12121');
/// repository.removeById('12122');
/// ```
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -392,8 +396,8 @@ _.extend(Repository.prototype, {
/// @startDocuBlock JSF_foxx_repository_replaceById
/// `FoxxRepository#replaceById(id, object)`
///
/// Find the item in the database by the given ID and replace it with the
/// given object's attributes.
/// Find the item in the database by the given ID ("collection/key") or "key"
/// and replace it with the given object's attributes.
///
/// If the object is a model, updates the model's revision and returns the model.
///
@ -401,6 +405,7 @@ _.extend(Repository.prototype, {
///
/// ```javascript
/// repository.replaceById('test/123345', myNewModel);
/// repository.replaceById('123346', myNewModel);
/// ```
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -469,7 +474,8 @@ _.extend(Repository.prototype, {
/// @startDocuBlock JSF_foxx_repository_updateById
/// `FoxxRepository#updateById(id, object)`
///
/// Find an item by ID and update it with the attributes in the provided object.
/// Find an item by ID ("collection/key") or "key" and update it with the
/// attributes in the provided object.
///
/// If the object is a model, updates the model's revision and returns the model.
///
@ -477,6 +483,7 @@ _.extend(Repository.prototype, {
///
/// ```javascript
/// repository.updateById('test/12131', { newAttribute: 'awesome' });
/// repository.updateById('12132', { newAttribute: 'awesomer' });
/// ```
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////