iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Class: JSONUserDatabase

user.JSONUserDatabase

JSON file-based user database

Implements

Table of contents

Constructors

Methods

Constructors

constructor

• new JSONUserDatabase(dataPath?)

Parameters

Name Type Default value
dataPath string "./data/users"

Defined in

core/src/user.ts:132

Methods

create

▸ create(userData): null | IUserData

Parameters

Name Type
userData Partial<IUserData>

Returns

null | IUserData

Implementation of

IUserDatabase.create

Defined in

core/src/user.ts:183


delete

▸ delete(handle): boolean

Parameters

Name Type
handle string

Returns

boolean

Implementation of

IUserDatabase.delete

Defined in

core/src/user.ts:230


exists

▸ exists(handle): boolean

Parameters

Name Type
handle string

Returns

boolean

Implementation of

IUserDatabase.exists

Defined in

core/src/user.ts:243


findByEmail

▸ findByEmail(email): null | IUserData

Parameters

Name Type
email string

Returns

null | IUserData

Implementation of

IUserDatabase.findByEmail

Defined in

core/src/user.ts:251


getNextId

▸ getNextId(): number

Returns

number

Implementation of

IUserDatabase.getNextId

Defined in

core/src/user.ts:261


list

▸ list(): IUserData[]

Returns

IUserData[]

Implementation of

IUserDatabase.list

Defined in

core/src/user.ts:247


load

▸ load(handle): null | IUserData

Parameters

Name Type
handle string

Returns

null | IUserData

Implementation of

IUserDatabase.load

Defined in

core/src/user.ts:167


save

▸ save(user): boolean

Parameters

Name Type
user IUserData

Returns

boolean

Implementation of

IUserDatabase.save

Defined in

core/src/user.ts:171