@saladtechnologies-oss/salad-cloud-imds-sdk NPM

SaladCloudImdsSdk TypeScript SDK 0.9.0-alpha.5

Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.

Versions

API version: 0.9.0-alpha.2
SDK version: 0.9.0-alpha.5

About the API

The SaladCloud Instance Metadata Service (IMDS). Please refer to the SaladCloud API Documentation for more details.

Setup & Configuration
- Supported Language Versions
- Installation
Setting a Custom Timeout
Sample Usage
Services
Models
License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install @saladtechnologies-oss/salad-cloud-imds-sdk

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const saladCloudImdsSdk = new SaladCloudImdsSdk({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { SaladCloudImdsSdk } from '@saladtechnologies-oss/salad-cloud-imds-sdk';

(async () => {
  const saladCloudImdsSdk = new SaladCloudImdsSdk({});

  const { data } = await saladCloudImdsSdk.metadata.getDeletionCost();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

Name
MetadataService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Name	Description
DeletionCost	The deletion cost of the current container instance.
SaladCloudImdsError	An API error. The `code` and `type` uniquely identify the type of the error. The `code` is a short value that may be used for programmatic error handling. The `type` is an absolute URL that may be resolved for more detailed information. Refer to the SaladCloud IMDS reference for a list of the expected `code` and `type` values. Also, note that all properties are optional. Clients should implement robust error handling to account for unexpected errors.
ReallocatePrototype	Represents a request to reallocate the current container instance to another SaladCloud node.
Status	The health statuses of the current container instance.
Token	The identity token of the current container instance.