@atlassian/aui/lib/js/aui/truncating-progressive-data-set.js

Atlassian User Interface Framework

(function (global, factory) {
    if (typeof define === "function" && define.amd) {
        define(['module', 'exports', './internal/globalize', './progressive-data-set'], factory);
    } else if (typeof exports !== "undefined") {
        factory(module, exports, require('./internal/globalize'), require('./progressive-data-set'));
    } else {
        var mod = {
            exports: {}
        };
        factory(mod, mod.exports, global.globalize, global.progressiveDataSet);
        global.truncatingProgressiveDataSet = mod.exports;
    }
})(this, function (module, exports, _globalize, _progressiveDataSet) {
    'use strict';

    Object.defineProperty(exports, "__esModule", {
        value: true
    });

    var _globalize2 = _interopRequireDefault(_globalize);

    var _progressiveDataSet2 = _interopRequireDefault(_progressiveDataSet);

    function _interopRequireDefault(obj) {
        return obj && obj.__esModule ? obj : {
            default: obj
        };
    }

    var TruncatingProgressiveDataSet = _progressiveDataSet2.default.extend({
        /**
         * This is a subclass of ProgressiveDataSet. It differs from the superclass
         * in that it works on large data sets where the server truncates results.
         *
         * Rather than determining whether to request more information based on its cache,
         * it uses the size of the response.
         *
         * @example
         * var source = new TruncatingProgressiveDataSet([], {
         *     model: Backbone.Model.extend({ idAttribute: "username" }),
         *     queryEndpoint: "/jira/rest/latest/users",
         *     queryParamKey: "username",
         *     matcher: function(model, query) {
         *         return _.startsWith(model.get('username'), query);
         *     },
         *     maxResponseSize: 20
         * });
         * source.on('respond', doStuffWithMatchingResults);
         * source.query('john');
         */
        initialize: function initialize(models, options) {
            this._maxResponseSize = options.maxResponseSize;
            _progressiveDataSet2.default.prototype.initialize.call(this, models, options);
        },

        shouldGetMoreResults: function shouldGetMoreResults(results) {
            var response = this.findQueryResponse(this.value);
            return !response || response.length === this._maxResponseSize;
        },

        /**
         * Returns the response for the given query.
         *
         * The default implementation assumes that the endpoint's search algorithm is a prefix
         * matcher.
         *
         * @param query the value to find existing responses
         * @return {Object[]} an array of values representing the IDs of the models provided by the response for the given query.
         * Null is returned if no response is found.
         */
        findQueryResponse: function findQueryResponse(query) {
            while (query) {
                var response = this.findQueryCache(query);

                if (response) {
                    return response;
                }

                query = query.substr(0, query.length - 1);
            }

            return null;
        }
    });

    (0, _globalize2.default)('TruncatingProgressiveDataSet', TruncatingProgressiveDataSet);

    exports.default = TruncatingProgressiveDataSet;
    module.exports = exports['default'];
});
//# sourceMappingURL=truncating-progressive-data-set.js.map