swiftype-enterprise-nodedeprecated

A first-party Node.js client for Elastic Enterprise Search.

Contents

• Getting started
• Usage
• FAQ
• Contribute
• License

---

Getting started 🐣

With npm:

npm install swiftype-enterprise-node

or clone locally:

$ git clone git@github.com:swiftype/swiftype-enterprise-node.git
$ cd swiftype-enterprise-node
$ npm install

Usage

Create a new instance of the Swiftype Enterprise Client with your access token:

const SwiftypeEnterpriseClient = require('swiftype-enterprise-node')
const accessToken = '' // your access token
const swiftype = new SwiftypeEnterpriseClient(accessToken)

Change API endpoint

const swiftype = new SwiftypeEnterpriseClient(accessToken, 'https://your-server.example.com/api/v1/ent')

Indexing Documents

This example shows how to use the indexDocuments method:

const contentSourceKey = '' // your content source key
const documents = [
  {
    id: 1234,
    title: "5 Tips On Finding A Mentor",
    body: "The difference between a budding entrepreneur who merely shows promise and one who is already enjoying some success often comes down to mentoring.",
    url: "https://www.shopify.com/content/5-tips-on-finding-a-mentor"
  },
  {
    id: 1235,
    title: "How to Profit from Your Passions",
    body: "Want to know the secret to starting a successful business? Find a void and fill it.",
    url: "https://www.shopify.com/content/how-to-profit-from-your-passions"
  }
]

swiftype.indexDocuments(contentSourceKey, documents)
.then((results) => {
  // handle results
})
.catch((error) => {
  // handle error
})

Destroying Documents

const contentSourceKey = '' // your content source key
const documentIds = [1234, 1235]

swiftype.destroyDocuments(contentSourceKey, documentIds)
.then((destroyDocumentsResults) => {
  // handle destroy documents results
})
.catch((error) => {
  // handle error
})

Running tests

Run tests via npm:

$ npm test

FAQ 🔮

Where do I report issues with the client?

If something is not working as expected, please open an issue.

Contribute 🚀

We welcome contributors to the project. Before you begin, a couple notes...

• Before opening a pull request, please create an issue to discuss the scope of your proposal.
• Please write simple code and concise documentation, when appropriate.

License 📗

MIT © Elastic

Thank you to all the contributors!