https://github.com/outscale/osc-sdk-js

Outscale SDK for TypeScript/JavaScript
https://github.com/outscale/osc-sdk-js

Last synced: 7 days ago
JSON representation

Outscale SDK for TypeScript/JavaScript

• Host: GitHub
• URL: https://github.com/outscale/osc-sdk-js
• Owner: outscale
• Created: 2022-05-18T11:24:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T14:05:49.000Z (4 months ago)
• Last Synced: 2024-07-29T18:22:02.997Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 5.03 MB
• Stars: 3
• Watchers: 4
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSES/BSD-3-Clause.txt

Awesome Lists containing this project

README

        
[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)

# Outscale SDK for TypeScript/JavaScript

Welcome to Outscale SDK for [typescript](https://www.typescriptlang.org/)/[javascript](https://en.wikipedia.org/wiki/JavaScript).

This SDK is generated to interact with [Outscale API service](https://docs.outscale.com/api) only (based on [openapi description](https://github.com/outscale/osc-api)).

This SDK provides a TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/).

# How to use this SDK ?

Install using npm:

```

npm install -save outscale-api

```

Alternativly, you can directly use github:

```

npm install --save github:outscale/osc-sdk-js

```

See [examples](examples/) folder to jump straight into the code!

# Building from sources

```

nvm install

npm install --local

npm run build

```

# Contributing

Check [contributing documentation](CONTRIBUTING.md).

# License

> Copyright Outscale SAS

>

> BSD-3-Clause

This project is compliant with [REUSE](https://reuse.software/).