airtable-node
v0.1.20
Published
Node wrapper for Airtable API.
Downloads
1,192
Readme
airtable-node
Node wrapper for Airtable API
Installation
$ npm i airtable-node --save
Usage
const Airtable = require('airtable-node');
const airtable = new Airtable({ apiKey: 'xxx' })
.base('appRvT3sM3XOBruUk')
.table('Team Members')
airtable.list().then(resp => {
console.log(resp)
})
airtable.list({
filterByFormula: `NOT({Feature} = '')`, // optional
maxRecords: 200, // optional
pageSize: 100, // optional
sort: [{ field: 'name', direction: 'asc' }], // optional
view: 'Airtable View', // optional
cellFormat: 'json', // optional
timeZone, // optional
userLocale // optional
},
offset //optional
).then(resp => {
console.log(resp)
})
Methods
Airtable({ apiKey, base, table, view })
- required: apiKey
- all other parameters can be set via chaining
Example
const airtable = new Airtable({ apiKey, base, table, view })
Airtable.list(params)
Airtable.list returns a promise.
Example
const airtable = new Airtable({ apiKey, base, table, view })
airtable.list({
maxRecords: 200
}).then(resp => {
console.log(resp)
})
Airtable.update(id, { fields })
Example
const airtable = new Airtable({ apiKey, base, table })
const id = 'airtable record id'
const fields = {
some_field_name: 'some value'
}
airtable.update(id, { fields }).then(resp => {
console.log(resp)
})
Airtable.retrieve(id)
- required: id
const airtable = new Airtable({ apiKey, base, table })
const id = 'airtable record id'
airtable.retrieve(id).then(resp => {
console.log(resp)
})
Airtable.delete(id)
- required: id
Example
const airtable = new Airtable({apiKey, base, table})
const id = 'airtable record id'
airtable.delete(id).then(resp => {
console.log(resp)
})
License
MIT © Ben