docs: update docusaurus to v3 (#5625)
* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
This commit is contained in:
@@ -12,14 +12,14 @@ Provides layer to manipulate users.
|
||||
|
||||
### constructor
|
||||
|
||||
**new UserService**(`«destructured»`)
|
||||
`**new UserService**(«destructured»)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "__namedParameters",
|
||||
"type": "[`UserServiceProps`](../types/UserServiceProps.mdx)",
|
||||
"type": "[UserServiceProps](../types/UserServiceProps.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -33,7 +33,7 @@ Provides layer to manipulate users.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "__configModule__",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -51,7 +51,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "__moduleDeclaration__",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"type": "`Record<string, unknown>`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -60,7 +60,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "analyticsConfigService_",
|
||||
"type": "[`AnalyticsConfigService`](AnalyticsConfigService.mdx)",
|
||||
"type": "[AnalyticsConfigService](AnalyticsConfigService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -69,7 +69,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "eventBus_",
|
||||
"type": "[`EventBusService`](EventBusService.mdx)",
|
||||
"type": "[EventBusService](EventBusService.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -78,7 +78,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "featureFlagRouter_",
|
||||
"type": "[`FlagRouter`](FlagRouter.mdx)",
|
||||
"type": "[FlagRouter](FlagRouter.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -87,7 +87,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "manager_",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -96,7 +96,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "transactionManager_",
|
||||
"type": "`undefined` \\| `EntityManager`",
|
||||
"type": "`undefined` \\| EntityManager",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -105,7 +105,7 @@ Provides layer to manipulate users.
|
||||
},
|
||||
{
|
||||
"name": "userRepository_",
|
||||
"type": "`Repository`<[`User`](User.mdx)\\>",
|
||||
"type": "Repository<[User](User.mdx)>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -163,16 +163,16 @@ Provides layer to manipulate users.
|
||||
|
||||
### activeManager\_
|
||||
|
||||
`Protected` `get` **activeManager_**(): `EntityManager`
|
||||
`Protected get**activeManager_**(): EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
`EntityManager`
|
||||
EntityManager
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "EntityManager",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -185,7 +185,7 @@ Provides layer to manipulate users.
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
|
||||
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>`
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
a transaction manager attached this will be reused, otherwise a new
|
||||
@@ -217,7 +217,7 @@ transaction manager is created.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "work",
|
||||
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
|
||||
"type": "(`transactionManager`: EntityManager) => Promise<TResult>",
|
||||
"description": "the transactional work to be done",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -226,7 +226,7 @@ transaction manager is created.
|
||||
},
|
||||
{
|
||||
"name": "isolationOrErrorHandler",
|
||||
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
|
||||
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise<void \\| TResult>",
|
||||
"description": "the isolation level to be used for the work.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -235,7 +235,7 @@ transaction manager is created.
|
||||
},
|
||||
{
|
||||
"name": "maybeErrorHandlerOrDontFail",
|
||||
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
|
||||
"type": "(`error`: `TError`) => Promise<void \\| TResult>",
|
||||
"description": "Potential error handler",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -246,12 +246,12 @@ transaction manager is created.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
Promise<TResult>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TResult`\\>",
|
||||
"type": "Promise<TResult>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of the transactional work",
|
||||
@@ -264,7 +264,7 @@ ___
|
||||
|
||||
### create
|
||||
|
||||
**create**(`user`, `password`): `Promise`<[`User`](User.mdx)\>
|
||||
`**create**(user, password): Promise<[User](User.mdx)>`
|
||||
|
||||
Creates a user with username being validated.
|
||||
Fails if email is not a valid format.
|
||||
@@ -274,7 +274,7 @@ Fails if email is not a valid format.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "user",
|
||||
"type": "[`CreateUserInput`](../interfaces/CreateUserInput.mdx)",
|
||||
"type": "[CreateUserInput](../interfaces/CreateUserInput.mdx)",
|
||||
"description": "the user to create",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -294,12 +294,12 @@ Fails if email is not a valid format.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of create",
|
||||
@@ -312,7 +312,7 @@ ___
|
||||
|
||||
### delete
|
||||
|
||||
**delete**(`userId`): `Promise`<`void`\>
|
||||
`**delete**(userId): Promise<void>`
|
||||
|
||||
Deletes a user from a given user id.
|
||||
|
||||
@@ -332,12 +332,12 @@ Deletes a user from a given user id.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
Promise<void>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of the delete operation.",
|
||||
@@ -350,7 +350,7 @@ ___
|
||||
|
||||
### generateResetPasswordToken
|
||||
|
||||
**generateResetPasswordToken**(`userId`): `Promise`<`string`\>
|
||||
`**generateResetPasswordToken**(userId): Promise<string>`
|
||||
|
||||
Generate a JSON Web token, that will be sent to a user, that wishes to
|
||||
reset password.
|
||||
@@ -374,12 +374,12 @@ is always 15 minutes.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`string`\>
|
||||
Promise<string>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`string`\\>",
|
||||
"type": "Promise<string>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the generated JSON web token",
|
||||
@@ -392,7 +392,7 @@ ___
|
||||
|
||||
### hashPassword\_
|
||||
|
||||
**hashPassword_**(`password`): `Promise`<`string`\>
|
||||
`**hashPassword_**(password): Promise<string>`
|
||||
|
||||
Hashes a password
|
||||
|
||||
@@ -412,12 +412,12 @@ Hashes a password
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`string`\>
|
||||
Promise<string>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`string`\\>",
|
||||
"type": "Promise<string>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "hashed password",
|
||||
@@ -430,14 +430,14 @@ ___
|
||||
|
||||
### list
|
||||
|
||||
**list**(`selector`, `config?`): `Promise`<[`User`](User.mdx)[]\>
|
||||
`**list**(selector, config?): Promise<[User](User.mdx)[]>`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "selector",
|
||||
"type": "[`FilterableUserProps`](../types/FilterableUserProps.mdx)",
|
||||
"type": "[FilterableUserProps](../types/FilterableUserProps.mdx)",
|
||||
"description": "the query object for find",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -457,12 +457,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)[]\>
|
||||
Promise<[User](User.mdx)[]>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)[]\\>",
|
||||
"type": "Promise<[User](User.mdx)[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of the find operation",
|
||||
@@ -475,7 +475,7 @@ ___
|
||||
|
||||
### retrieve
|
||||
|
||||
**retrieve**(`userId`, `config?`): `Promise`<[`User`](User.mdx)\>
|
||||
`**retrieve**(userId, config?): Promise<[User](User.mdx)>`
|
||||
|
||||
Gets a user by id.
|
||||
Throws in case of DB Error and if user was not found.
|
||||
@@ -494,7 +494,7 @@ Throws in case of DB Error and if user was not found.
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`User`](User.mdx)\\>",
|
||||
"type": "[FindConfig](../interfaces/FindConfig.mdx)<[User](User.mdx)>",
|
||||
"description": "query configs",
|
||||
"optional": false,
|
||||
"defaultValue": "{}",
|
||||
@@ -505,12 +505,12 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the user document.",
|
||||
@@ -523,7 +523,7 @@ ___
|
||||
|
||||
### retrieveByApiToken
|
||||
|
||||
**retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<[`User`](User.mdx)\>
|
||||
`**retrieveByApiToken**(apiToken, relations?): Promise<[User](User.mdx)>`
|
||||
|
||||
Gets a user by api token.
|
||||
Throws in case of DB Error and if user was not found.
|
||||
@@ -553,12 +553,12 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the user document.",
|
||||
@@ -571,7 +571,7 @@ ___
|
||||
|
||||
### retrieveByEmail
|
||||
|
||||
**retrieveByEmail**(`email`, `config?`): `Promise`<[`User`](User.mdx)\>
|
||||
`**retrieveByEmail**(email, config?): Promise<[User](User.mdx)>`
|
||||
|
||||
Gets a user by email.
|
||||
Throws in case of DB Error and if user was not found.
|
||||
@@ -590,7 +590,7 @@ Throws in case of DB Error and if user was not found.
|
||||
},
|
||||
{
|
||||
"name": "config",
|
||||
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`User`](User.mdx)\\>",
|
||||
"type": "[FindConfig](../interfaces/FindConfig.mdx)<[User](User.mdx)>",
|
||||
"description": "query config",
|
||||
"optional": false,
|
||||
"defaultValue": "{}",
|
||||
@@ -601,12 +601,12 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the user document.",
|
||||
@@ -619,7 +619,7 @@ ___
|
||||
|
||||
### setPassword\_
|
||||
|
||||
**setPassword_**(`userId`, `password`): `Promise`<[`User`](User.mdx)\>
|
||||
`**setPassword_**(userId, password): Promise<[User](User.mdx)>`
|
||||
|
||||
Sets a password for a user
|
||||
Fails if no user exists with userId and if the hashing of the new
|
||||
@@ -650,12 +650,12 @@ password does not work.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of the update operation",
|
||||
@@ -668,14 +668,14 @@ ___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "err",
|
||||
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
|
||||
"type": "`Record<string, unknown>` \\| `{ code: string }`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -704,7 +704,7 @@ ___
|
||||
|
||||
### update
|
||||
|
||||
**update**(`userId`, `update`): `Promise`<[`User`](User.mdx)\>
|
||||
`**update**(userId, update): Promise<[User](User.mdx)>`
|
||||
|
||||
Updates a user.
|
||||
|
||||
@@ -722,7 +722,7 @@ Updates a user.
|
||||
},
|
||||
{
|
||||
"name": "update",
|
||||
"type": "[`UpdateUserInput`](../interfaces/UpdateUserInput.mdx)",
|
||||
"type": "[UpdateUserInput](../interfaces/UpdateUserInput.mdx)",
|
||||
"description": "the values to be updated on the user",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -733,12 +733,12 @@ Updates a user.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`User`](User.mdx)\>
|
||||
Promise<[User](User.mdx)>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`User`](User.mdx)\\>",
|
||||
"type": "Promise<[User](User.mdx)>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "the result of create",
|
||||
@@ -751,14 +751,14 @@ ___
|
||||
|
||||
### withTransaction
|
||||
|
||||
**withTransaction**(`transactionManager?`): [`UserService`](UserService.mdx)
|
||||
`**withTransaction**(transactionManager?): [UserService](UserService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`EntityManager`",
|
||||
"type": "EntityManager",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -769,12 +769,12 @@ ___
|
||||
|
||||
#### Returns
|
||||
|
||||
[`UserService`](UserService.mdx)
|
||||
[UserService](UserService.mdx)
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "UserService",
|
||||
"type": "[`UserService`](UserService.mdx)",
|
||||
"type": "[UserService](UserService.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
Reference in New Issue
Block a user