# Repository
used to perform CRUD operations on an entityType
# find
returns a result array based on the provided options
Arguments:
- options
limit - Determines the number of rows returned by the request, on the browser the default is 100 rows
example
await this.remult.repo(Products).find({ limit:10, page:2 })
page - Determines the page number that will be used to extract the data
example
await this.remult.repo(Products).find({ limit:10, page:2 })
load
where - filters the data
example
await taskRepo.find({where: { completed:false }})
see For more usage examples see EntityFilter (opens new window)
orderBy - Determines the order of items returned .
example
await this.remult.repo(Products).find({ orderBy: { name: "asc" }})
example
await this.remult.repo(Products).find({ orderBy: { price: "desc", name: "asc" }})
# liveQuery
returns a result array based on the provided options
Arguments:
- options
limit - Determines the number of rows returned by the request, on the browser the default is 100 rows
example
await this.remult.repo(Products).find({ limit:10, page:2 })
page - Determines the page number that will be used to extract the data
example
await this.remult.repo(Products).find({ limit:10, page:2 })
load
where - filters the data
example
await taskRepo.find({where: { completed:false }})
see For more usage examples see EntityFilter (opens new window)
orderBy - Determines the order of items returned .
example
await this.remult.repo(Products).find({ orderBy: { name: "asc" }})
example
await this.remult.repo(Products).find({ orderBy: { price: "desc", name: "asc" }})
# findFirst
returns the first item that matchers the where
condition
example
await taskRepo.findFirst({ completed:false })
example
await taskRepo.findFirst({ completed:false },{ createIfNotFound: true })
Arguments:
where - filters the data
options
load
where - filters the data
example
await taskRepo.find({where: { completed:false }})
see For more usage examples see EntityFilter (opens new window)
orderBy - Determines the order of items returned .
example
await this.remult.repo(Products).find({ orderBy: { name: "asc" }})
example
await this.remult.repo(Products).find({ orderBy: { price: "desc", name: "asc" }})
useCache - determines if to cache the result, and return the results from cache.
createIfNotFound - If set to true and an item is not found, it's created and returned
# findId
returns the items that matches the idm the result is cached unless specified differently in the options
parameter
Arguments:
- id
- options
- useCache - determines if to cache the result, and return the results from cache.
- createIfNotFound - If set to true and an item is not found, it's created and returned
# query
An alternative form of fetching data from the API server, which is intended for operating on large numbers of entity objects.
example
for await (const task of taskRepo.query()) {
// do something.
}
Arguments:
- options
load
where - filters the data
example
await taskRepo.find({where: { completed:false }})
see For more usage examples see EntityFilter (opens new window)
orderBy - Determines the order of items returned .
example
await this.remult.repo(Products).find({ orderBy: { name: "asc" }})
example
await this.remult.repo(Products).find({ orderBy: { price: "desc", name: "asc" }})
pageSize - The number of items to return in each step
progress - A callback method to indicate the progress of the iteration
# count
Returns a count of the items matching the criteria.
see EntityFilter (opens new window)
example
await taskRepo.count({ completed:false })
Arguments:
where - filters the data
# save
saves an item or item[] to the data source. It assumes that if an id
value exists, it's an existing row - otherwise it's a new row
example
await taskRepo.save({...task, completed:true })
Arguments:
- item
# insert
Insert an item or item[] to the data source
example
await taskRepo.insert({title:"task a"})
example
await taskRepo.insert([{title:"task a"}, {title:"task b", completed:true }])
Arguments:
- item
# update
Updates an item, based on its id
example
taskRepo.update(task.id,{...task,completed:true})
Arguments:
- id
- item
# delete
Deletes an Item
Arguments:
- id
# create
Creates an instance of an item. It'll not be saved to the data source unless save
or insert
will be called for that item
Arguments:
- item
# fromJson
Translates a json object to an item instance
Arguments:
- x
- isNew
# getEntityRef
returns an entityRef
for an item returned by create
, find
etc...
Arguments:
- item
# metadata
The metadata for the entity
see EntityMetadata (opens new window)
# addEventListener
- addEventListener
Arguments:
- listener