testkube-sdk
Advanced tools
npm add testkube-sdk
yarn add testkube-sdk
import { TestkubeSDK } from "testkube-sdk";
(async () => {
const sdk = new TestkubeSDK();
const res = await sdk.api.abortExecution({
executionID: "string",
id: "<ID>",
});
if (res.statusCode == 200) {
// handle response
}
})();
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a next method that can be called to pull down the next group of results. If the
return value of next is null, then there are no more pages to be fetched.
Here's an example of one such pagination call:
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.SDKError | 400-600 | / |
Example
import { TestkubeSDK } from "testkube-sdk";
(async () => {
const sdk = new TestkubeSDK();
let res;
try {
res = await sdk.api.abortExecution({
executionID: "string",
id: "<ID>",
});
} catch (e) {}
if (res.statusCode == 200) {
// handle response
}
})();
You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://demo.testkube.io/results/v1 | None |
import { TestkubeSDK } from "testkube-sdk";
(async () => {
const sdk = new TestkubeSDK({
serverIdx: 0,
});
const res = await sdk.api.abortExecution({
executionID: "string",
id: "<ID>",
});
if (res.statusCode == 200) {
// handle response
}
})();
The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:
import { TestkubeSDK } from "testkube-sdk";
(async () => {
const sdk = new TestkubeSDK({
serverURL: "https://demo.testkube.io/results/v1",
});
const res = await sdk.api.abortExecution({
executionID: "string",
id: "<ID>",
});
if (res.statusCode == 200) {
// handle response
}
})();
The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.
For example, you could specify a header for every request that your sdk makes as follows:
from testkube-sdk import TestkubeSDK;
import axios;
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new TestkubeSDK({defaultClient: httpClient});
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
FAQs
<!-- Start SDK Installation [installation] --> ## SDK Installation
The npm package testkube-sdk receives a total of 4 weekly downloads. As such, testkube-sdk popularity was classified as not popular.
We found that testkube-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.