Safe Haskell	None
Language	Haskell2010

Cardano.Wasm.Api.Info

Synopsis

apiInfo :: ApiInfo
data ApiInfo = ApiInfo {
- mainObject :: VirtualObjectInfo
- virtualObjects :: [VirtualObjectInfo]
- initialiseFunctionDoc :: String
- initialiseFunctionReturnDoc :: String
}
data VirtualObjectInfo = VirtualObjectInfo {
- virtualObjectName :: String
- virtualObjectDoc :: String
- virtualObjectMethods :: [MethodHierarchy]
}
data MethodHierarchy
- = MethodGroupEntry MethodGroup
- | MethodInfoEntry MethodInfo
data MethodGroup = MethodGroup {
- groupName :: String
- groupDoc :: [String]
- groupMethods :: [MethodHierarchy]
}
data MethodInfo = MethodInfo {
- methodName :: String
- methodDoc :: String
- methodParams :: [ParamInfo]
- methodReturnType :: MethodReturnTypeInfo
- methodReturnDoc :: String
}
data ParamInfo = ParamInfo {
- paramName :: String
- paramType :: TSType
- paramDoc :: String
}
data MethodReturnTypeInfo
- = Fluent
- | NewObject String
- | OtherType TSType
dashCaseName :: VirtualObjectInfo -> String
tsTypeAsString :: TSType -> String

Documentation

apiInfo :: ApiInfo Source #

Provides metadata about the "virtual objects" and their methods. This is intended to help generate JavaScript wrappers.

data ApiInfo Source #

Aggregate type for all API information.

Constructors

ApiInfo

Fields

mainObject :: VirtualObjectInfo
Information about the main virtual object of the API, which serves as the entry point.
virtualObjects :: [VirtualObjectInfo]
Info about all other (non-main) virtual objects and their methods.
initialiseFunctionDoc :: String
Documentation for the initialise function of the API (which creates the main virtual object).
initialiseFunctionReturnDoc :: String
Documentation for the return value of the initialise function (which is the main virtual object).

Instances

Instances details

ToJSON ApiInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: ApiInfo -> Value # toEncoding :: ApiInfo -> Encoding # toJSONList :: [ApiInfo] -> Value # toEncodingList :: [ApiInfo] -> Encoding # omitField :: ApiInfo -> Bool #
Show ApiInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> ApiInfo -> ShowS Source # show :: ApiInfo -> String Source # showList :: [ApiInfo] -> ShowS Source #
Eq ApiInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: ApiInfo -> ApiInfo -> Bool Source # (/=) :: ApiInfo -> ApiInfo -> Bool Source #

data VirtualObjectInfo Source #

Information about a virtual object and its methods.

Constructors

VirtualObjectInfo
Fields virtualObjectName :: String Name of the virtual object in the JS API (which should match the exported class and be PascalCase). virtualObjectDoc :: String Documentation for the virtual object. virtualObjectMethods :: [MethodHierarchy] Information about the methods of the virtual object.

Instances

Instances details

ToJSON VirtualObjectInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: VirtualObjectInfo -> Value # toEncoding :: VirtualObjectInfo -> Encoding # toJSONList :: [VirtualObjectInfo] -> Value # toEncodingList :: [VirtualObjectInfo] -> Encoding # omitField :: VirtualObjectInfo -> Bool #
Show VirtualObjectInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> VirtualObjectInfo -> ShowS Source # show :: VirtualObjectInfo -> String Source # showList :: [VirtualObjectInfo] -> ShowS Source #
Eq VirtualObjectInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: VirtualObjectInfo -> VirtualObjectInfo -> Bool Source # (/=) :: VirtualObjectInfo -> VirtualObjectInfo -> Bool Source #

data MethodHierarchy Source #

Method hierarchy. Allows grouping methods in sub-groups.

Constructors

MethodGroupEntry MethodGroup
MethodInfoEntry MethodInfo

Instances

Instances details

ToJSON MethodHierarchy Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: MethodHierarchy -> Value # toEncoding :: MethodHierarchy -> Encoding # toJSONList :: [MethodHierarchy] -> Value # toEncodingList :: [MethodHierarchy] -> Encoding # omitField :: MethodHierarchy -> Bool #
Show MethodHierarchy Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> MethodHierarchy -> ShowS Source # show :: MethodHierarchy -> String Source # showList :: [MethodHierarchy] -> ShowS Source #
Eq MethodHierarchy Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: MethodHierarchy -> MethodHierarchy -> Bool Source # (/=) :: MethodHierarchy -> MethodHierarchy -> Bool Source #

