@toreda/strong-types/dist/range.d.ts

Better TypeScript code in fewer lines.

/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */
import type { Float } from './float';
import { StrongMap } from './map';
import { StrongTypeId } from './strong/type/id';
/**
 * General numeric range with min and max value.
 *
 * @category Maths
 */
export declare class Range extends StrongMap {
    readonly min: Float;
    readonly max: Float;
    readonly typeId: StrongTypeId;
    constructor(defaultMin: number | null, defaultMax: number | null);
    /**
     * Check if provided value exists between min and max range values (inclusive).
     * @param value
     * @returns
     */
    in(value: number, exclusive?: boolean): boolean;
    /**
     * Reset min and max to initial values.
     */
    reset(): void;
}