Backstage
Docs
Github
Preparing search index...
@backstage/plugin-techdocs-react
index
TechDocsStorageApi
Interface TechDocsStorageApi
API which talks to TechDocs storage to fetch files to render.
interface
TechDocsStorageApi
{
getApiOrigin
()
:
Promise
<
string
>
;
getBaseUrl
(
oldBaseUrl
:
string
,
entityId
:
CompoundEntityRef
,
path
:
string
,
)
:
Promise
<
string
>
;
getBuilder
()
:
Promise
<
string
>
;
getEntityDocs
(
entityId
:
CompoundEntityRef
,
path
:
string
)
:
Promise
<
string
>
;
getStorageUrl
()
:
Promise
<
string
>
;
syncEntityDocs
(
entityId
:
CompoundEntityRef
,
logHandler
?:
(
line
:
string
)
=>
void
,
)
:
Promise
<
SyncResult
>
;
}
Implemented by
TechDocsStorageClient
Index
Methods
get
Api
Origin
get
Base
Url
get
Builder
get
Entity
Docs
get
Storage
Url
sync
Entity
Docs
Methods
get
Api
Origin
getApiOrigin
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Base
Url
getBaseUrl
(
oldBaseUrl
:
string
,
entityId
:
CompoundEntityRef
,
path
:
string
,
)
:
Promise
<
string
>
Parameters
oldBaseUrl
:
string
entityId
:
CompoundEntityRef
path
:
string
Returns
Promise
<
string
>
get
Builder
getBuilder
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Entity
Docs
getEntityDocs
(
entityId
:
CompoundEntityRef
,
path
:
string
)
:
Promise
<
string
>
Parameters
entityId
:
CompoundEntityRef
path
:
string
Returns
Promise
<
string
>
get
Storage
Url
getStorageUrl
()
:
Promise
<
string
>
Returns
Promise
<
string
>
sync
Entity
Docs
syncEntityDocs
(
entityId
:
CompoundEntityRef
,
logHandler
?:
(
line
:
string
)
=>
void
,
)
:
Promise
<
SyncResult
>
Parameters
entityId
:
CompoundEntityRef
Optional
logHandler
:
(
line
:
string
)
=>
void
Returns
Promise
<
SyncResult
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Api
Origin
get
Base
Url
get
Builder
get
Entity
Docs
get
Storage
Url
sync
Entity
Docs
Docs
Github
Backstage
Loading...
API which talks to TechDocs storage to fetch files to render.