Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Aeson.Generics.TypeScript

Contents

Primary generation functions
Type Classes
TypeScript AST data types
Convenience builders

Synopsis

getPrintedDefinition :: forall a. TypeScriptDefinition a => Proxy a -> String
printTS :: TSType -> String
class FieldTypeName a where
- fieldTypeName :: Proxy a -> FieldSpec
class TypeScriptDefinition a where
- gen :: TSType
data FieldSpec = FieldSpec {
- fs_type :: !FieldType
- fs_wrapped :: !String
- fs_unwrapped :: !String
}
data FieldType
- = GenericField
- | ConcreteField
data IsNewtype
- = Newtype
- | Oldtype
data TSField = TSField {
- fieldName :: !(Maybe String)
- fieldType :: !FieldSpec
}
data TSGenericVar s
data TSInterface = TSInterface {
- tsi_constructor :: !String
- tsi_typeName :: !(Maybe String)
- tsi_members :: ![TSField]
}
data TSType = TSType {
- tst_constructor :: !String
- tst_doc :: !String
- tst_interfaces :: !(NonEmpty TSInterface)
- tst_newtype :: !IsNewtype
}
concretely :: String -> FieldSpec
genericly :: String -> FieldSpec

Primary generation functions

getPrintedDefinition :: forall a. TypeScriptDefinition a => Proxy a -> String Source #

Get the TypeScriptDefinition as a String

printTS :: TSType -> String Source #

Type Classes

class FieldTypeName a where Source #

Typeclass to determine the FieldSpec from a payload's type

Methods

fieldTypeName :: Proxy a -> FieldSpec Source #

Instances

Instances details

