Skip to main content

Count

Basic

This method interacts with the Basic Count endpoint to count a set of resources.

Usage

const response = await userService.count();

Parameters

ParameterTypeDescription
axiosRequestConfigAxiosRequestConfig (optional)Axios request configuration for fine-tuning the HTTP request.

Response

PropTypeDescription
successbooleanIndicates whether the request was successful.
statusnumberHTTP status code of the response.
messagestringA message providing additional information about the response, especially in case of errors.
rawnumberThe count of resources.
datanumberThe count of resources.
headersobject[AxiosHeaders]Axios headers associated with the response.
{
success: true,
status: 200,
raw: 2,
data: 2,
headers: Object [AxiosHeaders] {}
}

Advanced

This method interacts with the Advanced Update endpoint to count a set of resources with advanced options.

Usage

const response = await userService.countAdvanced({ name: 'John' });

Parameters

ParameterTypeDescription
filterFilterQueryFilter query to narrow down the resources for counting.
args{ access?: string } (optional)Advanced arguments for controlling the count operation.
axiosRequestConfigAxiosRequestConfig (optional)Axios request configuration for fine-tuning the HTTP request.

Response

PropTypeDescription
successbooleanIndicates whether the request was successful.
statusnumberHTTP status code of the response.
messagestringA message providing additional information about the response, especially in case of errors.
rawnumberThe count of resources.
datanumberThe count of resources.
headersobject[AxiosHeaders]Axios headers associated with the response.
{
success: true,
status: 200,
raw: 2,
data: 2,
headers: Object [AxiosHeaders] {}
}