Language.PureScript.Docs.RenderedCode.Types

data ContainingModule

Constructors

• ThisModule
• OtherModule ModuleName

Instances

• Eq ContainingModule
• Ord ContainingModule
• Generic ContainingModule _
• Show ContainingModule

fromContainingModule :: ContainingModule -> Json

toContainingModule :: Json -> Either DecodeError ContainingModule

data Link

Constructors

• NoLink
• Link ContainingModule

Instances

• Eq Link
• Ord Link
• Generic Link _
• Show Link

fromLink :: Link -> Json

toLink :: Json -> Either DecodeError Link

data Namespace

Constructors

• ValueLevel
• TypeLevel

Instances

• Eq Namespace
• Ord Namespace
• Generic Namespace _
• Show Namespace

fromNamespace :: Namespace -> Json

toNamespace :: Json -> Either DecodeError Namespace

data RenderedCodeElement

Constructors

• Syntax String
• Keyword String
• Space
• Symbol Namespace String Link

  Any symbol which you might or might not want to link to, in any

• Role String

Instances

• Eq RenderedCodeElement
• Ord RenderedCodeElement
• Generic RenderedCodeElement _
• Show RenderedCodeElement

fromRenderedCodeElement :: RenderedCodeElement -> Json

toRenderedCodeElement :: Json -> Either DecodeError RenderedCodeElement

newtype RenderedCode

Constructors

• RenderedCode (Array RenderedCodeElement)

Instances

• Eq RenderedCode
• Ord RenderedCode
• Newtype RenderedCode _
• Generic RenderedCode _
• Show RenderedCode
• Semigroup RenderedCode
• Monoid RenderedCode

fromRenderedCode :: RenderedCode -> Json

toRenderedCode :: Json -> Either DecodeError RenderedCode

type FixityAlias = Qualified (Either (ProperName TypeName) (Either Ident (ProperName ConstructorName)))

fromFixityAlias :: FixityAlias -> Json

toFixityAlias :: Json -> Either DecodeError FixityAlias