Skip to main content

Function: listUsers()

function listUsers(page): Promise<object>

Reads full Auth.js user records backed by Flashcore.

Parameters

ParameterTypeDefault valueDescription
pagenumber0Zero-based page index; defaults to the first page.

Returns

Promise<object>

List of users alongside pagination metadata.

page

page: number;

pageCount

pageCount: number;

total

total: number;

users

users: Session[];

Examples

const { users } = await listUsers(2)
const { users, pageCount } = await listUsers()
if (pageCount > 1) console.log('paginate')