addsearch-js-client

AddSearch Search API Client for JavaScript

AddSearch is a hosted search platform for all your web content. This API Client lets you easily use the AddSearch Search API from your JavaScript code. This client works on web browsers and with Node.js.

Quick Start

// Create client with your 32-character SITEKEY
var client = new AddSearchClient('YOUR PUBLIC SITEKEY');

// Callback function
var cb = function(res) {
  // Print results to console
  console.log(res);
}

// Execute search. Callback function cb will be called with search results
client.search('keyword', cb);

// Get search suggestions for a keyword
client.suggest('api', cb);

Publicly accessible functions

The client provides the following functions.

Fetch search results

// Search with a specific keyword
client.search('keyword', callback);

// Search with the previously used keyword or execute a "match all" query
client.search(callback);

Use fuzzy matching

// Enable/disable fuzzy matching used in typo tolerance (default "true")
client.useFuzzyMatch(false);

Define language filter

// Documents in specific language (e.g. "en" or "de")
client.setLanguage('en');

Define publishing date filters

// Documents published between specific date range
client.setDateFilter('2019-01-01', '2019-01-31');

Manage paging

// Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
client.setPaging(page, pageSize, sortBy, sortOrder);

// Next {pageSize} results
client.nextPage();

// Previous {pageSize} results
client.previousPage();

Browser support

The client is tested on following browsers

• Chrome
• Firefox
• Edge
• Safari 6.1+
• Internet Explorer 10+

Development

To modify this client library, clone this repository to your computer and execute following commands.

Install dependencies

npm install

Run tests

npm test

Build

To build the client, run:

npm run build

Built bundle is saved under the dist/ folder