Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saladtechnologies/salad-cloud-imds-sdk-javascript
SaladCloud IMDS SDK for JavaScript and TypeScript
https://github.com/saladtechnologies/salad-cloud-imds-sdk-javascript
Last synced: 6 days ago
JSON representation
SaladCloud IMDS SDK for JavaScript and TypeScript
- Host: GitHub
- URL: https://github.com/saladtechnologies/salad-cloud-imds-sdk-javascript
- Owner: SaladTechnologies
- License: mit
- Created: 2024-09-05T22:09:34.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-05T04:32:04.000Z (about 1 month ago)
- Last Synced: 2024-10-05T04:44:29.468Z (about 1 month ago)
- Language: TypeScript
- Size: 150 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# 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](https://docs.salad.com/api-reference) for more details.
## Table of Contents
- [Setup & Configuration](#setup--configuration)
- [Supported Language Versions](#supported-language-versions)
- [Installation](#installation)
- [Setting a Custom Timeout](#setting-a-custom-timeout)
- [Sample Usage](#sample-usage)
- [Services](#services)
- [Models](#models)
- [License](#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`:
```bash
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:
```ts
const saladCloudImdsSdk = new SaladCloudImdsSdk({ timeout: 10000 });
```
# Sample Usage
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
```ts
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.
Below is a list of all available services with links to their detailed documentation:
| Name |
| :----------------------------------------------------------- |
| [MetadataService](documentation/services/MetadataService.md) |
## 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.
Below is a list of all available models with links to their detailed documentation:
| Name | Description |
| :----------------------------------------------------------------- | :------------------------------------------------------- |
| [ReallocateContainer](documentation/models/ReallocateContainer.md) | Represents a request to reallocate a container. |
| [ContainerStatus](documentation/models/ContainerStatus.md) | Represents the health statuses of the running container. |
| [ContainerToken](documentation/models/ContainerToken.md) | Represents the identity token of the running container. |
## License
This SDK is licensed under the MIT License.
See the [LICENSE](LICENSE) file for more details.