@theia/ovsx-client
TypeScript icon, indicating that this package has built-in type declarations

1.56.0 • Public • Published

theia-ext-logo

ECLIPSE THEIA - OVSX CLIENT


Description

The @theia/ovsx-client package is used to interact with open-vsx through its REST APIs. The package allows clients to fetch extensions and their metadata, search the registry, and includes the necessary logic to determine compatibility based on a provided supported API version.

Note that this client only supports a subset of the whole OpenVSX API, only what's relevant to clients like Theia applications.

OVSXRouterClient

This class is an OVSXClient that can delegate requests to sub-clients based on some configuration (OVSXRouterConfig).

{
    "registries": {
        // `[Alias]: URL` pairs to avoid copy pasting URLs down the config
    },
    "use": [
        // List of aliases/URLs to use when no filtering was applied.
    ],
    "rules": [
        {
            "ifRequestContains": "regex matched against various fields in requests",
            "ifExtensionIdMatches": "regex matched against the extension id (without version)",
            "use": [/*
                List of registries to forward the request to when all the
                conditions are matched.

                `null` or `[]` means to not forward the request anywhere.
            */]
        }
    ]
}

Additional Information

License

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia

Readme

Keywords

none

Package Sidebar

Install

npm i @theia/ovsx-client

Weekly Downloads

3,856

Version

1.56.0

License

EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0

Unpacked Size

160 kB

Total Files

67

Last publish

Collaborators

  • eclipsetheia
  • vince-fugnitto
  • bhufmann
  • marc.dumais
  • paul-marechal
  • msujew
  • tsmaeder
  • jfaltermeier
  • jhelming
  • eclipse-theia-bot
  • sgraband