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 on web browsers or with Node.js.

Quick Start

The library is available on the global CDN jsDelivr:

<script src="https://cdn.jsdelivr.net/npm/addsearch-js-client@0.1/dist/addsearch-js-client.min.js"></script>

To install the library locally or to use it with Node.js:

npm install addsearch-js-client --save

# After installation, add the library to your JS code
# var AddSearchClient = require('addsearch-js-client');

Execute the first search query

// 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);

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);

Fetch search suggestions

// Configure Search suggestions on AddSearch Dashboard first
// Get suggestions starting with a specific prefix
client.suggestions('a', 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');

Define category filters

Filter by URL patterns, document types or addsearch-category meta tag values. See the full documentation.

// Only PDF files or products
client.setCategoryFilters('doctype_pdf,products');

Custom field filters

Filter by custom fields. Custon fields can be defined in meta tags or AddSearch crawler can pick them up from your HTML or JSON data. See the full documentation.

// Search by specific city (Berlin, Paris or Boston)
client.addCustomFieldFilter('city','berlin');
client.addCustomFieldFilter('city','paris');
client.addCustomFieldFilter('city','boston');

// Remove Paris (Berlin and Boston remaining)
client.removeCustomFieldFilter('city','paris');

// Remove all cities
client.removeCustomFieldFilter('city');

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();

Supported web browsers and node.js versions

The client is tested on

• Chrome
• Firefox
• Edge
• Safari 6.1+
• Internet Explorer 10+
• Node.js 4+

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

npm run build

Built bundle is saved under the dist/ folder

Support

Feel free to send any questions, ideas and suggestions at [e-mail].