schema.named.md
January 18, 2023 ยท View on GitHub
Home > @datashaper/schema > Named
Named interface
Base interface for sharing properties of named resources/objects.
Signature:
export interface Named
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description? | string | (Optional) Description of the named resource. | |
| name | string | User-specified name. This will serve as the local id (i.e., like a filename.) and should be URI-compatible. This should be editable, just like any other filename on a file system. | |
| title? | string | (Optional) Friendly name of the resource. Used for display only. |