https://github.com/itemsapi/itemsapi-js
Javascript client for ItemsAPI 2.0
https://github.com/itemsapi/itemsapi-js
Last synced: 19 days ago
JSON representation
Javascript client for ItemsAPI 2.0
- Host: GitHub
- URL: https://github.com/itemsapi/itemsapi-js
- Owner: itemsapi
- License: mit
- Created: 2020-05-28T16:39:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T20:29:58.000Z (over 2 years ago)
- Last Synced: 2025-05-08T21:59:47.084Z (19 days ago)
- Language: JavaScript
- Size: 118 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ItemsAPI Javascript
Javascript client for ItemsAPI 2.0
## Installation
```sh
npm install itemsapi
```
### Run ItemsAPI
There are many easy ways to run ItemsAPI 2.0 server.
The simplest one is by using Docker:
```bash
docker run --privileged -it -p 3000:3000 itemsapi/itemsapi:latest
```
## Getting started
Here is a quickstart for a search request
```js
const ItemsAPI = require('itemsapi')
(async () => {
const client = new ItemsAPI({
host: 'http://127.0.0.1:3000',
// if needed
api_key: 'keykey135'
})
const index = client.getIndex(name);
let response = await index.updateConfig(config);
response = await index.addItems(items);
response = await index.search({
per_page: 3,
filters: {
tags: ['epic']
},
facets_fields: ['tags']
});
console.log(response);
})();
```
## API Resources
### Search
- Make a search request:
`await index.search(input)`
- List filters for specific facet:
`await index.facet(input)`
### Index
- Get index object:
`client.getIndex(name)`
### Items
- Add items:
`await index.addItems(items)`
- Get item:
`await index.getItem(id)`
- Update item partially:
`await index.partialUpdateItem(id, data)`
- Update item:
`await index.updateItem(id, data)`
- Delete item:
`await index.deleteItem(id)`
### Configuration
- Get configuration:
`await index.getConfig()`
- Update configuration:
`await index.updateConfig(config)`