npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

testkube-sdk

v2.3.5

Published

<!-- Start SDK Installation [installation] --> ## SDK Installation

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

olensmarolensmaraabedrabaaabedraba

Keywords

Readme

testkube-sdk

SDK Installation

NPM

npm add testkube-sdk

Yarn

yarn add testkube-sdk

SDK Example Usage

Example

import { TestkubeSDK } from "testkube-sdk";

async function run() {
    const sdk = new TestkubeSDK();

    const res = await sdk.api.abortExecution({
        executionID: "<value>",
        id: "<id>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Available Resources and Operations

api

executions

tests

artifacts

logs

executor

keymap

labels

repository

testSources

testSuites

testTriggers

webhook

Error Handling

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 | 4xx-5xx | / |

Example

import { TestkubeSDK } from "testkube-sdk";

async function run() {
    const sdk = new TestkubeSDK();

    let res;
    try {
        res = await sdk.api.abortExecution({
            executionID: "<value>",
            id: "<id>",
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Server Selection

Select Server by Index

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 |

Example

import { TestkubeSDK } from "testkube-sdk";

async function run() {
    const sdk = new TestkubeSDK({
        serverIdx: 0,
    });

    const res = await sdk.api.abortExecution({
        executionID: "<value>",
        id: "<id>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Override Server URL Per-Client

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 function run() {
    const sdk = new TestkubeSDK({
        serverURL: "https://demo.testkube.io/results/v1",
    });

    const res = await sdk.api.abortExecution({
        executionID: "<value>",
        id: "<id>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios 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:

import { testkube-sdk } from "TestkubeSDK";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new TestkubeSDK({defaultClient: httpClient});

Maturity

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.

Contributions

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!

SDK Created by Speakeasy