Socket
Socket
Sign inDemoInstall

bedrock-account

Package Overview
Dependencies
Maintainers
6
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bedrock-account

User accounts for Bedrock applications


Version published
Weekly downloads
0
decreased by-100%
Maintainers
6
Weekly downloads
 
Created
Source

bedrock-account

User accounts for Bedrock Applications

API Reference

bedrock-account

  • bedrock-account
    • .insert(options)Promise
    • .exists(options)Promise
    • .get(options)Promise
    • .getAll(options)Promise
    • .update(options)Promise
    • .setStatus(options)Promise

bedrock-account.insert(options) ⇒ Promise

Inserts a new account. The account must contain id.

Kind: static method of bedrock-account
Returns: Promise - Resolves to the database account record.

ParamTypeDescription
optionsobjectThe options to use.
options.accountobjectThe account containing at least the minimum required data.
[options.meta]objectThe meta information to include.

bedrock-account.exists(options) ⇒ Promise

Check for the existence of an account.

Kind: static method of bedrock-account
Returns: Promise - Resolves to a boolean indicating account existence.

ParamTypeDefaultDescription
optionsobjectThe options to use.
[options.id]stringThe ID of the account to check.
[options.email]stringThe email address for the account.
[options.status]string"active"The status to check for (options: 'active', deleted').

bedrock-account.get(options) ⇒ Promise

Retrieves an account.

Kind: static method of bedrock-account
Returns: Promise - Resolves to {account, meta}.

ParamTypeDescription
optionsobjectThe options to use.
options.idstringThe ID of the account to retrieve.

bedrock-account.getAll(options) ⇒ Promise

Retrieves all accounts matching the given query.

Kind: static method of bedrock-account
Returns: Promise - Resolves to the records that matched the query.

ParamTypeDefaultDescription
optionsobjectThe options to use.
[options.query]object{}The query to use.
[options.options]object{}The options (eg: 'sort', 'limit').

bedrock-account.update(options) ⇒ Promise

Updates an account.

Kind: static method of bedrock-account
Returns: Promise - Resolves once the operation completes.

ParamTypeDescription
optionsobjectThe options to use.
options.idstringThe ID of the account to update.
options.patchArrayA JSON patch for performing the update.
options.sequencenumberThe sequence number that must match the current record prior to the patch.

bedrock-account.setStatus(options) ⇒ Promise

Sets an account's status.

Kind: static method of bedrock-account
Returns: Promise - Resolves once the operation completes.

ParamTypeDescription
optionsobjectThe options to use.
options.idstringThe account ID.
options.statusstringThe status.

Keywords

FAQs

Package last updated on 24 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc