@machb/user-interactors v0.0.2-SNAPSHOT
@machb/user-interactors / UserService
Interface: UserService
Defined in: stud/UserService.ts:7
Interface for user-related operations within the system. Provides methods for user signup, login, and retrieval by ID.
Methods
getUserById()
getUserById(
id,user):Promise\<User>
Defined in: stud/UserService.ts:31
Retrieves a user by their unique identifier.
Parameters
id
string
The unique identifier (string) of the user to retrieve.
user
User
The User object to manage additional user-related behaviors such as permissions or context.
Returns
Promise\<User>
A promise resolving to the User object with the requested ID.
signin()
signin(
user):Promise\<User>
Defined in: stud/UserService.ts:22
Authenticates a user and generates a session or access token.
Parameters
user
User
The User object containing credentials such as email and password for signin.
Returns
Promise\<User>
A promise resolving to an authenticated User object.
signup()
signup(
user):Promise\<User>
Defined in: stud/UserService.ts:14
Registers a new user in the system.
Parameters
user
User
The User object containing user details for signup.
Returns
Promise\<User>
A promise resolving to the newly created User object.