@feathersjs/authentication-local
- Version 5.0.29
- Published
- 75.1 kB
- 6 dependencies
- MIT license
Install
npm i @feathersjs/authentication-local
yarn add @feathersjs/authentication-local
pnpm add @feathersjs/authentication-local
Overview
Local authentication strategy for @feathers/authentication
Index
Variables
variable hooks
const hooks: { hashPassword: ( field: string, options?: HashPasswordOptions ) => (context: HookContext, next?: NextFunction) => Promise<any>; protect: ( ...fields: string[] ) => (context: HookContext, next?: NextFunction) => Promise<void>;};
Functions
function passwordHash
passwordHash: (options: { service?: string; strategy: string;}) => <H extends HookContext<any, any>>( value: string | undefined, _data: any, context: H) => Promise<any>;
Returns as property resolver that hashes a given plain text password using a Local authentication strategy.
Parameter options
The authentication
service
andstrategy
nameReturns
Classes
class LocalStrategy
class LocalStrategy extends AuthenticationBaseStrategy {}
property configuration
readonly configuration: any;
method authenticate
authenticate: ( data: AuthenticationRequest, params: Params) => Promise<{ [x: number]: any; authentication: { strategy: any } }>;
method comparePassword
comparePassword: (entity: any, password: string) => Promise<any>;
method findEntity
findEntity: (username: string, params: Params) => Promise<any>;
method getEntity
getEntity: (result: any, params: Params) => Promise<any>;
method getEntityQuery
getEntityQuery: (query: Query, _params: Params) => Promise<any>;
method hashPassword
hashPassword: (password: string, _params: Params) => Promise<any>;
method verifyConfiguration
verifyConfiguration: () => void;
Package Files (2)
Dependencies (6)
Dev Dependencies (10)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@feathersjs/authentication-local
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@feathersjs/authentication-local)
- HTML<a href="https://www.jsdocs.io/package/@feathersjs/authentication-local"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3768 ms. - Missing or incorrect documentation? Open an issue for this package.