@corbinu/couchbase/lib/searchfacet.js

The unofficial Couchbase Node.js Client Library.

'use strict';

/**
 * @private
 */
class SearchFacetBase {
  constructor(data) {
    if (!data) {
      data = {};
    }

    this._data = data;
  }

  toJSON() {
    return this._data;
  }
}

/**
 * @category Full Text Search
 */
class TermFacet extends SearchFacetBase {
  /**
   * @hideconstructor
   */
  constructor(field, size) {
    super({
      field: field,
      size: size,
    });
  }
}

/**
 * @category Full Text Search
 */
class NumericFacet extends SearchFacetBase {
  /**
   * @hideconstructor
   */
  constructor(field, size) {
    super({
      field: field,
      size: size,
      numeric_ranges: [],
    });
  }

  /**
   *
   * @param {string} name
   * @param {number} min
   * @param {number} max
   */
  addRange(name, min, max) {
    this._data.numeric_ranges.push({
      name: name,
      min: min,
      max: max,
    });
    return this;
  }
}

/**
 * @category Full Text Search
 */
class DateFacet extends SearchFacetBase {
  /**
   * @hideconstructor
   */
  constructor(field, size) {
    super({
      field: field,
      size: size,
      date_ranges: [],
    });
  }

  /**
   *
   * @param {string} name
   * @param {Date} start
   * @param {Date} end
   */
  addRange(name, start, end) {
    this._data.date_ranges.push({
      name: name,
      start: start,
      end: end,
    });
    return this;
  }
}

/**
 *
 * @category Full Text Search
 */
class SearchFacet {
  /**
   *
   * @param {string} field
   * @param {number} size
   */
  static term(field, size) {
    return new TermFacet(field, size);
  }

  /**
   *
   * @param {string} field
   * @param {number} size
   */
  static numeric(field, size) {
    return new NumericFacet(field, size);
  }

  /**
   *
   * @param {string} field
   * @param {number} size
   */
  static date(field, size) {
    return new DateFacet(field, size);
  }
}

module.exports = SearchFacet;