bedrock-account
User accounts for Bedrock Applications
API Reference
Modules
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) ⇒
Promise
bedrock-account.insert(options) ⇒ 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. |
Promise
bedrock-account.exists(options) ⇒ 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'). |
Promise
| ExplainObject
bedrock-account.get(options) ⇒ 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. |
Promise
bedrock-account.getAll(options) ⇒ 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. |
Promise
| ExplainObject
bedrock-account.update(options) ⇒ 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). |
Promise
bedrock-account.setStatus(options) ⇒ 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. |
object
ExplainObject : An object containing information on the query plan.
object
ExplainObject : An object containing information on the query plan.
object
ExplainObject : An object containing information on the query plan.
Kind: global typedef