npm i lexx-odata-query-builder
const o = new QueryBuilder('http://site.com/api/users')
o.toString()
Output
http://site.com/api/users
Or with custom query params
const o = new QueryBuilder('http://site.com/api/users')
o.querySet('lang', 'en')
o.toString()
Output
http://site.com/api/users?lang=en
If you use query builder to create url for axios or another http client, you can pass only path to script, without origin
const o = new QueryBuilder('/users')
o.querySet('lang', 'en')
o.toString()
Output
/users?lang=en
Use order
method to add order query parameters
Note:
order
method has an aliasorderby
const o = new QueryBuilder('/users')
o.order(new QueryOrder('name1')).toString()
Output
/users?$orderby=name1 asc
Also, you can combine several order conditions
const o = new QueryBuilder('/users')
o.order(new QueryOrder('name1')).order(new QueryOrder('name2', QueryOrderDirection.DESC))
o.toString()
Output
/users?$orderby=name1 asc,name2 desc
Use expand
method to add expand query parameter
const o = new QueryBuilder('/users')
o.expand('company').toString()
Output
/users?$expand=company
Or combine several expand parameters
const o = new QueryBuilder('/users')
o.expand('company').expand('jobtitle').toString()
Output
/users?$expand=company,jobtitle
To add counter to expanding parameter, add true
as second parameter of expand
method
const o = new QueryBuilder('/users')
o.expand('emails', true).toString()
Output
/users?$expand=company($count=true)
For limiting returned data, use limit
and offset
methods
Note:
limit
has an aliastop
offset
has aliasesskip
andshift
const o = new QueryBuilder('/users')
o.top(7).skip(4).toString()
Output
/users?$top=7&$skip=4
To limit output data by page, use page
method.
const o = new QueryBuilder('/users')
o.page(3).toString()
Output
/users?$top=10&$skip=20
By default, it has 10 records per page, but you free to change in via QueryBuilder configuration.
const o = new QueryBuilder('/users', {rowsPerPage: 5})
o.page(3).toString()
Output
/users?$top=5&$skip=10
Use filter
method to add constrains. QueryBuilder accept only one filter, but you free to use and
and or
methods of QueryFilter to combine them together.
const oFilter = new QueryFilter('gender', 'f')
oFilter.and('age', 16, QueryFilterSign.GT)
const o = new QueryBuilder('/users')
o.filter(oFilter).toString()
Output
/users?$filter=gender eq f and age gt 16
- [X] EQ
- [X] GT
- [X] GE
- [X] LT
- [X] LE
- [ ] NE
- [X] SUBSTRINGOF
- [X] STARTSWITH
- [X] ENDSWITH
count
method will add $count
suffix to url
const o = new QueryBuilder('/users')
o.count().toString()
Output
/users/$count
Of course, you can use count
with filter
for example.
const oFilter = new QueryFilter('gender', 'f')
oFilter.and('age', 16, QueryFilterSign.GT)
const o = new QueryBuilder('/users')
o.filter(oFilter).count().toString()
Output
/users/$count?$filter=gender eq f and age gt 16
ID is primary key of database. Use id
method to create oData request for single entity.
const o = new QueryBuilder('/users')
o.id(4).toString()
Output
/users(4)
Use select
method to constrain returned fields
const o = new QueryBuilder('/users')
o.select(['id', 'name']).toString()
Output
/users?$select=id,name
Use count
method to get request for count value
const o = new QueryBuilder('/users')
o.count()
Output `/users/$count
Other-hand, if you want to make request of data with total count, you can use inlineCount
method
Use count
method to get request for count value
const o = new QueryBuilder('/users')
o.inlineCount()
Output `/users?$count=true
Free-text search parameter, which was added for OData v4.0
const o = new QueryBuilder('/users')
o.search('John Doe')
Output `/users?$search=John Doe
Getting the file content is extra path. It will not make effect to real oData server, but you can use it in development as ideology.
To get file content, call asFileContent
method
const o = new QueryBuilder('/files')
o.id(4).asFileContent().toString()
Output
/files(4)/_file
Sometimes needed to get base64 encoded content. Use asFileContentBase64
method to generate path
const o = new QueryBuilder('/files')
o.id(4).asFileContentBase64().toString()
Output
/files(4)/_file64
For case if you already have url, and you want to add or change some parameter, you may use parse
method, to parse url
and get instance of QueryBuilder
const o = QueryBuilder.parse(`/employee`)
consle.log(o.toString())
Output
/employee
Or, if you use full url
const o = QueryBuilder.parse(`http://site.com/api/users`)
consle.log(o.toString())
Output
/users
Output is short, because parse
method get only script path. To get full url, add true
as second parameter, to tell
parser save url as is
const o = QueryBuilder.parse(`http://site.com/api/users`)
consle.log(o.toString())
Output
http://site.com/api/users
Of-cause, you can use this method to parse url with query
const o = QueryBuilder.parse(`/users?$count=true`)
consle.log(o.toString())
Output
/users?$count=true