Browse Source

docs: init DataSources

ci/dependabot
danstarns 2 years ago
parent
commit
4f6139a329
  1. 1
      docs/api.js
  2. 9
      docs/api/component.md
  3. 61
      docs/api/data_source_manager.md
  4. 7
      docs/modules/DataSources.md

1
docs/api.js

@ -79,6 +79,7 @@ async function generateDocs () {
['pages/index.ts', 'pages.md'],
['pages/model/Page.ts', 'page.md'],
['parser/index.ts', 'parser.md'],
['data_sources/index.ts', 'data_source_manager.md'],
].map(async (file) => {
const filePath = `${srcRoot}/${file[0]}`;

9
docs/api/component.md

@ -659,6 +659,15 @@ Get the name of the component.
Returns **[String][1]**
## setName
Update component name.
### Parameters
* `name` **[String][1]** New name.
* `opts` **SetOptions** (optional, default `{}`)
## getIcon
Get the icon string

61
docs/api/data_source_manager.md

@ -0,0 +1,61 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
## add
Add new data source.
### Parameters
* `props` **[Object][1]** Data source properties.
* `opts` **AddOptions** (optional, default `{}`)
### Examples
```javascript
const ds = dsm.add({
id: 'my_data_source_id',
records: [
{ id: 'id1', name: 'value1' },
{ id: 'id2', name: 'value2' }
]
});
```
Returns **[DataSource]** Added data source.
## get
Get data source.
### Parameters
* `id` **[String][2]** Data source id.
### Examples
```javascript
const ds = dsm.get('my_data_source_id');
```
Returns **[DataSource]** Data source.
## remove
Remove data source.
### Parameters
* `id` **([String][2] | [DataSource])** Id of the data source.
* `opts` **RemoveOptions?**
### Examples
```javascript
const removed = dsm.remove('DS_ID');
```
Returns **[DataSource]** Removed data source.
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

7
docs/modules/DataSources.md

@ -0,0 +1,7 @@
---
title: Data Sources
---
# Data Sources
Hey World
Loading…
Cancel
Save