data MethodGroup Source #

Method group. groups several methods under a common name.

Constructors

MethodGroup
Fields groupName :: String Name of the method group. groupDoc :: [String] Documentation for the method group. groupMethods :: [MethodHierarchy] Methods or sub-groups belonging to this group.

Instances

Instances details

ToJSON MethodGroup Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: MethodGroup -> Value # toEncoding :: MethodGroup -> Encoding # toJSONList :: [MethodGroup] -> Value # toEncodingList :: [MethodGroup] -> Encoding # omitField :: MethodGroup -> Bool #
Show MethodGroup Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> MethodGroup -> ShowS Source # show :: MethodGroup -> String Source # showList :: [MethodGroup] -> ShowS Source #
Eq MethodGroup Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: MethodGroup -> MethodGroup -> Bool Source # (/=) :: MethodGroup -> MethodGroup -> Bool Source #

data MethodInfo Source #

Information about a single method of a virtual object.

Constructors

MethodInfo
Fields methodName :: String Name of the method in the virtual object of the JS API (which should match the exported function). methodDoc :: String General documentation for the method. methodParams :: [ParamInfo] Info about parameters, excluding `this`. methodReturnType :: MethodReturnTypeInfo Return type of the method. methodReturnDoc :: String Documentation for the return value of the method.

Instances

Instances details

ToJSON MethodInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: MethodInfo -> Value # toEncoding :: MethodInfo -> Encoding # toJSONList :: [MethodInfo] -> Value # toEncodingList :: [MethodInfo] -> Encoding # omitField :: MethodInfo -> Bool #
Show MethodInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> MethodInfo -> ShowS Source # show :: MethodInfo -> String Source # showList :: [MethodInfo] -> ShowS Source #
Eq MethodInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: MethodInfo -> MethodInfo -> Bool Source # (/=) :: MethodInfo -> MethodInfo -> Bool Source #

data ParamInfo Source #

Information about a single parameter of a method.

Constructors

ParamInfo
Fields paramName :: String Name of the parameter. paramType :: TSType Type of the parameter (as a TypeScript type). paramDoc :: String Documentation for the parameter.

Instances

Instances details

ToJSON ParamInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: ParamInfo -> Value # toEncoding :: ParamInfo -> Encoding # toJSONList :: [ParamInfo] -> Value # toEncodingList :: [ParamInfo] -> Encoding # omitField :: ParamInfo -> Bool #
Show ParamInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> ParamInfo -> ShowS Source # show :: ParamInfo -> String Source # showList :: [ParamInfo] -> ShowS Source #
Eq ParamInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: ParamInfo -> ParamInfo -> Bool Source # (/=) :: ParamInfo -> ParamInfo -> Bool Source #

data MethodReturnTypeInfo Source #

Describes the return type of a method.

Constructors

Fluent	Returns an instance of the same object type (fluent interface).
NewObject String	Returns a new instance of a specified virtual object type.
OtherType TSType	Returns a non-virtual-object type (e.g., JSString, number).

Instances

Instances details

ToJSON MethodReturnTypeInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods toJSON :: MethodReturnTypeInfo -> Value # toEncoding :: MethodReturnTypeInfo -> Encoding # toJSONList :: [MethodReturnTypeInfo] -> Value # toEncodingList :: [MethodReturnTypeInfo] -> Encoding # omitField :: MethodReturnTypeInfo -> Bool #
Show MethodReturnTypeInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods showsPrec :: Int -> MethodReturnTypeInfo -> ShowS Source # show :: MethodReturnTypeInfo -> String Source # showList :: [MethodReturnTypeInfo] -> ShowS Source #
Eq MethodReturnTypeInfo Source #
Instance details Defined in Cardano.Wasm.Api.Info Methods (==) :: MethodReturnTypeInfo -> MethodReturnTypeInfo -> Bool Source # (/=) :: MethodReturnTypeInfo -> MethodReturnTypeInfo -> Bool Source #

dashCaseName :: VirtualObjectInfo -> String Source #

tsTypeAsString :: TSType -> String Source #