asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
www/apps/docs/content/references/services/classes/UserService.mdx
View File

@@ -10,11 +10,11 @@ Provides layer to manipulate users.
## Constructors
### constructor
#### constructor
`**new UserService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -161,29 +161,13 @@ Provides layer to manipulate users.
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -191,6 +175,8 @@ Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -212,7 +198,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -244,7 +230,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -262,14 +248,14 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(user, password): Promise&#60;[User](User.mdx)&#62;`
Creates a user with username being validated.
Fails if email is not a valid format.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -292,7 +278,7 @@ Fails if email is not a valid format.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -310,13 +296,13 @@ Promise&#60;[User](User.mdx)&#62;
___
### delete
#### delete
`**delete**(userId): Promise&#60;void&#62;`
Deletes a user from a given user id.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -330,7 +316,7 @@ Deletes a user from a given user id.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -348,7 +334,7 @@ Promise&#60;void&#62;
___
### generateResetPasswordToken
#### generateResetPasswordToken
`**generateResetPasswordToken**(userId): Promise&#60;string&#62;`
@@ -358,7 +344,7 @@ The token will be signed with the users current password hash as a secret
a long side a payload with userId and the expiry time for the token, which
is always 15 minutes.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +358,7 @@ is always 15 minutes.
}
]} />
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -390,13 +376,13 @@ Promise&#60;string&#62;
___
### hashPassword\_
#### hashPassword\_
`**hashPassword_**(password): Promise&#60;string&#62;`
Hashes a password
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -410,7 +396,7 @@ Hashes a password
}
]} />
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -428,11 +414,11 @@ Promise&#60;string&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[User](User.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -455,7 +441,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)[]&#62;
@@ -473,14 +459,14 @@ Promise&#60;[User](User.mdx)[]&#62;
___
### retrieve
#### retrieve
`**retrieve**(userId, config?): Promise&#60;[User](User.mdx)&#62;`
Gets a user by id.
Throws in case of DB Error and if user was not found.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -503,7 +489,7 @@ Throws in case of DB Error and if user was not found.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -521,14 +507,14 @@ Promise&#60;[User](User.mdx)&#62;
___
### retrieveByApiToken
#### retrieveByApiToken
`**retrieveByApiToken**(apiToken, relations?): Promise&#60;[User](User.mdx)&#62;`
Gets a user by api token.
Throws in case of DB Error and if user was not found.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -551,7 +537,7 @@ Throws in case of DB Error and if user was not found.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -569,14 +555,14 @@ Promise&#60;[User](User.mdx)&#62;
___
### retrieveByEmail
#### retrieveByEmail
`**retrieveByEmail**(email, config?): Promise&#60;[User](User.mdx)&#62;`
Gets a user by email.
Throws in case of DB Error and if user was not found.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -599,7 +585,7 @@ Throws in case of DB Error and if user was not found.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -617,7 +603,7 @@ Promise&#60;[User](User.mdx)&#62;
___
### setPassword\_
#### setPassword\_
`**setPassword_**(userId, password): Promise&#60;[User](User.mdx)&#62;`
@@ -625,7 +611,7 @@ Sets a password for a user
Fails if no user exists with userId and if the hashing of the new
password does not work.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -648,7 +634,7 @@ password does not work.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -666,11 +652,11 @@ Promise&#60;[User](User.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -684,7 +670,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -702,13 +688,13 @@ ___
___
### update
#### update
`**update**(userId, update): Promise&#60;[User](User.mdx)&#62;`
Updates a user.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -731,7 +717,7 @@ Updates a user.
}
]} />
#### Returns
##### Returns
Promise&#60;[User](User.mdx)&#62;
@@ -749,11 +735,11 @@ Promise&#60;[User](User.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [UserService](UserService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -767,7 +753,7 @@ ___
}
]} />
#### Returns
##### Returns
[UserService](UserService.mdx)