{"id":21305580,"url":"https://github.com/tflanagan/node-quickbase","last_synced_at":"2025-05-07T17:43:35.232Z","repository":{"id":17268257,"uuid":"20037921","full_name":"tflanagan/node-quickbase","owner":"tflanagan","description":"A lightweight, very flexible QuickBase API for Node.js","archived":false,"fork":false,"pushed_at":"2024-06-16T10:03:37.000Z","size":11694,"stargazers_count":45,"open_issues_count":2,"forks_count":30,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-02-19T02:13:38.557Z","etag":null,"topics":["api","browser","javascript","nodejs","quickbase","quickbase-api"],"latest_commit_sha":null,"homepage":"https://tflanagan.github.io/node-quickbase/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tflanagan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-21T21:23:51.000Z","updated_at":"2024-07-19T11:08:07.000Z","dependencies_parsed_at":"2023-02-16T21:16:02.894Z","dependency_job_id":"776fac90-3f82-4109-a8e4-fdde07709f6e","html_url":"https://github.com/tflanagan/node-quickbase","commit_stats":{"total_commits":404,"total_committers":6,"mean_commits":67.33333333333333,"dds":"0.21039603960396036","last_synced_commit":"9be81851d9813cd91cd15d6d20eb9f50aa792c69"},"previous_names":[],"tags_count":133,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tflanagan%2Fnode-quickbase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tflanagan%2Fnode-quickbase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tflanagan%2Fnode-quickbase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tflanagan%2Fnode-quickbase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tflanagan","download_url":"https://codeload.github.com/tflanagan/node-quickbase/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240783138,"owners_count":19856780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","browser","javascript","nodejs","quickbase","quickbase-api"],"created_at":"2024-11-21T16:18:30.930Z","updated_at":"2025-02-26T03:15:42.956Z","avatar_url":"https://github.com/tflanagan.png","language":"TypeScript","readme":"quickbase\n=========\n\n[![npm license](https://img.shields.io/npm/l/quickbase.svg)](https://www.npmjs.com/package/quickbase) [![npm version](https://img.shields.io/npm/v/quickbase.svg)](https://www.npmjs.com/package/quickbase) [![npm downloads](https://img.shields.io/npm/dm/quickbase.svg)](https://www.npmjs.com/package/quickbase)\n\nA lightweight, typed, promise-based Quickbase API, autogenerated from the OpenAPI spec\n\nWritten in TypeScript, targets Nodejs and the Browser.\n\nA large chunk of this library is generated based on the OpenAPI definition found at [https://developer.quickbase.com/](https://developer.quickbase.com/).\n\nAll the types and public methods are generated and kept updated directly from the OpenAPI definition.\n\nYou can find this code in `src/code-generation/`.\n\nThis library targets the RESTful, JSON-based API, not the XML-based API. If you want to use the XML-based API, then please use [v2.x](https://github.com/tflanagan/node-quickbase/tree/v2.x/) of this library.\n\n```\nIE 11 Users, if you are receiving this error:\nXMLHttpRequest: Network Error 0x80070005, Access is denied.\n\nThis is not a limitation of the library, just how Quickbase's new API works.\nIn order to use the new RESTful JSON-based API in Internet Explorer, you must\nchange a security setting:\n\n- Go to Internet Options -\u003e Security -\u003e Custom Level\n- Scroll down to and find the \"Miscellaneous\" section\n- Ensure \"Access data sources across domains\" is set to \"Enable\"\n- Click \"OK\", \"Yes\", \"OK\"\n```\n\nInstall\n-------\n```\n# Install\n$ npm install --save quickbase\n```\n\nDocumentation\n-------------\n\n[TypeDoc Documentation](https://tflanagan.github.io/node-quickbase/)\n[Quickbase Documentation](https://developer.quickbase.com/)\n\nServer-Side Example\n-------------------\n```typescript\nimport { QuickBase } from 'quickbase';\n\nconst quickbase = new QuickBase({\n    realm: 'www',\n    userToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx'\n    // Use tempToken if utilizing an authentication token sent\n    // up from client-side code. If possible, this is preferred.\n    // tempToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx',\n    // appToken: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n});\n\n(async () =\u003e {\n    try {\n        const results = await quickbase.getApp({\n            appId: 'xxxxxxxxx'\n        });\n\n        console.log(results.name);\n    }catch(err){\n        console.error(err);\n    }\n})();\n```\n\nClient-Side Example\n-------------------\nImport `QuickBase` by loading `quickbase.browserify.min.js`\n\n```javascript\nvar quickbase = new QuickBase({\n    realm: 'www',\n    appToken: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n});\n\n// Using a Temporary Token\nquickbase.getTempTokenDBID({\n    dbid: 'xxxxxxxxx'\n}).then(function(results){\n    return quickbase.getApp({\n        appId: 'xxxxxxxxx'\n    });\n}).then(function(results){\n    console.log(results.name);\n}).catch(function(err){\n    console.error(err);\n});\n```\n\nDebugging\n---------\n\nServer-side, set the environment variable `DEBUG` to `quickbase:*`.\n\nIn the browser, open the dev console and enter: `window.localStorage.debug = 'quickbase:*'`.\n\nThe used debug namespaces: `main`, `request`, `response` and for development: `build` and `generate`.\n\nDevelopment\n-----------\n\n```\n# Fork and clone the repository\n$ yarn install\n$ git checkout -b feature/branch\n# Download the latest OAS definition and replace in `assets/QuickBase_RESTful_API.json`\n$ yarn run generate\n# Manually modify as required\n$ yarn run build\n$ yarn run test\n$ yarn run docs\n$ git add\n$ git commit\n$ git push -u origin feature/branch\n```\n\nLicense\n-------\nCopyright 2014 Tristian Flanagan\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftflanagan%2Fnode-quickbase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftflanagan%2Fnode-quickbase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftflanagan%2Fnode-quickbase/lists"}