![\"Alapnian](\"banner.png\")
\r\n \r\n \r\n
![\"🚀\"](\"https://fonts.gstatic.com/s/e/notoemoji/latest/1f680/512.webp\")
\r\n\r\n\r\n Alapnian Sass Throw Module is provides Sass functions to standardize exception messages. In this module, there are 4 mixins and 2 functions that are ready for you to use, namely:\r\n
variable(), variable-type(), parameter(), parameter-type()\r\n parameter(), parameter-type()\r\n
>=1.23.0\r\n ![\"NPM](\"https://img.shields.io/npm/v/%40alapnian-sass%2Fthrow?logo=npm&logoColor=CB3837&label=version&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40alapnian-sass%2Fthrow%3FactiveTab%3Dversions\")
![\"NPM](\"https://img.shields.io/npm/dm/%40alapnian-sass%2Fthrow?logo=npm&logoColor=CB3837&label=downloads\")
npm i @alapnian-sass/throwAfter the package has been installed, it might already be available for use just like any other Sass module.
\r\n\r\n```scss\r\n@use '@alapnian-sass/throw';\r\n```\r\n\r\nHowever, if Sass can't find the module, your compiler will need to be configured to include the node_modules folder. That should look something like this:
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$strict-mode | \r\n Boolean | \r\ntrue | \r\n Toggle strict mode, in which script will throw when not able to cast a value into a certain type (mostly color and number). In non-strict mode, it will return the default value from the given type. | \r\n
\r\n\r\n \r\nCustomize settings via
\r\n\r\n```scss\r\n@forward \"@alapnian-sass/throw\" with (\r\n $strict-mode: false\r\n);\r\n```\r\n@forward rule\r\n \r\nCustomize settings via
\r\n\r\n```scss\r\n@use \"@alapnian-sass/throw\" with (\r\n $strict-mode: false\r\n);\r\n```\r\n@use rule
![\"🔥\"](\"https://fonts.gstatic.com/s/e/notoemoji/latest/1f525/512.webp\")
\r\n\r\nAn error message stating an issue with one or more variables.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the mixin will output errors as comments without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$message | \r\n String | \r\n\r\n | The message which describes the issue. | \r\n
$names | \r\n ArgList | \r\n\r\n | The names of the variables for which there is an issue. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and output them as CSS comments without stopping compilation. | \r\n
\r\n Output:
\r\n A string describing the reason one or more variables are misconfigured.\r\n
\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Define vars\r\n$width: 1080px !default;\r\n\r\n// Validate\r\n@if ($width < 0) {\r\n @include throw.variable(\"Value must not be less than zero, but is `#{$width}`\", \"width\");\r\n}\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Define vars\r\n$width: 1080px !default;\r\n\r\n// Validate\r\n@if ($width < 0) {\r\n @include throw.variable(\"Value must not be less than zero, but is `#{$width}`\", \"width\", $strict-mode: false);\r\n}\r\n```\r\n\r\n$strict-mode when u load @use rule with with
An error message stating a variable received the wrong type.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the mixin will output errors as comments without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$name | \r\n String | \r\n\r\n | The name of the variable which has received the wrong type. | \r\n
$value | \r\n * | \r\n\r\n | The value which was received. | \r\n
$types | \r\n ArgList | \r\n\r\n | The types which are expected. | \r\n
$message | \r\n String | \r\nnull | \r\n The additional message which describes the issue. Must be passed by name. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and output them as CSS comments without stopping compilation. | \r\n
\r\n Output:
\r\n A string describing what types are acceptable for a variable and the value that is misconfigured.\r\n
\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"@alapnian-sass/meta\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Define vars\r\n$width: 1080px !default;\r\n\r\n// Validate\r\n@if (meta.type-of($width) != \"number\") {\r\n @include throw.variable(\"width\", $width, \"number\");\r\n}\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Define vars\r\n$width: 1080px !default;\r\n\r\n// Validate\r\n@if (meta.type-of($width) != \"number\") {\r\n @include throw.variable(\"width\", $width, \"number\", $strict-mode: false, $message: \"Please use the number value type.\");\r\n}\r\n```\r\n\r\n$strict-mode when u load @use rule with with
An error message stating an issue with one or more parameters.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the mixin will output errors as comments without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$message | \r\n String | \r\n\r\n | The message which describes the issue. | \r\n
$context | \r\n String | \r\n\r\n | The name of the mixin issuing the error. | \r\n
$names | \r\n ArgList | \r\n\r\n | The names of the parameters for which there is an issue. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and output them as CSS comments without stopping compilation. | \r\n
\r\n Output:
\r\n A string describing the reason one or more parameters are invalid.\r\n
\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Reflexive Position Mixin\r\n@mixin reflexive-position($property, $value) {\r\n @if $property != left and $property != right {\r\n @include throw.parameter(\"Property #{$property} must be either left or right.\", \"property\")\r\n } @else {\r\n @if (meta.type-of($value) != \"number\") {\r\n @include throw.parameter-type(\"reflexive-position\", \"value\", $value);\r\n } @else {\r\n $left-value: $value;\r\n @if ($property == right) {\r\n $left-value: initial;\r\n }\r\n \r\n $right-value: initial;\r\n @if ($property == right) {\r\n $right-value: $value;\r\n }\r\n\r\n left: $left-value;\r\n right: $right-value;\r\n\r\n [dir=rtl] & {\r\n left: $right-value;\r\n right: $left-value;\r\n }\r\n }\r\n }\r\n}\r\n\r\n.valid-property {\r\n @include reflexive-position(\"left\", 12px);\r\n}\r\n\r\n.invalid-property {\r\n @include reflexive-position(\"top\", 12px);\r\n}\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Reflexive Position Mixin\r\n@mixin reflexive-position($property, $value) {\r\n @if $property != left and $property != right {\r\n @include throw.parameter(\"Property #{$property} must be either left or right.\", \"property\", $strict-mode: false)\r\n } @else {\r\n @if (meta.type-of($value) != \"number\") {\r\n @include throw.parameter-type(\"reflexive-position\", \"value\", $value);\r\n } @else {\r\n $left-value: $value;\r\n @if ($property == right) {\r\n $left-value: initial;\r\n }\r\n \r\n $right-value: initial;\r\n @if ($property == right) {\r\n $right-value: $value;\r\n }\r\n\r\n left: $left-value;\r\n right: $right-value;\r\n\r\n [dir=rtl] & {\r\n left: $right-value;\r\n right: $left-value;\r\n }\r\n }\r\n }\r\n}\r\n\r\n.valid-property {\r\n @include reflexive-position(\"left\", 12px);\r\n}\r\n\r\n.invalid-property {\r\n @include reflexive-position(\"top\", 12px);\r\n}\r\n```\r\n\r\n$strict-mode when u load @use rule with with
An error message stating a parameter received the wrong type.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the mixin will output errors as comments without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$context | \r\n String | \r\n\r\n | The name of the mixin issuing the error. | \r\n
$name | \r\n String | \r\n\r\n | The name of the parameter which has received the wrong type. | \r\n
$value | \r\n * | \r\n\r\n | The value which was received. | \r\n
$types | \r\n ArgList | \r\n\r\n | The types which are expected. | \r\n
$message | \r\n String | \r\nnull | \r\n The additional message which describes the issue. Must be passed by name. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and output them as CSS comments without stopping compilation. | \r\n
\r\n Output:
\r\n A string describing what types are acceptable for a parameter and the value that is invalid.\r\n
\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Reflexive Position Mixin\r\n@mixin reflexive-position($property, $value) {\r\n @if $property != left and $property != right {\r\n @include throw.parameter(\"Property #{$property} must be either left or right.\", \"property\")\r\n } @else {\r\n @if (meta.type-of($value) != \"number\") {\r\n @include throw.parameter-type(\"reflexive-position\", \"value\", $value);\r\n } @else {\r\n $left-value: $value;\r\n @if ($property == right) {\r\n $left-value: initial;\r\n }\r\n \r\n $right-value: initial;\r\n @if ($property == right) {\r\n $right-value: $value;\r\n }\r\n\r\n left: $left-value;\r\n right: $right-value;\r\n\r\n [dir=rtl] & {\r\n left: $right-value;\r\n right: $left-value;\r\n }\r\n }\r\n }\r\n}\r\n\r\n.valid-value {\r\n @include reflexive-position(\"left\", 12px);\r\n}\r\n\r\n.invalid-value {\r\n @include reflexive-position(\"left\", \"12px\");\r\n}\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n// Reflexive Position Mixin\r\n@mixin reflexive-position($property, $value) {\r\n @if $property != left and $property != right {\r\n @include throw.parameter(\"Property #{$property} must be either left or right.\", \"property\")\r\n } @else {\r\n @if (meta.type-of($value) != \"number\") {\r\n @include throw.parameter-type(\"reflexive-position\", \"value\", $value, $strict-mode: false, $message: \"Please use the number value type.\");\r\n } @else {\r\n $left-value: $value;\r\n @if ($property == right) {\r\n $left-value: initial;\r\n }\r\n \r\n $right-value: initial;\r\n @if ($property == right) {\r\n $right-value: $value;\r\n }\r\n\r\n left: $left-value;\r\n right: $right-value;\r\n\r\n [dir=rtl] & {\r\n left: $right-value;\r\n right: $left-value;\r\n }\r\n }\r\n }\r\n}\r\n\r\n.valid-value {\r\n @include reflexive-position(\"left\", 12px);\r\n}\r\n\r\n.invalid-value {\r\n @include reflexive-position(\"left\", \"12px\");\r\n}\r\n```\r\n\r\n$strict-mode when u load @use rule with with
Returns an error message stating an issue with one or more variables.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the function will return errors without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$message | \r\n String | \r\n\r\n | The message which describes the issue. | \r\n
$context | \r\n String | \r\n\r\n | The name of the function issuing the error. | \r\n
$names | \r\n ArgList | \r\n\r\n | The names of the variables for which there is an issue. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and return them as values without stopping compilation. | \r\n
$default-value | \r\n any | \r\n\r\n | Default return value when running in non-strict mode. | \r\n
\r\n Return Value:
\r\n
String | any\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:map\";\r\n@use \"sass:list\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n@function from($pairs...) {\r\n @if (list.length($pairs) < 1) {\r\n @return throw.parameter(\"One or more key/value pairs are required\", \"from\", \"pairs\");\r\n }\r\n\r\n $result: ();\r\n\r\n @each $key, $value in $pairs {\r\n $result: map.set($result, $key, $value);\r\n }\r\n\r\n @return $result;\r\n}\r\n\r\n// Valid\r\n@debug from(01234567890);\r\n@debug from(rgba(19, 7, 24, 1));\r\n@debug from([24px 7px, 19px]);\r\n@debug from((regular: 400, medium: 500, bold: 700));\r\n\r\n// Invalid\r\n@debug from();\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:map\";\r\n@use \"sass:list\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n@function from($pairs...) {\r\n @if (list.length($pairs) < 1) {\r\n @return throw.parameter(\"One or more key/value pairs are required\", \"from\", \"pairs\", $strict-mode: false, $default-value: null);\r\n }\r\n\r\n $result: ();\r\n\r\n @each $key, $value in $pairs {\r\n $result: map.set($result, $key, $value);\r\n }\r\n\r\n @return $result;\r\n}\r\n\r\n// Valid\r\n@debug from(01234567890);\r\n@debug from(rgba(19, 7, 24, 1));\r\n@debug from([24px 7px, 19px]);\r\n@debug from((regular: 400, medium: 500, bold: 700));\r\n\r\n// Invalid\r\n@debug from(); //=> null\r\n```\r\n\r\n$strict-mode when u load @use rule with with
Returns an error message stating a parameter received the wrong type.
\r\nWhen the $strict-mode parameter (or global $strict-mode setting) is set, the function will return errors without stopping compilation.
\r\n Parameters:\r\n
\r\n\r\n
| Name | \r\nType | \r\nDefault | \r\nDescription | \r\n
|---|---|---|---|
$context | \r\n String | \r\n\r\n | The name of the function issuing the error. | \r\n
$name | \r\n String | \r\n\r\n | The name of the parameter which has received the wrong type. | \r\n
$value | \r\n * | \r\n\r\n | The value which was received. | \r\n
$types | \r\n ArgList | \r\n\r\n | The types which are expected. | \r\n
$strict-mode | \r\n Boolean | \r\n%derived% | \r\n Optionally catch errors and return them as values without stopping compilation. | \r\n
$message | \r\n String | \r\nnull | \r\n The additional message which describes the issue. Must be passed by name. | \r\n
$default-value | \r\n any | \r\n\r\n | Default return value when running in non-strict mode. | \r\n
\r\n Return Value:
\r\n
String | any\r\n Example:\r\n Or, you can set \r\n \r\n Basic
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"sass:math\";\r\n@use \"sass:color\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n@function is-dark($color) {\r\n @if (meta.type-of($color) != \"color\") {\r\n @return throw.parameter-type(\"is-dark\", \"color\", $color, \"color\");\r\n }\r\n\r\n @return math.div(color.red($color) * 299 + color.green($color) * 587 + color.blue($color) * 114, 1000) < 128;\r\n}\r\n\r\n// Valid\r\n@debug is-dark(#000); //=> true\r\n@debug is-dark(#FFF); //=> false\r\n\r\n// Invalid\r\n@debug is-dark(\"#000\");\r\n@debug is-dark(\"rgb(0,0,0)\");\r\n```\r\n\r\n \r\nAdvanced
\r\n\r\n```scss\r\n// Load modules\r\n@use \"sass:meta\";\r\n@use \"sass:math\";\r\n@use \"sass:color\";\r\n@use \"@alapnian-sass/throw\";\r\n\r\n@function is-dark($color) {\r\n @if (meta.type-of($color) != \"color\") {\r\n @return throw.parameter-type(\"is-dark\", \"color\", $color, \"color\", $strict-mode: false, $message: \"Please use color value types such as `rgb()`, `hsl()`, or other color models.\", $default-value: false);\r\n }\r\n\r\n @return math.div(color.red($color) * 299 + color.green($color) * 587 + color.blue($color) * 114, 1000) < 128;\r\n}\r\n\r\n// Valid\r\n@debug is-dark(#000); //=> true\r\n@debug is-dark(#FFF); //=> false\r\n\r\n// Invalid\r\n@debug is-dark(\"#000\"); //=> false\r\n@debug is-dark(\"rgb(0,0,0)\"); //=> false\r\n```\r\n\r\n$strict-mode when u load @use rule with with