JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 181
  • Score
    100M100P100Q71337F
  • License SEE LICENSE IN LICENSE.md

User accounts for Bedrock applications

Package Exports

  • @bedrock/account
  • @bedrock/account/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@bedrock/account) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bedrock-account

User accounts for Bedrock Applications

API Reference

bedrock-account

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.

Param Type Description
options object The options to use.
options.account object The account containing at least the minimum required data.
[options.meta] object The 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.

Param Type Default Description
options object The options to use.
[options.id] string The ID of the account to check.
[options.email] string The 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}.

Param Type Description
options object The options to use.
options.id string The 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.

Param Type Default Description
options object The 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.

Param Type Description
options object The options to use.
options.id string The ID of the account to update.
options.patch Array A JSON patch for performing the update.
options.sequence number The 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.

Param Type Description
options object The options to use.
options.id string The account ID.
options.status string The status.