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

generate references (#7882)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-07-01 16:02:36 +03:00
1 parent b9036eca1a
commit dd864da4e0
2424 files changed
+106679 -116201
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import { TypeList } from "docs-ui"
# isDmlEntity
A static method to check if an entity is an instance of DmlEntity.
It allows us to identify a specific object as being an instance of
DmlEntity.
## Parameters
<TypeList types={[{"name":"entity","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="isDmlEntity"/>
www/apps/resources/references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx
+5
View File
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# parse
Parse entity to get its underlying information
www/apps/resources/references/dml/entity/classes/dml.entity.DmlEntity/page.mdx
+31
View File
@@ -0,0 +1,31 @@
import { TypeList } from "docs-ui"
# DmlEntity
Dml entity is a representation of a DML model with a unique
name, its schema and relationships.
## Type parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../../../../types/DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="DmlEntity"/>
## Methods
- [isDmlEntity](../../DmlEntity/methods/dml.entity.DmlEntity.isDmlEntity/page.mdx)
- [parse](../../DmlEntity/methods/dml.entity.DmlEntity.parse/page.mdx)
- [cascades](../../../Model_Methods/methods/dml.Model_Methods.cascades/page.mdx)
- [indexes](../../../Model_Methods/methods/dml.Model_Methods.indexes/page.mdx)
## constructor
### Type Parameters
<TypeList types={[{"name":"Schema","type":"[DMLSchema](../../../../types/DmlTypes/types/types.DmlTypes.DMLSchema/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"$dataType","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[RelationshipTypes](../../../../types/DmlTypes/types/types.DmlTypes.RelationshipTypes/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="new DmlEntity"/>
### Parameters
<TypeList types={[{"name":"nameOrConfig","type":"`Config`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new DmlEntity"/>
___
<TypeList types={[{"name":"[IsDmlEntity]","type":"`true`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"Schema","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="DmlEntity"/>