@toreda/strong-types/dist/strong/data.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 { Rules } from '../rules';
import { StrongTypeId } from './type/id';
import { Transforms } from '../transforms';
/**
 * @category Core
 */
export declare class StrongData<ValueT> {
    value: ValueT | null;
    readonly initial: ValueT | null;
    readonly fallbackDefault: ValueT;
    readonly transforms: Transforms<ValueT>;
    readonly rules: Rules<ValueT>;
    readonly typeId: StrongTypeId;
    readonly baseType: StrongTypeId;
    constructor(fallbackDefault: ValueT, value: ValueT | null, rules: Rules<ValueT>, typeId: StrongTypeId);
    /**
     * Check if value passes this instance's rule validation.
     * @param value
     * @returns
     */
    check(value?: ValueT | null): boolean;
    get(fallback: ValueT): ValueT;
    set(value?: ValueT | null): boolean;
    getNull(): ValueT | null;
    reset(): void;
    /**
     * Divide current `value` by `divisor`. Result is zero when
     * `divisor` or `value` are zero.
     * @param divisor
     * @returns
     */
    div(divisor: number): number | null;
    mul(value: number): number | null;
    /**
     *
     * @param exponent
     * @returns
     */
    pow(exponent: number): number | null;
    /**
     * Add value to Strong Type's current value, if it is a numeric type. Operation
     * ignored for non-numeric types.
     * @param value
     * @returns
     */
    add(value: number): number | null;
}