passport-client
v1.1.1
Published
Passport client for authentication with PassportJS, Passport Laravel, Passport Django, Passport dotNET
Downloads
4
Readme
Librería de Autenticación para Passport
Esta librería proporciona funciones para la gestión de autenticación de usuarios, incluyendo métodos para iniciar sesión, almacenar y recuperar sesiones de autenticación, y obtener autorización para realizar peticiones a servidores protegidos.
Instalación
Para utilizar esta librería, puedes instalarla a través de npm o yarn:
npm install passport-client
ó
yarn add passport-client
Uso
import {
getAuthorization,
clearAuth,
getAuth,
setAuth,
login
} from 'passport-client';
Métodos
getAuth(): Promise<string | null>
Obtiene la sesión de autenticación almacenada.
Retorna: Una cadena que representa la sesión de autenticación si está presente, de lo contrario, retorna null.
setAuth(session: string): Promise<boolean>
Almacena la sesión de autenticación en las cookies.
Parámetros:
- session: Una cadena que representa la sesión de autenticación a almacenar.
Retorna: true si la sesión se almacenó correctamente, de lo contrario, retorna false.
clearAuth(): boolean
Elimina la sesión de autenticación almacenada.
Retorna: true si la sesión se eliminó correctamente, de lo contrario, retorna false.
login(email: string, password: string, server: string): Promise<string | null>
Inicia sesión utilizando las credenciales proporcionadas y almacena la sesión de autenticación.
Parámetros:
- email: El correo electrónico del usuario.
- password: La contraseña del usuario.
- server: La URL del servidor para la autenticación.
Retorna: Una cadena que representa el token de autenticación si el inicio de sesión fue exitoso, de lo contrario, retorna null.
getAuthorization(): Promise<{ Authorization: string } | null>
Obtiene la autorización en formato de objeto para utilizar en las cabeceras de las peticiones a servidores protegidos.
Retorna: Un objeto que contiene la autorización en el formato adecuado para las cabeceras HTTP. Retorna null si no hay sesión de autenticación disponible.