Users
Resource class for interacting with users.
Class: Users
Resource class for interacting with users.
Extends
Constructors
Constructor
new Users(
api):Users
Create a new resource.
Parameters
api
API client instance used to communicate with WriftAI's API.
Returns
Users
Inherited from
Methods
get()
get(
username,signal?):Promise<UserWithDetails>
Fetch a user by their username.
Parameters
username
string
The username of the user.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<UserWithDetails>
The user object.
list()
list(
options?,signal?):Promise<PaginatedResponse<UserWithDetails>>
List users.
Parameters
options?
Optional settings to control pagination behavior.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<PaginatedResponse<UserWithDetails>>
Paginated response containing users and navigation metadata.
search()
search(
q,options?,signal?):Promise<PaginatedResponse<UserWithDetails>>
Search users.
Parameters
q
string
The search query.
options?
Optional settings to control pagination behavior.
signal?
AbortSignal
Optional AbortSignal to cancel the request.
Returns
Promise<PaginatedResponse<UserWithDetails>>
Paginated response containing users and navigation metadata.