Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tflanagan/node-qb-record
A lightweight, promise based abstraction layer for Quick Base Records
https://github.com/tflanagan/node-qb-record
Last synced: about 2 months ago
JSON representation
A lightweight, promise based abstraction layer for Quick Base Records
- Host: GitHub
- URL: https://github.com/tflanagan/node-qb-record
- Owner: tflanagan
- License: other
- Created: 2017-09-14T13:50:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T04:20:43.000Z (12 months ago)
- Last Synced: 2024-11-12T21:22:08.816Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://tflanagan.github.io/node-qb-record/
- Size: 5.01 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
qb-record
=========
[](https://www.npmjs.com/package/qb-record) [](https://www.npmjs.com/package/qb-record) [](https://www.npmjs.com/package/qb-record)
A lightweight, promise based abstraction layer for Quick Base Records
Written in TypeScript, targets Nodejs and the Browser
This library targets the new RESTful JSON-based API, not the old XML-based API. If you want to use the old XML-based API, then please use [v2.x](https://github.com/tflanagan/node-qb-record/tree/v2.x/) of this library.
```
IE 11 Users, if you are receiving this error:
XMLHttpRequest: Network Error 0x80070005, Access is denied.
This is not a limitation of the library, just how Quick Base's new API works.
In order to use the new RESTful JSON-based API in Internet Explorer, you must
change a security setting:
- Go to Internet Options -> Security -> Custom Level
- Scroll down to and find the "Miscellaneous" section
- Ensure "Access data sources across domains" is set to "Enable"
- Click "OK", "Yes", "OK"
```
Install
-------
```
# Install
$ npm install --save qb-record
```
Documentation
-------------
[TypeDoc Documentation](https://tflanagan.github.io/node-qb-record/)
Server-Side Example
-------------------
```typescript
import { QBRecord } from 'qb-record';
import { QuickBase } from 'quickbase';
const quickbase = new QuickBase({
realm: 'www',
userToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx'
// Use tempToken if utilizing an authentication token sent
// up from client-side code. If possible, this is preferred.
// tempToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx'
});
const qbRecord = new QBRecord({
quickbase: quickbase,
dbid: 'xxxxxxxxx',
recordid: 3
});
(async () => {
try {
const results = await qbRecord.load();
console.log(qbRecord.get('recordid'), results.recordid);
}catch(err){
console.error(err);
}
})();
```
Client-Side Example
-------------------
Import `QBRecord` by loading `qb-record.browserify.min.js`
```javascript
var quickbase = new QuickBase({
realm: 'www'
});
var qbRecord = new QBRecord({
quickbase: quickbase,
dbid: 'xxxxxxxxx',
recordid: 3
});
// Using a Temporary Token
quickbase.getTempTokenDBID({
dbid: 'xxxxxxxxx'
}).then(function(results){
return qbRecord.load();
}).then(function(results){
console.log(qbField.get('recordid'), results.recordid);
}).catch(function(err){
console.error(err);
});
```
License
-------
Copyright 2019 Tristian Flanagan
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.