Kind: global class
The constructor takes in a modelEntity, entity, query, and validStringFilter
Param | Type | Description |
---|---|---|
modelEntity | PrismaModelDelegate |
This is the prisma entity e.g this.prisma.shoppingItem |
entity | TModelEntity |
This is the entity that you want to query. it also contains all the settings for filtering and selecting of data |
[query] | IQueryFields |
This is the query string fields from the api. |
validStringFilter | Array.<PrismaValidStringFilter> |
This is an array of PrismaValidStringFilter. This is used to validate the string filter. |
keysakes a query string, parses it into an object, and then recursively filters out any invalid
Kind: instance method of ApiQueryBuilder
Returns: The builder object with the filter property set to the validFilterObj.
the sortable columnsery parameter, splits it into an array, and then filters it to only include
Kind: instance method of ApiQueryBuilder
Returns: The builder object
whether the column was selected or notmn names and the values being true
or false
depending on
Kind: instance method of ApiQueryBuilder
Returns: The builder object
property to the knex query builderparameter called include
then we will add the select
Kind: instance method of ApiQueryBuilder
Returns: The builder object with the select property set to the selectables object.
take values for the paginationom the query string, and then uses them to calculate the skip and
Kind: instance method of ApiQueryBuilder
properties. The builder object with the paginate property set to an object with skip and take
them to the builderObj propertyselect, and sort properties from the builder object and assigns
Kind: instance method of ApiQueryBuilder
Returns: The builder object
query.unction sorts, filters, selects, populates, and paginates the query, and then returns the
Kind: instance method of ApiQueryBuilder
Returns: The query object.
It returns a paginated object with the data and the paginated object
Kind: instance method of ApiQueryBuilder
Returns: An object with two properties: data and paginated.
and returns the data and paginated objectatch the filter, calculates the total number of pages,ct,
| --- | --- | --- |
| selectables | Array.<string>
| string[] - an array of strings that are the selectable options |
| array | Array.<string>
| string[] - the array of strings to convert to a boolean object |
it's empty filter object, picks only the valid keys, and then recursively filters the object until
Kind: instance method of ApiQueryBuilder
Param | Type | Description |
---|---|---|
filterObj | object |
object - The object that you want to filter. |