Docs4dev
Docs
sass / latest / js-api / classes / value.html

Class Value

The abstract base class of Sass's value types.

This is passed to and returned by CustomFunctions, which are passed into the Sass implementation using Options.functions.

Hierarchy

Implements

  • ValueObject

Index

Accessors

Methods

Accessors

asList

  • get asList(): List<Value>

hasBrackets

  • get hasBrackets(): boolean

  • Whether this value as a list has brackets.

    All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

    Returns boolean

isTruthy

  • get isTruthy(): boolean

realNull

  • get realNull(): null | Value

separator

  • The separator for this value as a list.

    All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

    Returns ListSeparator

Methods

assertBoolean

  • Throws if this isn't a SassBoolean.

    ⚠️ Heads up!

    Functions should generally use isTruthy rather than requiring a literal boolean.

    Parameters

    • Optional name: string

      The name of the function argument this came from (without the $) if it came from an argument. Used for error reporting.

    Returns SassBoolean

assertColor

  • Throws if this isn't a SassColor.

    Parameters

    • Optional name: string

      The name of the function argument this came from (without the $) if it came from an argument. Used for error reporting.

    Returns SassColor

assertFunction

assertMap

  • assertMap(name?: string): SassMap

  • Throws if this isn't a SassMap.

    Parameters

    • Optional name: string

      The name of the function argument this came from (without the $) if it came from an argument. Used for error reporting.

    Returns SassMap

assertNumber

assertString

equals

  • equals(other: Value): boolean

get

  • get(index: number): undefined | Value

  • Returns the value at index index in this value as a list, or undefined if index isn't valid for this list.

    All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

    This is a shorthand for this.asList.get(index), although it may be more efficient in some cases.

    ⚠️ Heads up!

    This method uses the same indexing conventions as the immutable package: unlike Sass the index of the first element is 0, but like Sass negative numbers index from the end of the list.

    Parameters

    • index: number

    Returns undefined | Value

hashCode

  • hashCode(): number

  • Returns a hash code that can be used to store this in a hash map.

    Returns number

sassIndexToListIndex

  • sassIndexToListIndex(sassIndex: Value, name?: string): number

  • Converts sassIndex into a JavaScript-style index into the list returned by asList.

    Sass indexes are one-based, while JavaScript indexes are zero-based. Sass indexes may also be negative in order to index from the end of the list.

    throws

    Error If sassIndex isn't a number, if that number isn't an integer, or if that integer isn't a valid index for asList.

    Parameters

    • sassIndex: Value

      The Sass-style index into this as a list.

    • Optional name: string

      The name of the function argument sassIndex came from (without the $) if it came from an argument. Used for error reporting.

    Returns number

tryMap

© 2006–2022 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/Value