KC's Workspace
    Preparing search index...

    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 (View Summary)

    Implements

    Index
    • get asList(): List<Value>

      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 List<Value>

      An immutable List from the immutable package.

    • 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

    • get isTruthy(): boolean

      Whether the value counts as true in an @if statement and other contexts.

      Returns boolean

    • get realNull(): Value | null

      Returns JavaScript's null value if this is sassNull, and returns this otherwise.

      Returns Value | null

    • get separator(): ListSeparator

      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

    • Throws if this isn't a SassBoolean.

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

      Parameters

      • Optionalname: string

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

      Returns SassBoolean

    • Throws if this isn't a SassCalculation.

      Parameters

      • Optionalname: string

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

      Returns SassCalculation

    • Throws if this isn't a SassColor.

      Parameters

      • Optionalname: string

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

      Returns SassColor

    • Throws if this isn't a SassFunction.

      Parameters

      • Optionalname: string

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

      Returns SassFunction

    • Throws if this isn't a SassMap.

      Parameters

      • Optionalname: string

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

      Returns SassMap

    • Throws if this isn't a SassMixin.

      Parameters

      • Optionalname: string

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

      Returns SassMixin

    • Throws if this isn't a SassNumber.

      Parameters

      • Optionalname: string

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

      Returns SassNumber

    • Throws if this isn't a SassString.

      Parameters

      • Optionalname: string

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

      Returns SassString

    • Returns whether this represents the same value as other.

      Parameters

      Returns boolean

    • 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 Value | undefined

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

      Returns 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.

      Parameters

      • sassIndex: Value

        The Sass-style index into this as a list.

      • Optionalname: string

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

      Returns number

      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.

    • Returns this as a map if it counts as one (empty lists count as empty maps) or null if it doesn't.

      Returns SassMap | null