domain overview
Added in v0.5.0
Table of contents
constructor
makeClass
Signature
export declare function makeClass(
documentable: Documentable,
signature: string,
methods: Array<Method>,
staticMethods: Array<Method>,
properties: Array<Property>
): Class
Added in v0.5.0
makeConstant
Signature
export declare function makeConstant(documentable: Documentable, signature: string): Constant
Added in v0.5.0
makeDocumentable
Signature
export declare function makeDocumentable(
name: string,
description: O.Option<string>,
since: O.Option<string>,
deprecated: boolean,
examples: Array<Example>,
category: O.Option<string>
): Documentable
Added in v0.5.0
makeExample
Signature
export declare const makeExample: (code: string) => string
Added in v0.5.0
makeExport
Signature
export declare function makeExport(documentable: Documentable, signature: string): Export
Added in v0.5.0
makeFunction
Signature
export declare function makeFunction(documentable: Documentable, signatures: Array<string>): Function
Added in v0.5.0
makeInterface
Signature
export declare function makeInterface(documentable: Documentable, signature: string): Interface
Added in v0.5.0
makeMethod
Signature
export declare function makeMethod(documentable: Documentable, signatures: Array<string>): Method
Added in v0.5.0
makeModule
Signature
export declare function makeModule(
name: string,
documentable: O.Option<Documentable>,
path: Array<string>,
interfaces: Array<Interface>,
typeAliases: Array<TypeAlias>,
functions: Array<Function>,
classes: Array<Class>,
constants: Array<Constant>,
exports: Array<Export>
): Module
Added in v0.5.0
makeProperty
Signature
export declare function makeProperty(documentable: Documentable, signature: string): Property
Added in v0.5.0
makeTypeAlias
Signature
export declare function makeTypeAlias(documentable: Documentable, signature: string): TypeAlias
Added in v0.5.0
instance
ordModule
Signature
export declare const ordModule: Ord<Module>
Added in v0.5.0
model
Class (interface)
Signature
export interface Class extends Documentable {
readonly _tag: 'Class'
readonly signature: string
readonly methods: Array<Method>
readonly staticMethods: Array<Method>
readonly properties: Array<Property>
}
Added in v0.5.0
Constant (interface)
Signature
export interface Constant extends Documentable {
readonly _tag: 'Constant'
readonly signature: string
}
Added in v0.5.0
Documentable (interface)
Signature
export interface Documentable {
readonly name: string
readonly description: O.Option<string>
readonly since: O.Option<string>
readonly deprecated: boolean
readonly examples: Array<Example>
readonly category: O.Option<string>
}
Added in v0.5.0
Example (type alias)
Signature
export type Example = string
Added in v0.5.0
Export (interface)
Signature
export interface Export extends Documentable {
readonly _tag: 'Export'
readonly signature: string
}
Added in v0.5.0
Function (interface)
Signature
export interface Function extends Documentable {
readonly _tag: 'Function'
readonly signatures: Array<string>
}
Added in v0.5.0
Interface (interface)
Signature
export interface Interface extends Documentable {
readonly _tag: 'Interface'
readonly signature: string
}
Added in v0.5.0
Method (interface)
Signature
export interface Method extends Documentable {
readonly signatures: Array<string>
}
Added in v0.5.0
Module (interface)
Signature
export interface Module {
readonly name: string
readonly documentation: O.Option<Documentable>
readonly path: Array<string>
readonly interfaces: Array<Interface>
readonly typeAliases: Array<TypeAlias>
readonly functions: Array<Function>
readonly classes: Array<Class>
readonly constants: Array<Constant>
readonly exports: Array<Export>
}
Added in v0.5.0
Property (interface)
Signature
export interface Property extends Documentable {
readonly signature: string
}
Added in v0.5.0
TypeAlias (interface)
Signature
export interface TypeAlias extends Documentable {
readonly _tag: 'TypeAlias'
readonly signature: string
}
Added in v0.5.0
utils
isModuleDeprecated
A module without documentation is considered not deprecated
Signature
export declare const isModuleDeprecated: (module: Module) => boolean
Added in v0.6.0