Create a new instance of a RDS API Server.
The full URL to the RDS API, i.e. https://covid19.richdataservices.com/rds
The base url to the RDS API, i.e. https://covid19.richdataservices.com/rds
The url parsed out into its partials
The url for the server related API endpoints
Create and get an instance of a RDS Catalog that exists on this RdsServer. This is a convenience method, these two code snippets are equivalent:
const catalog = new RdsServer('https://covid19.richdataservices.com/rds')
.getCatalog('int');and
const server = new RdsServer('https://covid19.richdataservices.com/rds');
const catalog = new RdsCatalog(server, 'int');the ID of the specific catalog
whether to automatically start resolving all the catalog's own properties, defaults to false
a new RdsCatalog
Get changelog. Shows the change log of RDS providing version information about additions, changes, deprecations, fixed bugs, removals, and security enhancements.
an array of information about each version and the changes between them.
Get server information. Provides the server information for RDS.
information about the RDS Server
Get the root catalog of the system. This will hold a list of all the catalogs and data products that are available on this server. This would ideally be used to power an entry point into an application. The catalog provides a starting point for users to view what is available to them and drill down into a catalog or data product of their interest. The catalogs and products may have descriptive metadata on them that is useful to display.
the root catalog of the RDS server
Factory method for instantiating an RdsServer from the individual url parts.
The protocol used on the site the RDS API is hosted, defaults to 'https'
The domain under which the RDS API is hosted, i.e. 'covid19.richdataservices.com'
The path where the RDS API is hosted, defaults to '/rds'
Optional port where the RDS API is hosted, or undefined if not applicable
a new RdsServer
Generated using TypeDoc
An instance of a RDS API server. A basic building block to interact with a RDS API. Includes methods to query server-level information.
const covidServer = new RdsServer('https://covid19.richdataservices.com/rds'); covidServer .getInfo() .then((res: HttpResponse<ServerInformation>) => { console.log('Server info:', res.parsedBody); } );