Interface StypAddSub<TUnit>

Readonly dim

Readonly priority

Abstract add

• add(addendum): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • addendum: StypNumeric<TUnit, StypZero<TUnit>>

  Returns StypNumeric<TUnit, StypZero<TUnit>>

• add(addendum, unit): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • addendum: number

  • unit: TUnit

  Returns StypNumeric<TUnit, StypZero<TUnit>>

by

• by(source): StypNumeric<TUnit, StypZero<TUnit>>

• Maps the given CSS property value to the value of this one's type. Defaults to this value if mapping is not possible.

  This method allows to use an structured value instance as CSS property mapping.

  Parameters

  • source: StypValue

    A raw property value that should be converted.

  Returns StypNumeric<TUnit, StypZero<TUnit>>

  Mapped property value.

Abstract div

• div(divisor): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • divisor: number

  Returns StypNumeric<TUnit, StypZero<TUnit>>

important

• important(): StypAddSub<TUnit>

• Creates !important variant of this value.

  Returns StypAddSub<TUnit>

  Either a new value equal to this one but having priority equal to Important, or this one if already the case.

Abstract is

• is(other): boolean

• Checks whether this value equals to CSS property value.

  Parameters

  • other: StypValue

    CSS property value to compare with.

  Returns boolean

Abstract mul

• mul(multiplier): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • multiplier: number

  Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract negate

• negate(): StypNumeric<TUnit, StypZero<TUnit>>

• Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract prioritize

• prioritize(priority): StypAddSub<TUnit>

• Creates structured CSS value with the given priority.

  Parameters

  • priority: number

    New priority.

  Returns StypAddSub<TUnit>

  Either a new value equal to this one but having the given priority, or this one if priority did not change.

Abstract sub

• sub(subtrahend): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • subtrahend: StypNumeric<TUnit, StypZero<TUnit>>

  Returns StypNumeric<TUnit, StypZero<TUnit>>

• sub(subtrahend, unit): StypNumeric<TUnit, StypZero<TUnit>>

• Parameters

  • subtrahend: number

  • unit: TUnit

  Returns StypNumeric<TUnit, StypZero<TUnit>>

Abstract toDim

• toDim<TDimUnit>(dim): undefined | StypNumeric<TDimUnit, StypZero<TDimUnit>>

• Tries to converts this numeric value to another dimension.

  Does not actually construct a value in another dimension, as long as dimension unit supported by both dimensions.

  Type Parameters

  • TDimUnit extends string

    A unit type allowed in target dimension.

  Parameters

  • dim: Kind<TDimUnit>

    Target dimension.

  Returns undefined | StypNumeric<TDimUnit, StypZero<TDimUnit>>

  Either a value in dimension compatible with dim, or undefined if this value's unit is not supported by dim.

Abstract toFormula

• toFormula(): string

• Returns a textual representation of this value to be used within CSS calc() function.

  Returns string

  CSS value text without !important or calc().

toString

• toString(): string

• Returns textual representation of this value.

  Textual representation never contains an !important suffix.

  Returns string

  A textual representation of this value to use as CSS property value.

usual

• usual(): StypAddSub<TUnit>

• Creates usual (not !important) variant of this value.

  Returns StypAddSub<TUnit>

  Either a new value equal to this one but having priority equal to Usual, or this one if already the case.