Type shoalrun.content.ContentLink
type ContentLink = {
key: string;
kind: 'resource' | 'canonical' | 'external' | 'asset';
href: string;
ref?: ContentRef;
fragment?: string;
query?: string;
asset?: string;
};
Classified link and optional resource identity for application routing.
Fields
| Name | Type | Required / default | Description |
|---|---|---|---|
asset |
string | undefined |
Optional | — |
fragment |
string | undefined |
Optional | — |
href |
string |
Required | — |
key |
string |
Required | — |
kind |
"resource" | "canonical" | "external" | "asset" |
Required | — |
query |
string | undefined |
Optional | — |
ref |
ContentRef | undefined |
Optional | — |
shoalrun.content.ContentLink.asset
Property shoalrun.content.ContentLink.asset
asset?: string | undefined
Type: string | undefined
Optional
shoalrun.content.ContentLink.fragment
Property shoalrun.content.ContentLink.fragment
fragment?: string | undefined
Type: string | undefined
Optional
shoalrun.content.ContentLink.href
Property shoalrun.content.ContentLink.href
href: string
Type: string
Required
shoalrun.content.ContentLink.key
Property shoalrun.content.ContentLink.key
key: string
Type: string
Required
shoalrun.content.ContentLink.kind
Property shoalrun.content.ContentLink.kind
kind: "resource" | "canonical" | "external" | "asset"
Type: "resource" | "canonical" | "external" | "asset"
Required
shoalrun.content.ContentLink.query
Property shoalrun.content.ContentLink.query
query?: string | undefined
Type: string | undefined
Optional
shoalrun.content.ContentLink.ref
Property shoalrun.content.ContentLink.ref
ref?: ContentRef | undefined
Type: ContentRef | undefined
Optional