elastic-builder/src/queries/span-queries/span-first-query.js

A JavaScript implementation of the elasticsearch Query DSL

'use strict';

const isNil = require('lodash.isnil');

const {
    util: { checkType }
} = require('../../core');

const SpanQueryBase = require('./span-query-base');

/**
 * Matches spans near the beginning of a field. The span first query maps to Lucene `SpanFirstQuery`.
 *
 * [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html)
 *
 * @example
 * const spanQry = esb.spanFirstQuery()
 *     .match(esb.spanTermQuery('user', 'kimchy'))
 *     .end(3);
 *
 * @param {SpanQueryBase=} spanQry Any other span type query
 *
 * @extends SpanQueryBase
 */
class SpanFirstQuery extends SpanQueryBase {
    // eslint-disable-next-line require-jsdoc
    constructor(spanQry) {
        super('span_first');

        if (!isNil(spanQry)) this.match(spanQry);
    }

    /**
     * Sets the `match` clause which can be any other span type query.
     *
     * @param {SpanQueryBase} spanQry
     * @returns {SpanFirstQuery} returns `this` so that calls can be chained.
     */
    match(spanQry) {
        checkType(spanQry, SpanQueryBase);

        this._queryOpts.match = spanQry;
        return this;
    }

    /**
     * Sets the maximum end position permitted in a match.
     *
     * @param {number} limit The maximum end position permitted in a match.
     * @returns {SpanFirstQuery} returns `this` so that calls can be chained.
     */
    end(limit) {
        this._queryOpts.end = limit;
        return this;
    }
}

module.exports = SpanFirstQuery;