# kstore-sdk

> Javascript SDK for kstore(https://roostore.cn)

Latest version **0.0.4** (published 2020-10-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install kstore-sdk
pnpm add kstore-sdk
yarn add kstore-sdk
bun add kstore-sdk
```

## 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.4 |
| Published | 2020-10-19 |
| First published | 2020-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 47.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | lightime |

## Links

- npm: https://www.npmjs.com/package/kstore-sdk
- npm.io page: https://npm.io/package/kstore-sdk

## 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.4 (latest) — 2020-10-19
- 0.0.3 — 2020-10-15
- 0.0.1 — 2020-10-15

## README

# kstore-sdk

KstoreSdk - JavaScript client for kstore-sdk
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

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

## Installation

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

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install kstore-sdk --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 kstore-sdk 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 KstoreSdk = require('kstore-sdk');

var defaultClient = KstoreSdk.ApiClient.instance;
// Configure API key authorization: JWT
var JWT = defaultClient.authentications['JWT'];
JWT.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix['X-Custom-Key'] = "Token"

var api = new KstoreSdk.LifeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.lifeGet(callback);

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*KstoreSdk.LifeApi* | [**lifeGet**](docs/LifeApi.md#lifeGet) | **GET** /life | 获取后端状态
*KstoreSdk.UserApi* | [**loginGet**](docs/UserApi.md#loginGet) | **GET** /user/login | 用户登录


## Documentation for Models

 - [KstoreSdk.LifeStatus](docs/LifeStatus.md)
 - [KstoreSdk.User](docs/User.md)
 - [KstoreSdk.UserLogin](docs/UserLogin.md)


## Documentation for Authorization



### JWT


- **Type**: API key
- **API key parameter name**: X-Custom-Key
- **Location**: HTTP header

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