Class ProviderBase`Abstract`

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

ProviderBase

Index

Properties

kind name displayName description version

Methods

resolveName providerMetadata configureProvider supportsHealthCheck healthCheck startProvider warnings closeProvider

Properties

`Abstract` `Readonly`kind

kind: ProviderKind

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>

startProvider

startProvider(): Promise<void>
Returns Promise<void>

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>