Client - Operations
Eicrud's client allows you to call service methods and commands over HTTP. It uses Axios under the hood.
Note
When using the client, security rules and Validations/Transforms are applied. These checks happen at the controller level.
Create Operations
create
Create a new entity.
const newProfile: Partial<Profile> = {
userName: "Jon Doe",
owner: '4d3ed089fb60ab534684b7e9'
}
await profileClient.create(newProfile);
createBatch
Create new entities.
const newProfiles: Partial<Profile>[] = [
{
userName: "Jon Doe",
owner: '507f1f77bcf86cd799439011'
},
{
userName: "Sarah Doe",
owner: '507f191e810c19729de860ea'
},
]
await profileClient.createBatch(newProfiles);
Info
Non-admin roles are not allowed to perform batch operations unless maxBatchSize is specified in the service security.
Note
Batch operations make use of the ClientOptions->batchSize
. If the provided array exceeds that limit, the client will split it and perform multiple requests.
Read Operations
findOne
Find an entity.
const query: Partial<Profile> = {
userName: "Jon Doe",
}
const res: Profile = await profileClient.findOne(query);
find
Find entities.
const query: Partial<Profile> = {
astroSign: "Aries"
}
const {data, total, limit} = await profileClient.find(query);
Note
CrudServices have an enforced limit for find operations. If you don't specify a limit in the options, the clients will call the server repeatedly until it fetches all the results.
findIn
Find entities with IDs included in the provided list.
const ids = ['4d3ed089fb60ab534684b7e9', '4d3ed089fb60ab534684b7ff']
const {data, total, limit} = await profileClient.findIn(ids);
Note
In queries also make use of the ClientOptions->batchSize
and will split the IDs if needed.
You can pass a limited query to findIn:
const query = {
id: ['4d3ed089fb60ab534684b7e9', '4d3ed089fb60ab534684b7ff'],
astroSign: "Aries"
}
const {data, total, limit} = await profileClient.findIn(query);
Note
Limited queries are useful when you have security rules.
findIds
Return IDs of entities that match a query.
const query: Partial<Profile> = {
astroSign: "Aries"
}
const {data, total, limit} = await profileClient.findIds(query);
const IDs: string[] = data;
Note
findIds
queries have a higher allowed limit than find
queries. This is because returning only IDs has a smaller cost on the server than returning whole entities.
Update Operations
patchOne
Update an existing entity.
const query: Partial<Profile> = {
id: user.profileId
}
const update: Partial<Profile> = {
bio: "Hello world"
}
await profileClient.patchOne(query, update);
Note
patchOne
will throw if the queried entity doesn't exist.
patch
Update every entity that matches a query.
const query: Partial<Profile> = {
astroSign: "Aries"
}
const update: Partial<Profile> = {
bio: "Is passionate and motivated."
}
await profileClient.patch(query, update);
Note
patch
returns the number of entities affected by the operation
patchIn
Update entities with IDs included in the provided list.
const ids = ['4d3ed089fb60ab534684b7e9', '4d3ed089fb60ab534684b7ff']
const update: Partial<Profile> = {
bio: "Is nice."
}
await profileClient.patch(query, update);
patchBatch
Perform multiple patch
operations.
const updates = [
{
query: {
astroSign: "Leo"
},
data: {
bio: "Is generous."
}
},
{
query: {
astroSign: "Taurus"
},
data: {
bio: "Is relaxed."
}
},
]
await profileClient.patchBatch(updates);
You can also call saveBatch
which automatically creates queries depending on provided limiting fields.
const updates = [
{
astroSign: "Leo",
bio: "Is generous."
},
{
astroSign: "Taurus",
bio: "Is relaxed."
},
]
await profileClient.saveBatch(['astroSign'], updates);
Note
The id_field
if present, will always be passed to the query.
Delete Operations
removeOne
Delete an entity.
Note
removeOne
will throw if the queried entity doesn't exist.
remove
Remove every entity that matches a query.
Note
remove
returns the number of entities affected by the operation
removeIn
Remove entities with IDs included in the provided list.
const ids = ['4d3ed089fb60ab534684b7e9', '4d3ed089fb60ab534684b7ff']
await profileClient.deleteIn(query, ctx);
Commands
cmd
Call a service command:
cmdL
Call a limited command:
const dto = { nameLike: 'Jon'};
const {data, total, limit} = await profileClient.cmdL('search', dto);
Note
Like find operations, call to cmdL
will fetch repeatedly if no limit is specified.
cmdS / cmdSL
Call a command in secure mode.
const dto = { nameLike: 'Jon'};
const {data, total, limit} = await profileClient.cmdSL('secure_search', dto);
Note
When in secure mode, ctx.user
is fetched from the database instead of the cache, ensuring up-to-date data.