-
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 #68 from Serpico1899/main
📝 add getPureModel document(api reference)
- Loading branch information
Showing
1 changed file
with
80 additions
and
2 deletions.
There are no files selected for viewing
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,4 +1,82 @@ | ||
# getPureModel | ||
|
||
get pure features of one schema | ||
@param name - name of schema that we want to get pure feature | ||
```ts | ||
getPureModel: (name: string) | ||
``` | ||
|
||
_Get pure features 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 getCityPureModel = coreApp.schemas.getPureModel("city");</p> | ||
</code> | ||
</pre> | ||
</details> | ||
|
||
<details> | ||
<summary> | ||
Return Of Example | ||
</summary> | ||
<pre> | ||
<code class="language-json" style="padding: 0;"> | ||
{ | ||
"_id": { | ||
"type": "union", | ||
"schema": null | ||
}, | ||
"name": { | ||
"type": "string", | ||
"schema": null | ||
}, | ||
"population": { | ||
"type": "number", | ||
"schema": null | ||
}, | ||
"abb": { | ||
"type": "string", | ||
"schema": null | ||
} | ||
} | ||
</code> | ||
</pre> | ||
</details> | ||
|
||
<h3>Parameters</h3> | ||
<pre> | ||
<code class="language-ts" style="padding: 0; margin-top: 12px; margin-top: -18px;"> | ||
name: string | ||
</code> | ||
</pre> |