# quickbase-cors

> A lightweight, very flexible QuickBase API originally build by @tflanagan with edits to use proxy urls to resolve CORS issues in modern borwsers, clients and apps.

Latest version **2.12.6** (published 2020-03-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install quickbase-cors
pnpm add quickbase-cors
yarn add quickbase-cors
bun add quickbase-cors
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.12.6 |
| Published | 2020-03-05 |
| First published | 2019-06-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 43.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tamal Dey |
| Maintainers | tamalweb |
| Keywords | quickbase |

## Links

- npm: https://www.npmjs.com/package/quickbase-cors
- Repository: https://github.com/tamal3053/quickbase-cors
- Homepage: https://github.com/tamal3053/quickbase-cors#readme
- Issues: https://github.com/tamal3053/quickbase-cors/issues
- npm.io page: https://npm.io/package/quickbase-cors

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.19
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.5
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1
- [generic-throttle](https://npm.io/package/generic-throttle.md) ^1.3.0

## Recent versions

- 2.12.6 (latest) — 2020-03-05
- 2.11.5 — 2019-09-03
- 2.11.4 — 2019-09-03
- 2.11.3 — 2019-08-08
- 2.11.2 — 2019-07-29
- 2.11.1 — 2019-06-27
- 2.11.0 — 2019-06-27
- 2.10.4 — 2019-06-27

## README

quickbase-cors
==============

A lightweight, very flexible QuickBase API

[API Documentation](https://github.com/tflanagan/node-quickbase/blob/master/documentation/api.md)

[PHP Version](https://github.com/tflanagan/php-quickbase)

Install
-------
```
# Latest Stable Release
$ npm install quickbase-cors
or 
$ yarn add quickbase-cors
```

Browserify
----------
To use the Browserify version go to : https://github.com/tflanagan/node-quickbase

Example
-------
```javascript
import QuickBase from "quickbase-cors";

const quickbase = new QuickBase({
    proxy: 'https://cors-anywhere.herokuapp.com',  // Set your PROXY URL here
    port: '1337', // Set Your PORT address here.
    addProtocol: false, // some proxy does not support protocol. If true https:// will be added.
	realm: 'www',
	appToken: '*****',
	// userToken: '*****'
});

// If using user tokens, you do not need to call API_Authenticate

/* Promise Based */
quickbase.api('API_Authenticate', {
	username: '*****',
	password: '*****'
}).then((result) => {
	return quickbase.api('API_DoQuery', {
		dbid: '*****',
		clist: '3.12',
		options: 'num-5'
	}).then((result) => {
		return result.table.records;
	});
}).each((record) => {
	return quickbase.api('API_EditRecord', {
		dbid: '*****',
		rid: record[3],
		fields: [
			{ fid: 12, value: record[12] }
		]
	});
}).then(() => {
	return quickbase.api('API_DoQuery', {
		dbid: '*****',
		clist: '3.12',
		options: 'num-5'
	});
}).then((result) => {
	console.log(result);
}).catch((err) => {
	console.error(err);
});
```

---

### Originally Developed by Tristian Flanagan -> [tflanagan](https://github.com/tflanagan)

---


License
-------
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

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