listAndCount - User Module Reference
This documentation provides a reference to the listAndCount
method. This belongs to the User Module.
This method retrieves a paginated list of user along with the total count of available users satisfying the provided filters.
Example
To retrieve a list of {type name} using their IDs:
To specify relations that should be retrieved within the {type name}:
By default, only the first {default limit}
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
Parameters
filters
FilterableUserPropsThe filters to apply on the retrieved user.
filters
FilterableUserPropsconfig
FindConfig<UserDTO>The configurations determining how the user is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a user.
config
FindConfig<UserDTO>select
or relations
, accept the
attributes or relations associated with a user.Returns
The list of users along with their total count.
Was this section helpful?