With npm:
npm install swiftype
or clone locally:
$ git clone [email protected]:swiftype/swiftype-node.git
$ cd swiftype-node
$ npm install
Create a new instance of the client with your api key:
var SwiftypeApi = require('swiftype')
var swiftype = new SwiftypeApi({
apiKey: 'yourApiKey'
})
Search for cats on the engine my-engine with filters and facets:
swiftype.search({
engine: 'my-engine',
q: 'cats',
filters: {
page: {
'enumField': 'theFilter'
}
},
facets: {
page: ['enumField', 'anotherField']
}
}, function(err, res) {
console.log(res)
})
Autocomplete for cat on the engine my-engine with filters:
swiftype.suggest({
engine: 'my-engine',
q: 'cat',
filters: {
page: {
'enumField': 'theFilter'
}
}
}, function(err, res) {
console.log(res)
})
Create a new document:
swiftype.documents.create({
engine: 'my-engine',
documentType: 'books',
document: {
external_id: '1',
fields: [
{ name: 'title', value: 'The Great Gatsby', type: 'string' },
{ name: 'author', value: 'F. Scott Fitzgerald', type: 'string' },
{ name: 'genre', value: 'fiction', type: 'enum' }
]
}
}, function(err, res) {
console.log(res)
})
Fetch all of your engines:
swiftype.engines.list(function(err, res) {
console.log(res)
})
Fetch a single engine:
swiftype.engines.get({
engine: 'my-engine'
}, function(err, res) {
console.log(res)
})
Fetch all of the document types in the engine my-engine
swiftype.documentTypes.list({
engine: 'my-engine'
}, function(err, res) {
console.log(res)
})
Fetch the document type books in the engine my-engine
swiftype.documentTypes.get({
engine: 'my-engine',
documentType: 'books'
}, function(err, res) {
console.log(res)
})
Check out the tests for more examples!
$ npm test
The tests use stubbed HTTP interactions that are recorded with the node-replay module. By default, HTTP interactions are not allowed when running the tests.
The tests can also use environment variables so that you can create new replays against your own account. Don't forget to change the "authorization" header in the replay files to not give away your api key.
- SWIFTYPE_TEST_MY_ENGINE = the slug for your 'my-engine' in the tests
- SWIFTYPE_TEST_BOOKSTORE_ENGINE = the slug for your 'bookstore' in the tests
- SWIFTYPE_TEST_TEMPORARY_ENGINE = the slug for your 'temporary' in the tests
- SWIFTYPE_TEST_API_KEY = your api key in the tests
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent