# findify-sdk

> Findify search api client

Latest version **1.3.9** (published 2017-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install findify-sdk
pnpm add findify-sdk
yarn add findify-sdk
bun add findify-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.9 |
| Published | 2017-03-24 |
| First published | 2017-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | Findify |
| Maintainers | findify |

## Links

- npm: https://www.npmjs.com/package/findify-sdk
- npm.io page: https://npm.io/package/findify-sdk

## Dependencies (5)

- [qs](https://npm.io/package/qs.md) ^6.3.0
- [axios](https://npm.io/package/axios.md) ^0.15.3
- [jsonp](https://npm.io/package/jsonp.md) ^0.2.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.2
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6

## Recent versions

- 1.3.9 (latest) — 2017-03-24
- 1.3.8 — 2017-03-20
- 1.3.6 — 2017-02-07
- 1.3.4 — 2017-01-26
- 1.3.3 — 2017-01-18
- 1.3.2 — 2017-01-18
- 1.3.1 — 2017-01-18
- 1.3.0 — 2017-01-18

## README

# Getting started
## Installation
```
npm install findify-sdk --save
```
or
```
yarn add findify-sdk
```
Alternatively, you can use UMD builds, by requiring them to the page using `<script>` tag:
```
https://findify-assets-2bveeb6u8ag.netdna-ssl.com/js-sdk/findify-sdk.1.3.6.min.js
```
or using unminified version:
```
https://findify-assets-2bveeb6u8ag.netdna-ssl.com/js-sdk/findify-sdk.1.3.6.js
```

## Usage example
```javascript
var FindifySDK = require('findify-sdk');

// First, you need to initialize library:
var client = FindifySDK.init({
  key: 'your_api_key',
  // If you are using this library on a frontend, it will be convenient for you to provide user once on initialization.
  // You can get user object, using `findify-analytics` library, or by manually getting data from cookies:
  user: {
    uid: 'user_id',
    sid: 'session_id'
  }
});

// After library initialized, we can send requests to server with `client` instance. Let's perform autocomplete request:
client.autocomplete({
  q: 'Red jacket',
  // If you are using this library on server, you will need to deal with multiple users objects.
  // In this case, you need to provide `user` object on each request. If you provided `user` on init, it will be overrided:
  user: {
    uid: 'user_id',
    sid: 'session_id'
  }
}).then(function(response) {
  // `response` variable will contain all response data from server, which could be later provided to the view layer.
});
```

# Documentation
- [API Reference](https://findify.readme.io/reference#initialization)

# License
MIT

---
_Source: https://npm.io/package/findify-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._