FieldTypeName Text Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy Text -> FieldSpec Source #
FieldTypeName UTCTime Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy UTCTime -> FieldSpec Source #
FieldTypeName String Source #	This needs to overlap so it doesn't get treated as an Array
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy String -> FieldSpec Source #
FieldTypeName Integer Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy Integer -> FieldSpec Source #
FieldTypeName () Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy () -> FieldSpec Source #
FieldTypeName Bool Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy Bool -> FieldSpec Source #
FieldTypeName Float Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy Float -> FieldSpec Source #
FieldTypeName Int Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy Int -> FieldSpec Source #
TypeScriptDefinition a => FieldTypeName (a :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy a -> FieldSpec Source #
KnownSymbol s => FieldTypeName (TSGenericVar s :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (TSGenericVar s) -> FieldSpec Source #
FieldTypeName a => FieldTypeName (Maybe a :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (Maybe a) -> FieldSpec Source #
FieldTypeName a => FieldTypeName ([a] :: Type) Source #	Lists are Arrays according to Aeson
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy [a] -> FieldSpec Source #
(FieldTypeName a, FieldTypeName b) => FieldTypeName (Either a b :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (Either a b) -> FieldSpec Source #
(FieldTypeName a, FieldTypeName b) => FieldTypeName (Map a b :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (Map a b) -> FieldSpec Source #
FieldTypeName a => FieldTypeName (Rec0 a :: k -> Type) Source #	Handle wrapped payload
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (Rec0 a) -> FieldSpec Source #

class TypeScriptDefinition a where Source #

This typeclass provides the ability to derive a TSType from any Generic data type

Minimal complete definition

Nothing

Methods

gen :: TSType Source #

default gen :: (TSType ~ GTypeScriptTail (Rep a), GTypeScriptDef (Rep a)) => TSType Source #

Instances

Instances details

(TypeError (('Text "No instance of TypeScriptDefinition found for: " ':<>: 'ShowType a) ':$$: 'Text "\128160 If you are seeing this for a newtype of something primitive, derive FieldTypeName instead.") :: Constraint) => TypeScriptDefinition a Source #	Custom error for missing TypeScriptDefinition's, as they can be a red herring
Instance details Defined in Data.Aeson.Generics.TypeScript Methods gen :: TSType Source #

TypeScript AST data types

data FieldSpec Source #

Helper for printing fields

Constructors

FieldSpec
Fields fs_type :: !FieldType fs_wrapped :: !String fs_unwrapped :: !String

Instances

Instances details

Show FieldSpec Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> FieldSpec -> ShowS # show :: FieldSpec -> String # showList :: [FieldSpec] -> ShowS #
Eq FieldSpec Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: FieldSpec -> FieldSpec -> Bool # (/=) :: FieldSpec -> FieldSpec -> Bool #
Ord FieldSpec Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: FieldSpec -> FieldSpec -> Ordering # (<) :: FieldSpec -> FieldSpec -> Bool # (<=) :: FieldSpec -> FieldSpec -> Bool # (>) :: FieldSpec -> FieldSpec -> Bool # (>=) :: FieldSpec -> FieldSpec -> Bool # max :: FieldSpec -> FieldSpec -> FieldSpec # min :: FieldSpec -> FieldSpec -> FieldSpec #

data FieldType Source #

Fields can be concrete types, or generic type variables

Constructors

GenericField
ConcreteField

Instances

Instances details

Semigroup FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (<>) :: FieldType -> FieldType -> FieldType # sconcat :: NonEmpty FieldType -> FieldType # stimes :: Integral b => b -> FieldType -> FieldType #
Bounded FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods minBound :: FieldType # maxBound :: FieldType #
Enum FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods succ :: FieldType -> FieldType # pred :: FieldType -> FieldType # toEnum :: Int -> FieldType # fromEnum :: FieldType -> Int # enumFrom :: FieldType -> [FieldType] # enumFromThen :: FieldType -> FieldType -> [FieldType] # enumFromTo :: FieldType -> FieldType -> [FieldType] # enumFromThenTo :: FieldType -> FieldType -> FieldType -> [FieldType] #
Show FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> FieldType -> ShowS # show :: FieldType -> String # showList :: [FieldType] -> ShowS #
Eq FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: FieldType -> FieldType -> Bool # (/=) :: FieldType -> FieldType -> Bool #
Ord FieldType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: FieldType -> FieldType -> Ordering # (<) :: FieldType -> FieldType -> Bool # (<=) :: FieldType -> FieldType -> Bool # (>) :: FieldType -> FieldType -> Bool # (>=) :: FieldType -> FieldType -> Bool # max :: FieldType -> FieldType -> FieldType # min :: FieldType -> FieldType -> FieldType #

data IsNewtype Source #

Determine if this is a newtype and will not be wrapped

Constructors

Newtype
Oldtype

Instances

Instances details

Show IsNewtype Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> IsNewtype -> ShowS # show :: IsNewtype -> String # showList :: [IsNewtype] -> ShowS #
Eq IsNewtype Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: IsNewtype -> IsNewtype -> Bool # (/=) :: IsNewtype -> IsNewtype -> Bool #
Ord IsNewtype Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: IsNewtype -> IsNewtype -> Ordering # (<) :: IsNewtype -> IsNewtype -> Bool # (<=) :: IsNewtype -> IsNewtype -> Bool # (>) :: IsNewtype -> IsNewtype -> Bool # (>=) :: IsNewtype -> IsNewtype -> Bool # max :: IsNewtype -> IsNewtype -> IsNewtype # min :: IsNewtype -> IsNewtype -> IsNewtype #

data TSField Source #

A field within a term constructor

Constructors

TSField
Fields fieldName :: !(Maybe String) fieldType :: !FieldSpec

Instances

Instances details

Show TSField Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> TSField -> ShowS # show :: TSField -> String # showList :: [TSField] -> ShowS #
Eq TSField Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: TSField -> TSField -> Bool # (/=) :: TSField -> TSField -> Bool #
Ord TSField Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: TSField -> TSField -> Ordering # (<) :: TSField -> TSField -> Bool # (<=) :: TSField -> TSField -> Bool # (>) :: TSField -> TSField -> Bool # (>=) :: TSField -> TSField -> Bool # max :: TSField -> TSField -> TSField # min :: TSField -> TSField -> TSField #

data TSGenericVar s Source #

Type level rep of a named generic type variable

Instances

Instances details

KnownSymbol s => FieldTypeName (TSGenericVar s :: Type) Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods fieldTypeName :: Proxy (TSGenericVar s) -> FieldSpec Source #

data TSInterface Source #

A term constructor in Haskell, most likely an interface in TypeScript

Constructors

TSInterface
Fields tsi_constructor :: !String tsi_typeName :: !(Maybe String) tsi_members :: ![TSField]

Instances

Instances details

Show TSInterface Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> TSInterface -> ShowS # show :: TSInterface -> String # showList :: [TSInterface] -> ShowS #
Eq TSInterface Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: TSInterface -> TSInterface -> Bool # (/=) :: TSInterface -> TSInterface -> Bool #
Ord TSInterface Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: TSInterface -> TSInterface -> Ordering # (<) :: TSInterface -> TSInterface -> Bool # (<=) :: TSInterface -> TSInterface -> Bool # (>) :: TSInterface -> TSInterface -> Bool # (>=) :: TSInterface -> TSInterface -> Bool # max :: TSInterface -> TSInterface -> TSInterface # min :: TSInterface -> TSInterface -> TSInterface #

data TSType Source #

The top level TypeScript type declaration

Constructors

TSType
Fields tst_constructor :: !String tst_doc :: !String tst_interfaces :: !(NonEmpty TSInterface) tst_newtype :: !IsNewtype

Instances

Instances details

Show TSType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods showsPrec :: Int -> TSType -> ShowS # show :: TSType -> String # showList :: [TSType] -> ShowS #
Eq TSType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods (==) :: TSType -> TSType -> Bool # (/=) :: TSType -> TSType -> Bool #
Ord TSType Source #
Instance details Defined in Data.Aeson.Generics.TypeScript Methods compare :: TSType -> TSType -> Ordering # (<) :: TSType -> TSType -> Bool # (<=) :: TSType -> TSType -> Bool # (>) :: TSType -> TSType -> Bool # (>=) :: TSType -> TSType -> Bool # max :: TSType -> TSType -> TSType # min :: TSType -> TSType -> TSType #

Convenience builders

concretely :: String -> FieldSpec Source #

Construct a FieldSpec assuming standard use and a concrete type variable

genericly :: String -> FieldSpec Source #

Construct a FieldSpec assuming standard use and a generic type variable