Class TechDocsStorageClient

constructor

• new TechDocsStorageClient(
      options: {
          configApi: Config;
          discoveryApi: DiscoveryApi;
          fetchApi: FetchApi;
          identityApi?: IdentityApi;
      },
  ): TechDocsStorageClient

  Parameters

  • options: {
        configApi: Config;
        discoveryApi: DiscoveryApi;
        fetchApi: FetchApi;
        identityApi?: IdentityApi;
    }

    • configApi: Config

    • discoveryApi: DiscoveryApi

    • fetchApi: FetchApi

    • OptionalidentityApi?: IdentityApi

      Deprecated

      identityApi is not needed any more

  Returns TechDocsStorageClient

configApi

discoveryApi

getApiOrigin

• getApiOrigin(): Promise<string>

  Returns Promise<string>

getBaseUrl

• getBaseUrl(
      oldBaseUrl: string,
      entityId: CompoundEntityRef,
      path: string,
  ): Promise<string>

  Parameters

  • oldBaseUrl: string
  • entityId: CompoundEntityRef
  • path: string

  Returns Promise<string>

getBuilder

• getBuilder(): Promise<string>

  Returns Promise<string>

getEntityDocs

• getEntityDocs(entityId: CompoundEntityRef, path: string): Promise<string>

  Fetch HTML content as text for an individual docs page in an entity's docs site.

  Parameters

  • entityId: CompoundEntityRef

    Object containing entity data like name, namespace, etc.

  • path: string

    The unique path to an individual docs page e.g. overview/what-is-new

  Returns Promise<string>

  HTML content of the docs page as string

  Throws

  Throws error when the page is not found.

getStorageUrl

• getStorageUrl(): Promise<string>

  Returns Promise<string>

syncEntityDocs

• syncEntityDocs(
      entityId: CompoundEntityRef,
      logHandler?: (line: string) => void,
  ): Promise<SyncResult>

  Check if docs are on the latest version and trigger rebuild if not

  Parameters

  • entityId: CompoundEntityRef

    Object containing entity data like name, namespace, etc.

  • logHandler: (line: string) => void = ...

    Callback to receive log messages from the build process

  Returns Promise<SyncResult>

  Whether documents are currently synchronized to newest version

  Throws

  Throws error on error from sync endpoint in TechDocs Backend