-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #74 from Serpico1899/main
📝 add getMainRelations document(api reference)
- Loading branch information
Showing
1 changed file
with
67 additions
and
2 deletions.
There are no files selected for viewing
69 changes: 67 additions & 2 deletions
69
pages/src/api/schemas/mainRelationsFns/getMainRelations_fn.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,70 @@ | ||
# getMainRelations | ||
|
||
get all of inerRealation of one schema | ||
```ts | ||
getMainRelations: (schemaName: string) | ||
``` | ||
|
||
@param schemaName - name of schema that we want inerRealation of it | ||
_Get all of inerRealation of one schema_ | ||
|
||
</br> | ||
<details open> | ||
<summary> | ||
Example | ||
</summary> | ||
<pre> | ||
<code class="language-ts" style="padding: 0;"> | ||
const coreApp = lesan(); | ||
const locationPure = { | ||
name: string(), | ||
population: number(), | ||
abb: string(), | ||
}; | ||
const cities = coreApp.odm.newModel( | ||
"city", | ||
locationPure, | ||
{ | ||
country: { | ||
schemaName: "country", | ||
type: "single", | ||
optional: false, | ||
relatedRelations: { | ||
cities: { | ||
type: "multiple", | ||
limit: 5, | ||
sort: { | ||
field: "_id", | ||
order: "asc", | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
); | ||
<p style="border: 2px solid gray; border-right: transparent; border-left: transparent; padding: 5px 1rem; background-color: #000000" >const getCityMainRelations = coreApp.schemas.getMainRelations("city");</p> | ||
</code> | ||
</pre> | ||
</details> | ||
|
||
<details> | ||
<summary> | ||
Return Of Example | ||
</summary> | ||
<pre> | ||
<code class="language-json" style="padding: 0;"> | ||
{ | ||
"country": { | ||
"schemaName": "country", | ||
"type": "single", | ||
"optional": false | ||
} | ||
} | ||
</code> | ||
</pre> | ||
</details> | ||
|
||
<h3>Parameters</h3> | ||
<pre> | ||
<code class="language-ts" style="padding: 0; margin-top: 12px; margin-top: -18px;"> | ||
schemaName: string | ||
</code> | ||
</pre> |