Methods
(static) schemaMarkdownDoc(types, typeName, optionsopt, nullable) → {Array.<Object>}
Generate the Schema Markdown user type documentation element model
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
types |
Object | The type model |
||
typeName |
string | The type name |
||
options |
Object |
<optional> <nullable> |
null | The options object |
- Source:
Returns:
- Type
- Array.<Object>
Type Definitions
SchemaMarkdownDocOptions
The schemaMarkdownDoc options object
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
string |
<optional> |
The page's hash param string with tag removed |
actionURLs |
Array.<Object> |
<optional> |
The action URLs override |
- Source: