Skip to main content
Skip to main content

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:

{example-code}

To specify relations that should be retrieved within the {type name}:

{example-code}

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:

{example-code}

Parameters

The filters to apply on the retrieved user.
The configurations determining how the user is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a user.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[UserDTO[], number]>Required
The list of users along with their total count.
Was this section helpful?