Home Reference Source

References

summary
public	F setup(app: Express, config: Config) Library entry point

auth

summary
public	C Auth Authenticator/passport strategy wrapper abstraction.
public	C EmailAuth Email based login.
public	C FacebookAuth OAuth login using facebook login provider
public	C GithubAuth OAuth login using githuhb login provider
public	C GoogleAuth OAuth login using google login provider
public	C LinkedinAuth OAuth login using linkedin login provider
public	C NoAuth Allows login without any form of credential exchange.

crypt

summary
public	C Crypt Abstract class for taking care of password hashing and verification.
public	C PBKDF2 Use crypto.pbkdf2
public	C SCRYPT Use scrypt.

email

summary
public	C EmailFilter An email filter validates an email address
public	C EmailSender An email sender sends an email
public	C NodeEmailSender Stub email sending that prints to console instead of sending email.
public	C NodeEmailSender Send email using node.js sendmail.
public	C SESEmailSender Send email using AWS SES.

fields

summary
public	F async assign(user: , field: , value: , fieldMeta: , loginUser: *)
public	F async assign(user: , field: , value: , fieldMeta: , loginUser: *)
public	F async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	F async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	F async assign(user: , field: , value: , fieldMeta: , loginUser: , config: )
public	F checkStrongPassword(password: *): boolean
public	F generate(length: number): string generate strong password
public	V order: number
public	V type: string
public	V enabled: boolean
public	V order: number
public	V type: string
public	V mask: boolean
public	V order: number
public	V type: string
public	V order: number
public	V self: boolean
public	V type: string

filters

summary
public	F parse(searchMetadata: SearchMetadata, query: Query): ParsedQuery Validate and parse Request.query against what is acceptable from a SearchMetadata specification

helper

summary
public	F LOGGEDIN(req: , res: , next: ): Express middleware for blocking non-logged in users
public	F audit(source: string, event: string, params: string) Fill in method for audit logging
public	F bootstrap(app: , config: ): ExpressMiddleware Out boilerplate to make things easier.
public	F callback(fn: Function, args: *): Promise Calls a callback caller that calls a callback call for async instead of using promises.
public	F defer(fn: Function, args: *) Call a function later.
public	F error(res: Response, message: string \| object, audit: string, extra: string) Return error status and payload as response.
public	F escape(content: string): string Encodes unencoded bits of string.
public	F generateId(): string Helper method that generates a new user id.
public	F reject(res: Response, audit: string, extra: string): * Returns a function that calls res.error
public	F resolve(res: Response, promiseObj: Promise, message: string \| object, audit: string, extra: string) Monitors a Promise and returns success or error based on promise outcome.
public	F success(res: Response, message: string \| object, audit: string, extra: string) Return success status and payload as response.

restriction

summary
public	F failure(settings: object): ExpressMiddlewareFunction Implementation of failure aware rate restriction.
public	F recaptcha(settings: object): ExpressMiddlewareFunction Implementation of reCAPTCHA rate restriction.

session

summary
public	C CollectionSessionStore Drop in replacement for express session store that saves session data in a collection.
public	C MemorySessionStore In memory session store.

Directories