Text.DocL.Javascript

Rationale

This is basically a JSON encoding library, however it goes beyond JSON by allowing raw javascript to be used as a value. This allows, for instance, function calls and anonymous functions to be placed in the data when used in a javascript context. This is needed to expose some options in C3.js, e.g. customizing tick formatting.

The Obj type

data Obj

Represents a javascript object or scalar value.

Instances

Show Obj

show x returns x encoded.

IsString Obj

ToObj Obj

ToObj is the identity for an Obj value.

class ToObj a where

Class of types that can be converted to an Obj.

Minimal complete definition

toObj

Methods

toObj :: a -> Obj

Converts to an Obj.

toObjList :: [a] -> Obj

Only for writing instances. This function serves the same role as showList

Instances

ToObj Bool

ToObj Char

A String becomes a javascript string literal.

ToObj Double

ToObj Int

ToObj Integer

ToObj ()

Becomes a javascript null object

ToObj Text

Becomes a javascript string literal.

ToObj Obj

ToObj is the identity for an Obj value.

ToObj Prop

A [Prop] becomes a javascript object.

ToObj a => ToObj [a]

Becomes a javascript array.

Constructing javascript types

data Prop

A key/value pair created with the /:-operator.

A list of type [Prop] can be converted to an object using toObj. If the list contains duplicate keys, then merge is used to combine the values.

>>> toObj ["legs" /: 4, "ears" /: "floppy"]
{"ears":"floppy","legs":4}

Instances

ToObj Prop

A [Prop] becomes a javascript object.

(/:) :: ToObj a => String -> a -> Prop

Constructs a Prop.

>>> toObj ["tail" /: True, "nose" /: "wet"]
{"nose":"wet","tail":true}

javascript :: String -> Obj

Raw unescaped javascript.

>>> toObj ["speak" /: javascript "function(){alert('Woof!');}"]
{"speak":function(){alert('Woof!');}}

Encoding

encode :: Obj -> Text

Encode an Obj to a lazy Text.

Miscellanea

merge :: Obj -> Obj -> Obj

merge x y returns y unless both x and y are javascript objects, in which case the properties of the two are merged using merge recursively for duplicate keys.