Home Manual Reference Source Test Repository
import UserFinder from 'opengate-js/src/users/UserFinder.js'
public class | source

UserFinder

Extends:

GenericFinderProvisionGenericFinder → UserFinder

This class allow make get request to user resource into Opengate North API.

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

Find a specify user by a email.

public

Find a specific user with apiKey by a email and password.

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

ProvisionGenericFinder#constructor

Params:

NameTypeAttributeDescription
Reference InternalOpenGateAPI

to the API object.

Public Methods

public findByEmail(email: string): Promise source

Find a specify user by a email. This execute a GET http method

Params:

NameTypeAttributeDescription
email string

Email of the user.

Return:

Promise

public findByEmailAndPassword(email: string, password: string): Promise source

Find a specific user with apiKey by a email and password. This execute a GET http method

Params:

NameTypeAttributeDescription
email string

Email of the user.

password string

password of the user.

Return:

Promise