Identify the JavaScript Search Framework version

Coveo Relevance Cloud Developer JavaScript Search Framework Product Documentation

Before using a new Coveo JavaScript Search Framework component or feature in a search interface, you should typically ensure that the JavaScript Search Framework version on which that search interface relies supports that new component or feature.

This article provides two methods of identifying the JavaScript Search Framework version used in a Coveo-powered product.

Method 1: From a search interface

  1. Access the search interface using your preferred web browser (e.g., Chrome).

  2. Open your web browser developer tools console (e.g., in Chrome, press Control+Shift+J [Windows/Linux], or CMD+Option+J [Mac]).

  3. Select the Console tab.

  4. In the console prompt, type Coveo.version, then press Enter.

    This returns an object similar to:

    {
  "lib": "2.4710.8",
  "product": "2.4710.8",
  "supportedApiVersion: 2
}

    In the lib and product values above, 2 is the major version, 4710 is the minor version, and 8 is the hotfix version.

  5. Optionally, find the release notes corresponding to the retrieved product value (see JavaScript Search Release Notes).

Method 2: From the distribution files

For an administrator or a developer, when you have access to the CoveoJsSearch.zip distribution file or to the folder containing the Coveo JavaScript Search Framework:

  1. Using a text editor, open the \[JsSearch\_Installation\_Path\]/js/CoveoSearch.js file.

  2. Toward the beginning of the file, locate the Coveo.version function, and note the product value.

    // ...
(function (Coveo) {
  Coveo.version = {
    "lib" : "1.0.3.23",
    "product": "1.0.20.0",
    "supportedApiVersion": 2
  };
// ...