Interface UrlReaderService

A generic interface for fetching plain data from URLs.

See the service documentation for more details.

interface UrlReaderService {
    readTree(
        url: string,
        options?: UrlReaderServiceReadTreeOptions,
    ): Promise<UrlReaderServiceReadTreeResponse>;
    readUrl(
        url: string,
        options?: UrlReaderServiceReadUrlOptions,
    ): Promise<UrlReaderServiceReadUrlResponse>;
    search(
        url: string,
        options?: UrlReaderServiceSearchOptions,
    ): Promise<UrlReaderServiceSearchResponse>;
}

Implemented by

Index

Methods

readTree readUrl search

Methods

readTree

readTree(
url: string,
options?: UrlReaderServiceReadTreeOptions,
): Promise<UrlReaderServiceReadTreeResponse>
Reads a full or partial file tree.
Parameters
- url: string
- Optionaloptions: UrlReaderServiceReadTreeOptions
Returns Promise<UrlReaderServiceReadTreeResponse>
- Defined in packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts:38

readUrl

readUrl(
url: string,
options?: UrlReaderServiceReadUrlOptions,
): Promise<UrlReaderServiceReadUrlResponse>
Reads a single file and return its content.
Parameters
- url: string
- Optionaloptions: UrlReaderServiceReadUrlOptions
Returns Promise<UrlReaderServiceReadUrlResponse>
- Defined in packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts:30

search

search(
url: string,
options?: UrlReaderServiceSearchOptions,
): Promise<UrlReaderServiceSearchResponse>
Searches for a file in a tree using a glob pattern.
Parameters
- url: string
- Optionaloptions: UrlReaderServiceSearchOptions
Returns Promise<UrlReaderServiceSearchResponse>
- Defined in packages/backend-plugin-api/src/services/definitions/UrlReaderService.ts:46