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

68
www/apps/docs/content/references/services/classes/AuthService.mdx
View File

@@ -10,11 +10,11 @@ Can authenticate a user based on email password combination
## Constructors
### constructor
#### constructor
`**new AuthService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -98,29 +98,13 @@ Can authenticate a user based on email password combination
## 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;`
@@ -128,6 +112,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",
@@ -149,7 +135,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -181,7 +167,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -199,14 +185,14 @@ Promise&#60;TResult&#62;
___
### authenticate
#### authenticate
`**authenticate**(email, password): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a given user based on an email, password combination. Uses
scrypt to match password with hashed value.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -229,7 +215,7 @@ scrypt to match password with hashed value.
}
]} />
#### Returns
##### Returns
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
@@ -247,13 +233,13 @@ Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
___
### authenticateAPIToken
#### authenticateAPIToken
`**authenticateAPIToken**(token): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a given user with an API token
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -267,7 +253,7 @@ Authenticates a given user with an API token
}
]} />
#### Returns
##### Returns
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
@@ -285,14 +271,14 @@ Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
___
### authenticateCustomer
#### authenticateCustomer
`**authenticateCustomer**(email, password): Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;`
Authenticates a customer based on an email, password combination. Uses
scrypt to match password with hashed value.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -315,7 +301,7 @@ scrypt to match password with hashed value.
}
]} />
#### Returns
##### Returns
Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
@@ -333,13 +319,13 @@ Promise&#60;[AuthenticateResult](../types/AuthenticateResult.mdx)&#62;
___
### comparePassword\_
#### comparePassword\_
`Protected **comparePassword_**(password, hash): Promise&#60;boolean&#62;`
Verifies if a password is valid given the provided password hash
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -362,7 +348,7 @@ Verifies if a password is valid given the provided password hash
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -380,11 +366,11 @@ Promise&#60;boolean&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -398,7 +384,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -416,11 +402,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [AuthService](AuthService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -434,7 +420,7 @@ ___
}
]} />
#### Returns
##### Returns
[AuthService](AuthService.mdx)