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

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,8 +52,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### authenticate
Authenticates a given user based on an email, password combination. Uses
@@ -67,8 +65,6 @@ scrypt to match password with hashed value.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
### authenticateAPIToken
Authenticates a given user with an API token
@@ -81,8 +77,6 @@ Authenticates a given user with an API token
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
### authenticateCustomer
Authenticates a customer based on an email, password combination. Uses
@@ -96,8 +90,6 @@ scrypt to match password with hashed value.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
### comparePassword\_
Verifies if a password is valid given the provided password hash
@@ -110,8 +102,6 @@ Verifies if a password is valid given the provided password hash
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;boolean&#62;","optional":false,"defaultValue":"","description":"the result of the comparison","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -122,8 +112,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### withTransaction
#### Parameters