Interface VSXRegistryService

interface VSXRegistryService {
    fetchLanguagePackInfo(downloadUrl: string): Promise<LanguageInfo[]>;
    fetchReadme(readmeUrl: string): Promise<undefined | string>;
    findLatestCompatibleExtension(
        query: VSXQueryOptions,
    ): Promise<undefined | VSXExtensionRaw>;
    query(queryOptions?: VSXQueryOptions): Promise<VSXQueryResult>;
    search(searchOptions?: VSXSearchOptions): Promise<VSXSearchResult>;
}

Implemented by

VSXRegistryServiceImpl

Index

Methods

fetchLanguagePackInfo fetchReadme findLatestCompatibleExtension query search

Methods

fetchLanguagePackInfo

fetchLanguagePackInfo(downloadUrl: string): Promise<LanguageInfo[]>
Fetch language pack info from an extension's manifest. Derives the manifest URL from the download URL, fetches and parses it.
Parameters
- downloadUrl: string
Returns Promise<LanguageInfo[]>
- Defined in packages/vsx-registry/src/common/vsx-registry-service.ts:51

fetchReadme

fetchReadme(readmeUrl: string): Promise<undefined | string>
Fetch an extension's readme content. Returns the text content, or undefined on error/404.
Parameters
- readmeUrl: string
Returns Promise<undefined | string>
- Defined in packages/vsx-registry/src/common/vsx-registry-service.ts:45

findLatestCompatibleExtension

findLatestCompatibleExtension(
query: VSXQueryOptions,
): Promise<undefined | VSXExtensionRaw>
Find the latest version of an extension that is compatible with the current VS Code API version. Runs the OVSXApiFilter loop on the backend, collapsing potentially many HTTP requests into a single RPC call.
Parameters
- query: VSXQueryOptions
Returns Promise<undefined | VSXExtensionRaw>
- Defined in packages/vsx-registry/src/common/vsx-registry-service.ts:39

query

query(queryOptions?: VSXQueryOptions): Promise<VSXQueryResult>
Query extensions. Delegates to OVSXClient.query().
Parameters
- OptionalqueryOptions: VSXQueryOptions
Returns Promise<VSXQueryResult>
- Defined in packages/vsx-registry/src/common/vsx-registry-service.ts:32

search

search(searchOptions?: VSXSearchOptions): Promise<VSXSearchResult>
Search extensions. Delegates to OVSXClient.search().
Parameters
- OptionalsearchOptions: VSXSearchOptions
Returns Promise<VSXSearchResult>
- Defined in packages/vsx-registry/src/common/vsx-registry-service.ts:27

Interface VSXRegistryService

Implemented by

Index

Methods

Methods

fetchLanguagePackInfo

Parameters

Returns Promise<LanguageInfo[]>

fetchReadme

Parameters

Returns Promise<undefined | string>

findLatestCompatibleExtension

Parameters

Returns Promise<undefined | VSXExtensionRaw>

query

Parameters

Returns Promise<VSXQueryResult>

search

Parameters

Returns Promise<VSXSearchResult>

Settings

On This Page