# space-client-js

> JS API client generated by OpenAPI Generator

Latest version **0.0.2** (published 2022-01-31) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install space-client-js
pnpm add space-client-js
yarn add space-client-js
bun add space-client-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-01-31 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 57.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | thiagorobert |

## Links

- npm: https://www.npmjs.com/package/space-client-js
- npm.io page: https://npm.io/package/space-client-js

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 0.0.2 (latest) — 2022-01-31
- 0.0.1 — 2022-01-24

## README

# space-client-js

TleApi - JavaScript client for [space-api](https://github.com/thiagorobert/space-api).

See [blog.thiago.pub](http://blog.thiago.pub) for more details.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Published at https://www.npmjs.com/package/space-client-js .

Install it via:

```shell
npm install space-client-js --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your space-client-js from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var TleApi = require('space-client-js');


var api = new TleApi.TleApi()
var tleDecodeReq = new TleApi.TleDecodeReq(); // {TleDecodeReq} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.tleDecode(tleDecodeReq, callback);

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*TleApi.TleApi* | [**tleDecode**](docs/TleApi.md#tleDecode) | **POST** /space/v1/tle/decode | 
*TleApi.TleApi* | [**tleToCorridor**](docs/TleApi.md#tleToCorridor) | **POST** /space/v1/tle/corridor | 
*TleApi.TleApi* | [**tleToOrbit**](docs/TleApi.md#tleToOrbit) | **POST** /space/v1/tle/orbit | 


## Documentation for Models

 - [TleApi.TleData](docs/TleData.md)
 - [TleApi.TleDecodeReq](docs/TleDecodeReq.md)
 - [TleApi.TleDecodeRes](docs/TleDecodeRes.md)
 - [TleApi.TleToCorridorReq](docs/TleToCorridorReq.md)
 - [TleApi.TleToCorridorRes](docs/TleToCorridorRes.md)
 - [TleApi.TleToOrbitReq](docs/TleToOrbitReq.md)
 - [TleApi.TleToOrbitRes](docs/TleToOrbitRes.md)


## Documentation for Authorization

All endpoints do not require authorization.

---
_Source: https://npm.io/package/space-client-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._