@adcp/sdk API Reference - v10.0.1
Documentation
GitHub
npm
Preparing search index...
CanonicalReferenceResolvedResult
Interface CanonicalReferenceResolvedResult<TDocument>
interface
CanonicalReferenceResolvedResult
<
TDocument
=
unknown
>
{
kind
:
CanonicalReferenceKind
;
ref
:
CanonicalReference
;
cacheKey
:
string
;
fromCache
:
boolean
;
ok
:
true
;
status
:
"resolved"
;
document
:
TDocument
;
body
:
Uint8Array
;
text
:
string
;
contentType
?:
string
;
httpStatus
:
number
;
schemaMeta
?:
{
draft
:
"draft-07"
|
"2020-12"
;
refCount
:
number
;
maxRefDepthSeen
:
number
;
keywordCount
:
number
;
validationTimeMs
:
number
;
}
;
}
Type Parameters
TDocument
=
unknown
Hierarchy (
View Summary
)
CanonicalReferenceResultBase
CanonicalReferenceResolvedResult
FormatSchemaReferenceResolvedResult
Index
Properties
kind
ref
cache
Key
from
Cache
ok
status
document
body
text
content
Type?
http
Status
schema
Meta?
Properties
kind
kind
:
CanonicalReferenceKind
ref
ref
:
CanonicalReference
cache
Key
cacheKey
:
string
from
Cache
fromCache
:
boolean
ok
ok
:
true
status
status
:
"resolved"
document
document
:
TDocument
body
body
:
Uint8Array
text
text
:
string
Optional
content
Type
contentType
?:
string
http
Status
httpStatus
:
number
Optional
schema
Meta
schemaMeta
?:
{
draft
:
"draft-07"
|
"2020-12"
;
refCount
:
number
;
maxRefDepthSeen
:
number
;
keywordCount
:
number
;
validationTimeMs
:
number
;
}
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
kind
ref
cache
Key
from
Cache
ok
status
document
body
text
content
Type
http
Status
schema
Meta
Documentation
GitHub
npm
@adcp/sdk API Reference - v10.0.1
Loading...