1.0.5 • Published 4 years ago
authbymaxime v1.0.5
What is this ?
AuthByMaxime is a package JSON wich help you to easily set up an authentication system in your website.
How it works ?
This package just needs some details, like the user's email or his password and that's it. All the logical part is managing by the packet.
How to use it ?
npm i authbymaxime --save
What can I use with this package ?
functions
login(email, password)
Login to an account for an user
Kind: global function
| Param | Type | Description |
|---|---|---|
| string | ||
| password | string | password |
register(username, email, password)
Create an account for an user
Kind: global function
| Param | Type | Description |
|---|---|---|
| username | string | username |
| string | ||
| password | string | password |
checkLogin(token)
Check if the user is logged - MIDDLEWARE
Kind: global function
| Param | Type | Description |
|---|---|---|
| token | string | token - Token of the user, he gets it after register or login. |
loosingPassword(email)
Kind: global function
| Param | Description |
|---|---|
| : |