Registry / devops / qovery-ws-typescript-axios

qovery-ws-typescript-axios

library0.1.598jsnpmunverified

OpenAPI-generated TypeScript/JavaScript client for Qovery WebSocket API, version 0.1.598. This package provides auto-generated API bindings using Axios for HTTP communication. It is updated frequently (pre-release) and targets ES5+ environments with both CommonJS and ES module support. Ship TypeScript definitions via package.json. Compared to manual SDKs, it stays in sync with the OpenAPI spec but may include breaking changes between versions.

devops

npm install qovery-ws-typescript-axios

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · QOVERY-WS-TYPESCRI

qovery-ws-typescript-axios

devopsjavascriptv0.1.598

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DefaultApi

✓ import { DefaultApi } from 'qovery-ws-typescript-axios'

✗ const DefaultApi = require('qovery-ws-typescript-axios').DefaultApi

ESM or CJS both supported.

Configuration

✓ import { Configuration } from 'qovery-ws-typescript-axios'

Configuration class for setting API keys, base path, etc.

WebsocketApi

✓ import { WebsocketApi } from 'qovery-ws-typescript-axios'

Available if endpoint is defined in OpenAPI spec.

Initializes API client with API key from environment variable, lists environments.

import { DefaultApi, Configuration } from 'qovery-ws-typescript-axios'; const apiKey = process.env.QOVERY_API_KEY ?? ''; const config = new Configuration({ apiKey }); const api = new DefaultApi(config); api.listEnvironments().then(resp => console.log(resp.data)).catch(err => console.error(err));

Debug

Known issues

breakingVersion 0.x is pre-release; breaking changes may occur without major version bump.

fix

Pin exact version and test upgrades.

affects: >=0.0.0

gotchaThe package uses OpenAPI generator output; endpoint method names depend on operationId in spec.

fix

Check generated code or OpenAPI spec for actual method names.

affects: >=0.0.0

gotchaRequires Promises/A+ library in ES5 environment (e.g., old Node or IE11).

fix

Use a polyfill like es6-promise or use Node >= 4.

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module 'qovery-ws-typescript-axios'

Package not installed or not resolved.

fix

Run `npm install qovery-ws-typescript-axios`.

AxiosError: Request failed with status code 401

Invalid or missing API key.

fix

Set QOVERY_API_KEY environment variable or provide correct apiKey in Configuration.

Upgrade

Version history

0.1.598latest on npm

Audit

Dependencies

axiosrequiredHTTP client used for API calls

Agent activity

7 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/Qovery/qovery-client-ws-typescript-axios ↗

packageqovery-ws-typescript-axios ↗

homepagehttps://github.com/Qovery/qovery-client-ws-typescript-axios#readme ↗