resource-account

for managing accounts

npm install resource-account
8 downloads in the last month

account

for managing accounts

Features

  • Signups
  • Confirmations
  • Password Resets

API

properties

methods

properties

for managing accounts

  • id

    • type : any
  • email

    • type : string

    • format : email

    • required : true

  • password

    • type : string

    • format : password

    • required : false

  • status

    • description : the current status of the account

    • type : string

    • enum

      • 0 : new

      • 1 : active

      • 2 : inactive

      • 3 : disabled

    • default : new

  • token

    • description : unique access token for the account. used for account confirmations and password resets

    • type : string

    • private : true

    • default :

methods

account.create(options, callback)

create a new account

  • options

    • type : object

    • properties

      • id

        • type : any
      • email

        • type : string

        • format : email

        • required : true

      • password

        • type : string

        • format : password

        • required : false

      • status

        • description : the current status of the account

        • type : string

        • enum

          • 0 : new

          • 1 : active

          • 2 : inactive

          • 3 : disabled

        • default : new

      • token

        • description : unique access token for the account. used for account confirmations and password resets

        • type : string

        • private : true

        • default :

  • callback

    • type : function

account.get(id, callback)

get account by id

  • id

    • type : any

    • description : the id of the object

    • required : true

  • callback

    • type : function

account.find(options, callback)

search for instances of account

  • options

    • type : object

    • properties

      • id

        • type : any

        • default :

        • required : false

      • email

        • type : any

        • required : false

        • default :

      • password

        • type : any

        • required : false

        • default :

      • status

        • description : the current status of the account

        • type : any

        • default :

        • required : false

      • token

        • description : unique access token for the account. used for account confirmations and password resets

        • type : any

        • private : true

        • default :

        • required : false

  • callback

    • type : function

account.all(callback)

gets all instances of account

  • callback

    • type : function

account.update(options, callback)

updates a account by id

  • options

    • type : object

    • properties

      • id

        • type : any
      • email

        • type : string

        • format : email

        • required : true

      • password

        • type : string

        • format : password

        • required : false

      • status

        • description : the current status of the account

        • type : string

        • enum

          • 0 : new

          • 1 : active

          • 2 : inactive

          • 3 : disabled

        • default : new

      • token

        • description : unique access token for the account. used for account confirmations and password resets

        • type : string

        • private : true

        • default :

  • callback

    • type : function

account.updateOrCreate(options, callback)

updates a account by id, and creates if necessary

  • options

    • type : object

    • properties

      • id

        • type : any
      • email

        • type : string

        • format : email

        • required : true

      • password

        • type : string

        • format : password

        • required : false

      • status

        • description : the current status of the account

        • type : string

        • enum

          • 0 : new

          • 1 : active

          • 2 : inactive

          • 3 : disabled

        • default : new

      • token

        • description : unique access token for the account. used for account confirmations and password resets

        • type : string

        • private : true

        • default :

  • callback

    • type : function

account.destroy(id, callback)

destroys a account by id

  • id

    • type : string

    • description : the id of the object

    • required : true

  • callback

    • type : function

account.confirm(token)

confirms a new account based on access token

  • token

    • type : string

    • description : access token

    • required : true

    • message : access token is required to confirm account

account.reset(email)

resets access token for account

  • email

    • type : string

    • format : email

    • required : true

account.auth(id, password)

checks id and password for an account ( auth check )

  • id

    • type : string

    • required : true

  • password

    • type : string

    • required : true

README auto-generated with docs

npm loves you