Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Auth

Class representing authentication module

Hierarchy

  • EventEmitter
    • Auth

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create Auth Object

    Parameters

    Returns Auth

Properties

_eventHandlers

_eventHandlers: Record<string, EventHandler[]>

the all event handlers are added. it's a Map data structure(key-value), the key is event type, and the value is event handler.

memberof

EventEmitter

db

db: IDatabase<unknown, IClient>

Database object

settings

settings: Settings

Database Connection Settings

Methods

checkPassword

  • checkPassword(username: string, password: string): Promise<{ doesUserExist: boolean; match: boolean }>

  • Checks if password is correct

    Parameters

    • username: string

      The username to check against

    • password: string

      The password to check

    Returns Promise<{ doesUserExist: boolean; match: boolean }>

connect

createEvent

  • createEvent(type: string, data?: any, once?: boolean): Event

  • create event object.

    memberof

    EventEmitter

    Parameters

    • type: string

      event type

    • Optional data: any
    • Optional once: boolean

    Returns Event

createNewUser

  • createNewUser(username: string, password: string, id?: string): Promise<{ id: string; uniqueUser: boolean; username: string }>

  • Create and add a new user to the database

    Parameters

    • username: string

      Username of user to add

    • password: string

      Password of new user

    • Optional id: string

    Returns Promise<{ id: string; uniqueUser: boolean; username: string }>

deleteUser

  • deleteUser(username: string): Promise<{ deleted: boolean; doesUserExist: boolean }>

  • Deletes given user by username

    Parameters

    • username: string

      Username of user

    Returns Promise<{ deleted: boolean; doesUserExist: boolean }>

fire

  • fire(type: string, data?: any): void

  • fire the specified event, and you can to pass a data. When fired, every handler attached to that event will be executed. But, if it's an once event, listen off it immediately after called handler.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); emitter.fire('change:name', 'new name');

    Parameters

    • type: string

      event type

    • Optional data: any

    Returns void

getHandlers

  • getHandlers(type: string): EventHandler[]

  • get the handlers for the specified event type.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); const handlers = emitter.getHandlers('change:name'); console.log(handlers);

    Parameters

    • type: string

      event type

    Returns EventHandler[]

getUserFromId

  • getUserFromId(id: string): Promise<{ data?: { user_id?: string; username?: string }; doesUserExist: boolean }>

  • Gets user details from id lookup

    Parameters

    • id: string

      ID of user

    Returns Promise<{ data?: { user_id?: string; username?: string }; doesUserExist: boolean }>

getUserFromUsername

  • getUserFromUsername(username: string): Promise<{ data?: { user_id?: string; username?: string }; doesUserExist: boolean }>

  • Gets user details from username lookup

    Parameters

    • username: string

      Username of user

    Returns Promise<{ data?: { user_id?: string; username?: string }; doesUserExist: boolean }>

has

  • has(type: string, handler?: EventHandler): boolean

  • check whether the specified event has been listen on. or check whether the events by type has been listen on, when if only type argument is passed.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); const result = emitter.has('change:name');

    Parameters

    • type: string

      event type

    • Optional handler: EventHandler

    Returns boolean

isUsingConString

  • isUsingConString(): boolean

  • Get if connection string is being used (as opposed to config options)

    Returns boolean

isValidHandler

  • isValidHandler(handler: EventHandler): boolean

  • event handler validator.

    memberof

    EventEmitter

    Parameters

    • handler: EventHandler

      event handler

    Returns boolean

isValidType

  • isValidType(type: string): boolean

  • event type validator.

    memberof

    EventEmitter

    Parameters

    • type: string

      event type

    Returns boolean

off

  • off(type?: string, handler?: EventHandler): void

  • listen off an event by type and handler. or listen off events by type, when if only type argument is passed. or listen off all events, when if no arguments are passed.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); // listen off the specified event emitter.off('change:name', evt => { console.log(evt); }); // listen off events by type emitter.off('change:name'); // listen off all events emitter.off();

    Parameters

    • Optional type: string
    • Optional handler: EventHandler

    Returns void

offAll

  • offAll(): void

  • listen off all events, that means every event will be emptied.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); emitter.offAll();

    Returns void

on

  • on(type: string, handler: EventHandler): boolean

  • listen on a new event by type and handler. if listen on, the true is returned, otherwise the false. The handler will not be listen if it is a duplicate.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); emitter.on('change:name', evt => { console.log(evt); });

    Parameters

    • type: string

      event type, it must be a unique string.

    • handler: EventHandler

      event handler, when if the same handler is passed, listen it by only once.

    Returns boolean

once

  • once(type: string, handler: EventHandler): boolean

  • listen on an once event by type and handler. when the event is fired, that will be listen off immediately and automatically. The handler will not be listen if it is a duplicate.

    memberof

    EventEmitter

    example

    const emitter = new EventEmitter(); emitter.once('change:name', evt => { console.log(evt); });

    Parameters

    • type: string

      event type, it must be a unique string.

    • handler: EventHandler

      event handler, when if the same handler is passed, listen it by only once.

    Returns boolean

Generated using TypeDoc