Skip to content

Commit cbbdb99

Browse files
committed
Update examples
1 parent ff17c9a commit cbbdb99

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ npm run dist
4141

4242
```js
4343
// ES2015-style
44-
import arangojs, {Database, aqlQuery} from 'arangojs';
44+
import arangojs, {Database, aql} from 'arangojs';
4545
let db1 = arangojs(); // convenience short-hand
4646
let db2 = new Database();
47-
let {query, bindVars} = aqlQuery`RETURN ${Date.now()}`;
47+
let {query, bindVars} = aql`RETURN ${Date.now()}`;
4848

4949
// or plain old Node-style
5050
var arangojs = require('arangojs');
5151
var db1 = arangojs();
5252
var db2 = new arangojs.Database();
53-
var aql = arangojs.aqlQuery(['RETURN ', ''], Date.now());
53+
var aql = arangojs.aql(['RETURN ', ''], Date.now());
5454
var query = aql.query;
5555
var bindVars = aql.bindVars;
5656
```
@@ -119,7 +119,7 @@ try {
119119
* [database.transaction](#databasetransaction)
120120
* [Queries](#queries)
121121
* [database.query](#databasequery)
122-
* [aqlQuery](#aqlquery)
122+
* [aql](#aql)
123123
* [Managing AQL user functions](#managing-aql-user-functions)
124124
* [database.listFunctions](#databaselistfunctions)
125125
* [database.createFunction](#databasecreatefunction)
@@ -700,8 +700,8 @@ var db = require('arangojs')();
700700
var active = true;
701701

702702
// Using ES2015 string templates
703-
var aqlQuery = require('arangojs').aqlQuery;
704-
db.query(aqlQuery`
703+
var aql = require('arangojs').aql;
704+
db.query(aql`
705705
FOR u IN _users
706706
FILTER u.authData.active == ${active}
707707
RETURN u.user
@@ -738,9 +738,9 @@ db.query(
738738
});
739739
```
740740
741-
#### aqlQuery
741+
#### aql
742742
743-
`aqlQuery(strings, ...args): Object`
743+
`aql(strings, ...args): Object`
744744
745745
Template string handler for AQL queries. Converts an ES2015 template string to an object that can be passed to `database.query` by converting arguments to bind variables.
746746
@@ -750,10 +750,10 @@ Any *Collection* instances will automatically be converted to collection bind va
750750
751751
```js
752752
var db = require('arangojs')();
753-
var aqlQuery = require('arangojs').aqlQuery;
753+
var aql = require('arangojs').aql;
754754
var userCollection = db.collection('_users');
755755
var role = 'admin';
756-
db.query(aqlQuery`
756+
db.query(aql`
757757
FOR user IN ${userCollection}
758758
FILTER user.role == ${role}
759759
RETURN user
@@ -811,15 +811,15 @@ Creates an AQL user function with the given *name* and *code* if it does not alr
811811
812812
```js
813813
var db = require('arangojs')();
814-
var aqlQuery = require('arangojs').aqlQuery;
814+
var aql = require('arangojs').aql;
815815
db.createFunction(
816816
'ACME::ACCOUNTING::CALCULATE_VAT',
817817
String(function (price) {
818818
return price * 0.19;
819819
})
820820
)
821821
// Use the new function in an AQL query with template handler:
822-
.then(() => db.query(aqlQuery`
822+
.then(() => db.query(aql`
823823
FOR product IN products
824824
RETURN MERGE(
825825
{vat: ACME::ACCOUNTING::CALCULATE_VAT(product.price)},

0 commit comments

Comments
 (0)