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

docs: generate references manually (#10438)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-12-04 21:37:07 +02:00
1 parent c9eeaebdd9
commit 1cb885d566
143 files changed
+180393 -165549
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/dml/Model_Methods/methods/dml.Model_Methods.indexes/page.mdx
+1 -1
View File
@@ -78,4 +78,4 @@ In this example, the index is created when the value of `age` doesn't equal `30`
## Parameters
<TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;[IDmlEntity](../../../../types/DmlTypes/interfaces/types.DmlTypes.IDmlEntity/page.mdx)&#60;TSchema, any&#62;&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"TWhere","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="indexes"/>
<TypeList types={[{"name":"indexes","type":"[EntityIndex](../../../../types/DmlTypes/types/types.DmlTypes.EntityIndex/page.mdx)&#60;Schema, string \\| [QueryCondition](../../../../types/DmlTypes/types/types.DmlTypes.QueryCondition/page.mdx)&#60;Schema&#62;&#62;[]","description":"The index's configuration.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"on","type":"[InferIndexableProperties](../../../../types/DmlTypes/types/types.DmlTypes.InferIndexableProperties/page.mdx)&#60;Schema&#62;[]","description":"The list of properties to create the index on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the index. If not provided,\nMedusa generates the name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unique","type":"`boolean`","description":"When enabled, a unique index is created on the specified\nproperties.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"where","type":"Where","description":"Conditions to restrict which records are indexed.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="indexes"/>
www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx
+7
View File
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# checks
## Parameters
<TypeList types={[{"name":"checks","type":"[CheckConstraint](../../../../../types/DmlTypes/types/types.DmlTypes.CheckConstraint/page.mdx)&#60;Schema&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expression","type":"`string` \\| (`columns`: [InferCheckConstraintsProperties](../../../../../types/DmlTypes/types/types.DmlTypes.InferCheckConstraintsProperties/page.mdx)&#60;Schema&#62;) => `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"property","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="checks"/>
www/apps/resources/references/dml/entity/classes/dml.entity.DmlEntity/page.mdx
+1
View File
@@ -16,6 +16,7 @@ name, its schema and relationships.
## Methods
- [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx)
- [checks](../../DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx)
- [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx)
- [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx)
- [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx)