Module

Language.PureScript.Docs.Types

Package: purescript-language-purescript
Repository: JordanMartinez/purescript-language-purescript

#Type' Source

type Type' = Type Unit

#Constraint' Source

type Constraint' = Constraint Unit

#UploadedPackage Source

type UploadedPackage = Package NotYetKnown

#VerifiedPackage Source

type VerifiedPackage = Package GithubUser

#Package Source

newtype Package a

Constructors

Package { compilerVersion :: Version, github :: Tuple GithubUser GithubRepo, moduleMap :: Map ModuleName PackageName, modules :: Array DocModule, packageMeta :: PackageMeta, resolvedDependencies :: Array (Tuple PackageName Version), tagTime :: Maybe DateTime, uploader :: a, version :: Version, versionTag :: String }

Instances

(Eq a) => Eq (Package a)
(Ord a) => Ord (Package a)
Newtype (Package a) _
Generic (Package a) _
(Show a) => Show (Package a)

#fromPackage Source

fromPackage :: forall a. (a -> Json) -> Package a -> Json

#toUploadedPackage Source

toUploadedPackage :: Version -> Json -> Either DecodeError UploadedPackage

#toPackage Source

toPackage :: forall a. Version -> (Json -> Either DecodeError a) -> Json -> Either DecodeError (Package a)

#yyyy_mm_dd Source

yyyy_mm_dd :: Array FormatterCommand

#hh_mm Source

hh_mm :: Array FormatterCommand

#_ss Source

_ss :: Array FormatterCommand

#_sss Source

_sss :: Array FormatterCommand

#fromISO8601 Source

fromISO8601 :: DateTime -> Json

#toISO8601 Source

toISO8601 :: Json -> Either DecodeError DateTime

#NotYetKnown Source

data NotYetKnown

Constructors

NotYetKnown

Instances

#fromNotYetKnown Source

fromNotYetKnown :: NotYetKnown -> Json

#toNotYetKnown Source

toNotYetKnown :: Json -> Either DecodeError NotYetKnown

#ManifestError Source

data ManifestError

Constructors

Instances

#DocModule Source

newtype DocModule

Constructors

DocModule { comments :: Maybe String, declarations :: Array Declaration, name :: ModuleName, reExports :: Array (Tuple (InPackage ModuleName) (Array Declaration)) }

Instances

#fromDocModule Source

fromDocModule :: DocModule -> Json

#toDocModule Source

toDocModule :: Json -> Either DecodeError DocModule

#Declaration Source

newtype Declaration

Constructors

Declaration { children :: Array ChildDeclaration, comments :: Maybe String, info :: DeclarationInfo, kind :: Maybe KindInfo, sourceSpan :: Maybe SourceSpan, title :: String }

Instances

#fromDeclaration Source

fromDeclaration :: Declaration -> Json

#toDeclaration Source

toDeclaration :: Json -> Either DecodeError Declaration

#DeclarationInfo Source

data DeclarationInfo

Constructors

ValueDeclaration Type'
DataDeclaration DataDeclType (Array (Tuple String (Maybe Type'))) (Array Role)
ExternDataDeclaration Type' (Array Role)
TypeSynonymDeclaration (Array (Tuple String (Maybe Type'))) Type'
TypeClassDeclaration (Array (Tuple String (Maybe Type'))) (Array Constraint') (Array (Tuple (Array String) (Array String)))
AliasDeclaration Fixity FixityAlias

Instances

#fromDeclarationInfo Source

fromDeclarationInfo :: DeclarationInfo -> Json

#toDeclarationInfo Source

toDeclarationInfo :: Json -> Either DecodeError DeclarationInfo

#toTypeArguments Source

toTypeArguments :: Json -> Either DecodeError (Array (Tuple String (Maybe Type')))

#toAsConstrantUnit Source

toAsConstrantUnit :: Json -> Either DecodeError Constraint'

#KindInfo Source

newtype KindInfo

Constructors

KindInfo { keyword :: KindSignatureFor, kind :: Type' }

Instances

#fromKindInfo Source

fromKindInfo :: KindInfo -> Json

#toKindInfo Source

toKindInfo :: Json -> Either DecodeError KindInfo

#ChildDeclaration Source

newtype ChildDeclaration

Constructors

ChildDeclaration { comments :: Maybe String, info :: ChildDeclarationInfo, sourceSpan :: Maybe SourceSpan, title :: String }

Instances

#fromChildDeclaration Source

fromChildDeclaration :: ChildDeclaration -> Json

#toChildDeclaration Source

toChildDeclaration :: Json -> Either DecodeError ChildDeclaration

#ChildDeclarationInfo Source

data ChildDeclarationInfo

Constructors

ChildInstance (Array Constraint') Type'
ChildDataConstructor (Array Type')
ChildTypeClassMember Type'

Instances

#fromChildDeclarationInfo Source

fromChildDeclarationInfo :: ChildDeclarationInfo -> Json

#toChildDeclarationInfo Source

toChildDeclarationInfo :: Json -> Either DecodeError ChildDeclarationInfo

#GithubUser Source

newtype GithubUser

Constructors

GithubUser String

Instances

#fromGithubUser Source

fromGithubUser :: GithubUser -> Json

#toGithubUser Source

toGithubUser :: Json -> Either DecodeError GithubUser

#GithubRepo Source

newtype GithubRepo

Constructors

GithubRepo String

Instances

#fromGithubRepo Source

fromGithubRepo :: GithubRepo -> Json

#toGithubRepo Source

toGithubRepo :: Json -> Either DecodeError GithubRepo

#PackageError Source

data PackageError

Constructors

Instances

#InPackage Source

data InPackage a

Constructors

Local a
FromDep PackageName a

Instances

(Eq a) => Eq (InPackage a)
(Ord a) => Ord (InPackage a)
Generic (InPackage a) _
(Show a) => Show (InPackage a)
Functor InPackage

#fromInPackage Source

fromInPackage :: forall a. (a -> Json) -> InPackage a -> Json

#toInPackage Source

toInPackage :: forall a. (Json -> Either DecodeError a) -> Json -> Either DecodeError (InPackage a)

#LinksContext Source

newtype LinksContext

Constructors

LinksContext { github :: Tuple GithubUser GithubRepo, moduleMap :: Map ModuleName PackageName, packageName :: PackageName, resolvedDependencies :: Array (Tuple PackageName Version), version :: Version, versionTag :: String }

Instances

#DocLink Source

newtype DocLink

Constructors

DocLink { location :: LinkLocation, namespace :: Namespace, title :: String }

Instances

#LinkLocation Source

data LinkLocation

Constructors

Instances

#toFunDeps Source

toFunDeps :: Json -> Either DecodeError (Array (Tuple (Array String) (Array String)))

#fromVersion Source

fromVersion :: Version -> Json

#toVersion Source

toVersion :: Json -> Either DecodeError Version

Modules: Data.CodeUnit; Language.PureScript.AST.Declarations; Language.PureScript.AST.Operators; Language.PureScript.AST.SourcePos; Language.PureScript.Comments; Language.PureScript.Constants.Lib; Language.PureScript.Constants.Prim; Language.PureScript.Docs.RenderedCode.Types; Language.PureScript.Docs.Types; Language.PureScript.Environment; Language.PureScript.Label; Language.PureScript.Names; Language.PureScript.PSString; Language.PureScript.Publish.Registry.Compat; Language.PureScript.Role; Language.PureScript.Types; Web.Bower.PackageMeta