Package Exports
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
Modules
- bedrock-account
Typedefs
- ExplainObject :
object An object containing information on the query plan.
- ExplainObject :
object An object containing information on the query plan.
- ExplainObject :
object An object containing information on the query plan.
bedrock-account
- bedrock-account
- .insert(options) ⇒
Promise - .exists(options) ⇒
Promise - .get(options) ⇒
Promise|ExplainObject - .getAll(options) ⇒
Promise - .update(options) ⇒
Promise|ExplainObject - .setStatus(options) ⇒
Promise
- .insert(options) ⇒
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 | ExplainObject
Retrieves an account by ID or email.
Kind: static method of bedrock-account
Returns: Promise | ExplainObject - - Returns a Promise that resolves to
the account record ({account, meta}) or an ExplainObject if
explain=true.
| Param | Type | Default | Description |
|---|---|---|---|
| options | object |
The options to use. | |
| [options.id] | string |
The ID of the account to retrieve. | |
| [options.email] | string |
The email of the account to retrieve. | |
| [options.explain] | boolean |
false |
An optional explain boolean. |
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'). |
| [options._allowPending] | boolean |
false |
For internal use only; allows finding records that are in the process of being created. |
bedrock-account.update(options) ⇒ Promise | ExplainObject
Updates an account by overwriting it with new account and / or meta
information. In both cases, the expected sequence must match the existing
account, but if meta is being overwritten, sequence can be omitted and
the value from meta.sequence will be used.
Kind: static method of bedrock-account
Returns: Promise | ExplainObject - - Returns a Promise that resolves to
true if the update succeeds or an ExplainObject if explain=true.
| Param | Type | Description |
|---|---|---|
| options | object |
The options to use. |
| options.id | string |
The ID of the account to update. |
| [options.account] | object |
The new account information to use. |
| [options.meta] | object |
The new meta information to use. |
| [options.sequence] | number |
The sequence number that must match the current record prior to the update if given; can be omitted if meta is given and has, instead, the new sequence number (which must be one more than the existing sequence number). |
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. |
ExplainObject : object
An object containing information on the query plan.
ExplainObject : object
An object containing information on the query plan.
ExplainObject : object
An object containing information on the query plan.
Kind: global typedef