Test it

This library provides convenient access to the Test it REST API from TypeScript or JavaScript.

The full API of this library can be found in api.md.

Contents

• Installation
• Usage
• API Reference
• Authentication
• Errors
• Client Options
• Request Options
• Retries and Timeouts
• Helpers
• Logging
• Requirements

Installation

npm install @amritk/galaxy-dev-ts

Usage

import ApiTest from '@amritk/galaxy-dev-ts';

const client = new ApiTest({
  bearerAuth: process.env['BEARER_AUTH'], // defaults to the BEARER_AUTH env var
  environment: 'production',
});

const pizza = await client.planets.pizzas.list({
  limit: 10,
  offset: 0,
});

console.log(pizza);

The examples in the following sections assume a client configured as shown above.

See the API reference for every available operation.

Authentication

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

| Option | Type | Default | Description | | --- | --- | --- | --- | | bearerAuth | string \| provider | - | JWT Bearer token authentication Defaults to BEARER_AUTH. | | basicAuthUsername | string \| provider | - | Basic HTTP authentication Defaults to BASIC_AUTH_USERNAME. | | basicAuthPassword | string \| provider | - | Basic HTTP authentication Defaults to BASIC_AUTH_PASSWORD. | | apiKeyHeader | string \| provider | - | API key request header Defaults to API_KEY_HEADER. | | apiKeyCookie | string \| provider | - | API key browser cookie Defaults to API_KEY_COOKIE. | | oAuth2 | string \| provider | - | OAuth 2.0 authentication Defaults to O_AUTH2. | | openIDConnect | string \| provider | - | OpenID Connect Authentication Defaults to OPEN_ID_CONNECT. | | apiKeyQuery | string \| provider | - | API key query parameter Defaults to SCALAR_69_T4_L_API_KEY_QUERY. |

Declared schemes:

• bearerAuth bearer token
• basicAuth basic authentication
• apiKeyHeader API key in header X-API-Key
• apiKeyQuery API key in query api_key
• apiKeyCookie API key in cookie api_key
• oAuth2 OAuth2/OpenID Connect
• openIdConnect OAuth2/OpenID Connect

Errors

Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.

import { APIError } from '@amritk/galaxy-dev-ts';

try {
  const pizza = await client.planets.pizzas.list({
    limit: 10,
    offset: 0,
  });
} catch (err) {
  if (err instanceof APIError) {
    console.log(err.status, err.name, err.headers);
  }
  throw err;
}

Documented error statuses: 400, 401, 403, 404, 409, 422.

Client Options

Configure the generated client by setting any of these options when you create it.

import ApiTest from '@amritk/galaxy-dev-ts';

const client = new ApiTest({
  timeout: 60000,
  maxRetries: 2,
  logLevel: 'debug',
});

| Option | Type | Default | Description | | --- | --- | --- | --- | | bearerAuth | string \| AuthTokenProvider | process.env["BEARER_AUTH"] | JWT Bearer token authentication | | basicAuthUsername | string \| AuthTokenProvider | process.env["BASIC_AUTH_USERNAME"] | Basic HTTP authentication | | basicAuthPassword | string \| AuthTokenProvider | process.env["BASIC_AUTH_PASSWORD"] | Basic HTTP authentication | | apiKeyHeader | string \| AuthTokenProvider | process.env["API_KEY_HEADER"] | API key request header | | apiKeyCookie | string \| AuthTokenProvider | process.env["API_KEY_COOKIE"] | API key browser cookie | | oAuth2 | string \| AuthTokenProvider | process.env["O_AUTH2"] | OAuth 2.0 authentication | | openIDConnect | string \| AuthTokenProvider | process.env["OPEN_ID_CONNECT"] | OpenID Connect Authentication | | apiKeyQuery | string \| AuthTokenProvider | process.env["SCALAR_69_T4_L_API_KEY_QUERY"] | API key query parameter | | environment | Environment | - | Select one of the configured API environments. | | baseURL | string \| null | process.env["SCALAR_69_T4_L_BASE_URL"] | Override the default API base URL. Pass null when selecting a configured environment. | | timeout | number | 60000 | Maximum time in milliseconds to wait for a response before aborting a request. | | maxRetries | number | 2 | Number of retries for temporary failures. | | defaultHeaders | HeadersInit | - | Headers sent with every request. | | defaultQuery | Record<string, string \| undefined> | - | Query parameters sent with every request. | | fetchOptions | RequestInit | - | Additional fetch options sent with every request. | | fetch | Fetch | - | Custom fetch implementation. | | logLevel | "off" \| "error" \| "warn" \| "info" \| "debug" \| null | process.env["SCALAR_69_T4_L_LOG"] | Controls request and retry debug logging. | | logger | Logger \| null | console | Custom logger implementation. |

Request Options

| Option | Type | Default | Description | | --- | --- | --- | --- | | headers | HeadersInit | - | Per-request headers. | | query | Record<string, unknown> | - | Per-request query parameters. | | body | unknown | - | Override the generated request body. | | timeout | number | - | Per-request timeout in milliseconds. | | maxRetries | number | - | Per-request retry count. | | signal | AbortSignal | - | Abort an in-flight request. | | fetchOptions | RequestInit | - | Per-request fetch options. | | idempotencyKey | string | - | Idempotency key for retry-safe operations. Applies to this request and its retries. |

Retries and Timeouts

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor Retry-After headers when present. Tune the retry and timeout client options shown above, or override them per request.

Helpers

• Use .withResponse() on any request to inspect both parsed data and the raw Response object.
• Every operation returns an APIPromise, so you can await it directly or chain .withResponse().

Logging

• Set logLevel: "debug" to log request URLs, options, response status, response headers, and retry attempts.
• Pass a custom logger to route logs into your own observability pipeline.
• Set logLevel: null to disable environment-driven logging.

Requirements

• Node.js 20+, a modern browser, or any runtime with fetch support

Powered by Scalar.