@kintone/kintone-js-sdk/README.md

The SDK of kintone REST API client on node and browser

# kintone-js-sdk
REST API client of kintone for node.js and javascript 

## ⚠️This package will be deprecated. Please use [@kintone/rest-api-client](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client) instead.
### Note when using [@kintone/rest-api-client](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client)
rest-api-client is being updated weekly.  
Currently, not all kintone-js-sdk's features are being supported on the rest-api-client.  
Once the rest-api-client supports all the necessary features for your use, it is highly recommended to switch over.  
For the latest features and news regarding the rest-api-client, please check the [reference](https://github.com/kintone/js-sdk/tree/master/packages/rest-api-client#references).

# How to build

## Requirement

```
* Node.js
* Git
```

```
$ git clone https://github.com/kintone/kintone-js-sdk.git
$ cd kintone-js-sdk
$ npm install
$ npm run build
```
### Output
```
/dist/kintone-js-sdk.min.js
/esm/browser/main.js
/cjs/node/main.js
```

# Installation
npm i @kintone/kintone-js-sdk

## Note
From v0.5.0 completely changed parameters of all modules' constructors and functions to single object parameters.
If you will not use v0.5.0 or upper, please specify the version to install.<br/>
Ex.
```
npm i @kintone/kintone-js-sdk@v0.4.2
```

# Usage
* UMD: include <i>kintone-js-sdk.min.js</i> from <i>dist</i> folder <br/>
```
const kintone = window.kintoneJSSDK;
```
* CommonJS: install kintone-js-sdk using "npm i @kintone/kintone-js-sdk"<br/>
```
const kintone = require('@kintone/kintone-js-sdk')
```
* ESM: install kintone-js-sdk using "npm i @kintone/kintone-js-sdk"<br/>
```
import * as kintoneJSSDK from '@kintone/kintone-js-sdk'
```


# Document
[kintone-js-sdk](https://kintone.github.io/kintone-js-sdk)

# License
MIT License

# Copyright
Copyright(c) Cybozu, Inc.