General

functions

json-encode

@function json-encode($value) { ... }

Description

Delay the encoding of a literal to JSON to a type-specific method

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$value`	value to be stringified	`Any`	—none

Returns

String —

JSON encoded string

Throws

Unknown type for #{$value} (#{$type}).

Requires

[function] _json-encode--string
[function] _json-encode--number
[function] _json-encode--list
[function] _json-encode--map
[function] _json-encode--null
[function] _json-encode--color
[function] _json-encode--bool

Used by

[mixin] json-encode
[function] _json-encode--list
[function] _json-encode--map

Author

Hugo Giraudel

_proof-quote

@function _proof-quote($value) { ... }

Description

Proof quote a value

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$value`	value to be quoted	`Any`	—none

Returns

String —

quoted value

Requires

[function] to-string

Used by

[function] _json-encode--color
[function] _json-encode--map
[function] _json-encode--number
[function] _json-encode--string

Author

Hugo Giraudel

to-string

@function to-string($list, $glue) { ... }

Description

Joins all elements of $list with $glue

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$list`	list to cast	`List`	—none
`$glue`	('') - value to use as a join string	`String`	—none

Returns

String —

quoted value

Used by

[function] _proof-quote

Author

Hugo Giraudel

[private] _json-encode--bool

@function _json-encode--bool($bool) { ... }

Description

Encode a bool to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$bool`	bool to be encoded	`Bool`	—none

Returns

Bool —

encoded bool

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--color

@function _json-encode--color($color) { ... }

Description

Encode a color to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$color`	color to be encoded	`Color`	—none

Returns

String —

encoded color

Requires

[function] _proof-quote

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--list

@function _json-encode--list($list) { ... }

Description

Encode a list to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$list`	list to be encoded	`List`	—none

Returns

String —

encoded list

Requires

[function] json-encode

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--map

@function _json-encode--map($map) { ... }

Description

Encode a map to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	map to be encoded	`Map`	—none

Returns

String —

encoded map

Requires

[function] _proof-quote
[function] json-encode

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--null

@function _json-encode--null($null) { ... }

Description

Encode null to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$null`	`null`	`Null`	—none

Returns

String

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--number

@function _json-encode--number($number) { ... }

Description

Encode a number to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$number`	number to be encoded	`Number`	—none

Returns

String —

encoded number

Requires

[function] _proof-quote

Used by

[function] json-encode

Author

Hugo Giraudel

[private] _json-encode--string

@function _json-encode--string($string) { ... }

Description

Encode a string to JSON

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$string`	string to be encoded	`String`	—none

Returns

String —

encoded string

Requires

[function] _proof-quote

Used by

[function] json-encode

Author

Hugo Giraudel

mixins

json-encode

@mixin json-encode($value, $selector: '#modulesConfigJSON') { ... }

Description

JSON.stringify a value and pass it to the content property of a specified selector

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$value`	value to be stringified	`Any`	—none
`$selector`	DOM selector to hold config	`String`	`'#modulesConfigJSON'`

Requires

[function] json-encode

Author

Hugo Giraudel