SaladCloudImdsSdk TypeScript SDK 0.9.0-alpha.4

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.1
• SDK version: 0.9.0-alpha.4

About the API

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

Table of Contents

• 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.getContainerStatus();

  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 | | :----------------------------------------------------------------- | :------------------------------------------------------- | | ReallocateContainer | Represents a request to reallocate a container. | | ContainerStatus | Represents the health statuses of the running container. | | ContainerToken | Represents the identity token of the running container. |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.