diffusion
Version:
Diffusion JavaScript client
167 lines (166 loc) • 6.44 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Point = exports.Types = exports.Type = void 0;
var enumerize_1 = require("./../../util/enumerize");
var require_non_null_1 = require("./../../util/require-non-null");
/**
* A point type
*/
var Type = /** @class */ (function () {
/**
* Create a Point Type
*
* @param id the type id
* @param anchorOperator a string describing where the point is anchored
* @param spanOperator a string describing the span of the point
* @param unitsSuffix the unit suffix
*/
function Type(id, anchorOperator, spanOperator, unitsSuffix) {
this.id = id;
this.anchorOperator = anchorOperator;
this.spanOperator = spanOperator;
this.unitsSuffix = unitsSuffix;
}
return Type;
}());
exports.Type = Type;
/**
* Enum like object of point types
*/ // eslint-disable-next-line @typescript-eslint/naming-convention
exports.Types = {
ABSOLUTE_START: new Type(0, 'fromStart', 'toStart', ''),
ABSOLUTE_SEQUENCE: new Type(1, 'from', 'to', ''),
ABSOLUTE_TIME: new Type(2, 'from', 'to', ' ms'),
OFFSET_SEQUENCE: new Type(3, 'fromLast', 'untilLast', ''),
OFFSET_TIME: new Type(4, 'fromLast', 'untilLast', ' ms'),
NEXT_COUNT: new Type(5, null, 'next', ''),
NEXT_TIME: new Type(6, null, 'next', ' ms'),
PREVIOUS_COUNT: new Type(7, null, 'previous', ''),
PREVIOUS_TIME: new Type(8, null, 'previous', ' ms')
};
enumerize_1.enumerize(exports.Types);
/**
* A point in a time series, either specified by the event number or a time
*/
var Point = /** @class */ (function () {
/**
* Create a Point instance
*
* @param value the point value
* @param type the point type
*/
function Point(value, type) {
this.value = value;
this.type = type;
}
/**
* Create a new point that is anchored at an absolute position.
*
* @param sequence the date or number at which the point is anchored
* @return a new point
* @throws an {@link IllegalArgumentError} if the sequence is negative
* @throws a {@link NullValueError} if the sequence is null or undefined
*/
Point.at = function (sequence) {
if (sequence instanceof Date) {
return new Point(sequence.getTime(), exports.Types.ABSOLUTE_TIME);
}
return new Point(require_non_null_1.requireNonNegative(sequence, 'Sequence'), exports.Types.ABSOLUTE_SEQUENCE);
};
/**
* Get a start point
*
* @return a unique instance of the start point
*/
Point.atStart = function () {
/* tslint:disable-next-line:no-use-before-declare */
return START_POINT;
};
/**
* Create a point with a sequence offset. The point refers to a position
* `count` events before the end of the sequence
*
* @oaram count the sequence offset
* @return a new point
* @throws an {@link IllegalArgumentError} if the count is negative
* @throws a {@link NullValueError} if the count is null or undefined
*/
Point.offset = function (count) {
return new Point(require_non_null_1.requireNonNegative(count, 'Count'), exports.Types.OFFSET_SEQUENCE);
};
/**
* Create a point with a time offset. The point refers to a position
* `timespan` milliseconds before the end of the sequence.
*
* @oaram count the time offset in milliseconds
* @return a new point
* @throws an {@link IllegalArgumentError} if the timespan is negative
* @throws a {@link NullValueError} if the timespan is null or undefined
*/
Point.offsetMillis = function (timespan) {
return new Point(require_non_null_1.requireNonNegative(timespan, 'Timespan'), exports.Types.OFFSET_TIME);
};
/**
* Create a point following a previous point by a number of events
*
* @oaram count the number of events
* @return a new point
* @throws an {@link IllegalArgumentError} if the count is negative
* @throws a {@link NullValueError} if the count is null or undefined
*/
Point.next = function (count) {
return new Point(require_non_null_1.requireNonNegative(count, 'Count'), exports.Types.NEXT_COUNT);
};
/**
* Create a point following a previous point by a time span
*
* @oaram timespan the number of milliseconds
* @return a new point
* @throws an {@link IllegalArgumentError} if the timespan is negative
* @throws a {@link NullValueError} if the timespan is null or undefined
*/
Point.nextMillis = function (timespan) {
return new Point(require_non_null_1.requireNonNegative(timespan, 'Timespan'), exports.Types.NEXT_TIME);
};
/**
* Create a point preceding another point by a number of events
*
* @oaram count the number of events
* @return a new point
* @throws an {@link IllegalArgumentError} if the count is negative
* @throws a {@link NullValueError} if the count is null or undefined
*/
Point.previous = function (count) {
return new Point(require_non_null_1.requireNonNegative(count, 'Count'), exports.Types.PREVIOUS_COUNT);
};
/**
* Create a point preceding another point by a time span
*
* @oaram timespan the number of milliseconds
* @return a new point
* @throws an {@link IllegalArgumentError} if the timespan is negative
* @throws a {@link NullValueError} if the timespan is null or undefined
*/
Point.previousMillis = function (timespan) {
return new Point(require_non_null_1.requireNonNegative(timespan, 'Timespan'), exports.Types.PREVIOUS_TIME);
};
/**
* Check if the Point is equal to another object
*
* @param other the other object
* @return `true` if the other object is a Point and is equal
*/
Point.prototype.equals = function (other) {
if (other && other instanceof Point) {
return this.value === other.value &&
this.type === other.type;
}
return false;
};
return Point;
}());
exports.Point = Point;
/**
* A unique start point
*/
var START_POINT = new Point(0, exports.Types.ABSOLUTE_START);