@fern-api/terminal v0.0.4

Terminal Node API Library

The Terminal Node.js library provides convenient access to the Terminal API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install --save @fern-api/terminal
# or
yarn add @fern-api/terminal

Usage

import { TerminalClient } from '@fern-api/terminal';

const terminal = new TerminalClient({
  token: 'YOUR_API_KEY',
});

const drivers = await terminal.drivers.listDrivers({
  raw: true
});

console.log('Received drivers', drivers);

Handling errors

When the API returns a non-success status code (4xx or 5xx response), a subclass of TerminalError will be thrown:

import { TerminalError } from '@fern-api/terminal';

try {
  await terminal.drivers.listDrivers({
    raw: true
  });
} catch (err) {
  if (err instanceof TerminalError) {
    console.log(err.statusCode);
    console.log(err.message);
    console.log(err.body);
  }
}

Error codes are as followed:

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!