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:
+2
-2
@@ -27,7 +27,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`BaseFilterable`](internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"type": "([BaseFilterable](internal.internal-1.DAL.BaseFilterable.mdx)<T> \\| `T`)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -36,7 +36,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`BaseFilterable`](internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"type": "([BaseFilterable](internal.internal-1.DAL.BaseFilterable.mdx)<T> \\| `T`)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+2
-2
@@ -43,7 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "filters",
|
||||
"type": "`boolean` \\| `string`[] \\| [`Dictionary`](../../internal/types/internal.Dictionary.mdx)<`boolean` \\| [`Dictionary`](../../internal/types/internal.Dictionary.mdx)\\>",
|
||||
"type": "`boolean` \\| `string`[] \\| [Dictionary](../../internal/types/internal.Dictionary.mdx)<boolean \\| [Dictionary](../../internal/types/internal.Dictionary.mdx)>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -79,7 +79,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "orderBy",
|
||||
"type": "[`Order`](../../internal/types/internal.Order-1.mdx)<`T`\\> \\| [`Order`](../../internal/types/internal.Order-1.mdx)<`T`\\>[]",
|
||||
"type": "[Order](../../internal/types/internal.Order-1.mdx)<T> \\| [Order](../../internal/types/internal.Order-1.mdx)<T>[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
|
||||
+20
-20
@@ -42,7 +42,7 @@ ORM directly and allows to switch to another ORM without changing the business l
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -56,7 +56,7 @@ ORM directly and allows to switch to another ORM without changing the business l
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"type": "Promise<T[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../types/internal.internal-1.DAL.FindOptions.mdx)<`T`\\>",
|
||||
"type": "[FindOptions](../types/internal.internal-1.DAL.FindOptions.mdx)<T>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"type": "Promise<T[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../types/internal.internal-1.DAL.FindOptions.mdx)<`T`\\>",
|
||||
"type": "[FindOptions](../types/internal.internal-1.DAL.FindOptions.mdx)<T>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -179,7 +179,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"type": "Promise<[T[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -222,7 +222,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], Record<`string`, `unknown`[]\\>]\\>",
|
||||
"type": "Promise<[T[], Record<string, unknown[]>]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -277,7 +277,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"type": "Promise<TOutput>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -306,7 +306,7 @@ Soft delete entities and cascade to related entities if configured.
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -320,10 +320,10 @@ Soft delete entities and cascade to related entities if configured.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], Record<`string`, `unknown`[]\\>]\\>",
|
||||
"type": "Promise<[T[], Record<string, unknown[]>]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "[T[], Record<string, string[]>] the second value being the map of the entity names and ids that were soft deleted",
|
||||
"description": "[T[], Record<string, string[]>] the second value being the map of the entity names and ids that were soft deleted",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
@@ -338,7 +338,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"type": "(`transactionManager`: `TManager`) => Promise<any>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -388,7 +388,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"type": "Promise<any>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -415,7 +415,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -429,7 +429,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"type": "Promise<T[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
+15
-15
@@ -42,7 +42,7 @@ ORM directly and allows to switch to another ORM without changing the business l
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -56,7 +56,7 @@ ORM directly and allows to switch to another ORM without changing the business l
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`\\>",
|
||||
"type": "Promise<T>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -83,7 +83,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"type": "Promise<void>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../types/internal.internal-1.DAL.FindOptions.mdx)<`T`\\>",
|
||||
"type": "[FindOptions](../types/internal.internal-1.DAL.FindOptions.mdx)<T>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -124,7 +124,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"type": "[RepositoryTransformOptions](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -133,7 +133,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -147,7 +147,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"type": "Promise<T[]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../types/internal.internal-1.DAL.FindOptions.mdx)<`T`\\>",
|
||||
"type": "[FindOptions](../types/internal.internal-1.DAL.FindOptions.mdx)<T>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -174,7 +174,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"type": "[RepositoryTransformOptions](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -183,7 +183,7 @@ ___
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"type": "[Context](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -197,7 +197,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"type": "Promise<[T[], number]>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -254,7 +254,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"type": "Promise<TOutput>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
@@ -272,7 +272,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"type": "(`transactionManager`: `TManager`) => Promise<any>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -322,7 +322,7 @@ ___
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"type": "Promise<any>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
|
||||
-2
@@ -5,5 +5,3 @@ displayed_sidebar: jsClientSidebar
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EntityDateColumns
|
||||
|
||||
**EntityDateColumns**: ``"created_at"`` \| ``"updated_at"``
|
||||
|
||||
+1
-3
@@ -6,9 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterQuery
|
||||
|
||||
**FilterQuery**<`T`, `Prev`\>: `Prev` extends `never` ? `never` : { [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap<T[Key]\\> : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery<Partial<V\\>, PrevLimit[Prev]\\> : never : never : never }
|
||||
|
||||
#### Type parameters
|
||||
### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
+4
-6
@@ -6,9 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindOptions
|
||||
|
||||
**FindOptions**<`T`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
### Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -22,12 +20,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Type declaration
|
||||
### Type declaration
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`OptionsQuery`](../interfaces/internal.internal-1.DAL.OptionsQuery.mdx)<`T`, `any`\\>",
|
||||
"type": "[OptionsQuery](../interfaces/internal.internal-1.DAL.OptionsQuery.mdx)<T, any>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
@@ -36,7 +34,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "where",
|
||||
"type": "[`FilterQuery`](internal.internal-1.DAL.FilterQuery.mdx)<`T`\\> & [`BaseFilterable`](../interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterQuery`](internal.internal-1.DAL.FilterQuery.mdx)<`T`\\>\\>",
|
||||
"type": "[FilterQuery](internal.internal-1.DAL.FilterQuery.mdx)<T> & [BaseFilterable](../interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[FilterQuery](internal.internal-1.DAL.FilterQuery.mdx)<T>>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
|
||||
-2
@@ -5,5 +5,3 @@ displayed_sidebar: jsClientSidebar
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SoftDeletableEntityDateColumns
|
||||
|
||||
**SoftDeletableEntityDateColumns**: ``"deleted_at"`` \| [`EntityDateColumns`](internal.internal-1.DAL.EntityDateColumns.mdx)
|
||||
|
||||
Reference in New Issue
Block a user