Interface DataProvider

interface DataProvider {
    name: string;
    search?(
        query: string,
        options?: DataProviderSearchOptions,
    ): Promise<ToolResult<DataProviderSearchResult[]>>;
    getByUrl?(url: string): Promise<ToolResult<DataProviderPageData>>;
    getCustomHandlers?(): DataProviderCustomHandler[];
    init?(): Promise<void>;
    destroy?(): Promise<void>;
}

Index

Properties

Methods

search? getByUrl? getCustomHandlers? init? destroy?

Properties

`Readonly`name

name: string

Methods

`Optional`search

search?(
query: string,
options?: DataProviderSearchOptions,
): Promise<ToolResult<DataProviderSearchResult[]>>
Parameters
- query: string
- Optionaloptions: DataProviderSearchOptions
Returns Promise<ToolResult<DataProviderSearchResult[]>>
- Defined in core/types.ts:734

`Optional`getByUrl

getByUrl?(url: string): Promise<ToolResult<DataProviderPageData>>
Parameters
- url: string
Returns Promise<ToolResult<DataProviderPageData>>
- Defined in core/types.ts:735

`Optional`getCustomHandlers

getCustomHandlers?(): DataProviderCustomHandler[]
Returns DataProviderCustomHandler[]
- Defined in core/types.ts:736

`Optional`init

init?(): Promise<void>
Returns Promise<void>
- Defined in core/types.ts:738

`Optional`destroy

destroy?(): Promise<void>
Returns Promise<void>
- Defined in core/types.ts:739