/**
 * @since 0.5.0
 */
import * as O from 'fp-ts/lib/Option';
import { Ord } from 'fp-ts/lib/Ord';
/**
 * @category model
 * @since 0.5.0
 */
export declare type Example = string;
/**
 * @category model
 * @since 0.5.0
 */
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>;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Interface extends Documentable {
    readonly _tag: 'Interface';
    readonly signature: string;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Function extends Documentable {
    readonly _tag: 'Function';
    readonly signatures: Array<string>;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Method extends Documentable {
    readonly signatures: Array<string>;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Property extends Documentable {
    readonly signature: string;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Class extends Documentable {
    readonly _tag: 'Class';
    readonly signature: string;
    readonly methods: Array<Method>;
    readonly staticMethods: Array<Method>;
    readonly properties: Array<Property>;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface TypeAlias extends Documentable {
    readonly _tag: 'TypeAlias';
    readonly signature: string;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Constant extends Documentable {
    readonly _tag: 'Constant';
    readonly signature: string;
}
/**
 * @category model
 * @since 0.5.0
 */
export interface Export extends Documentable {
    readonly _tag: 'Export';
    readonly signature: string;
}
/**
 * @category model
 * @since 0.5.0
 */
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>;
}
/**
 * @category constructor
 * @since 0.5.0
 */
export declare const makeExample: (code: string) => Example;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeDocumentable(name: string, description: O.Option<string>, since: O.Option<string>, deprecated: boolean, examples: Array<Example>, category: O.Option<string>): Documentable;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeInterface(documentable: Documentable, signature: string): Interface;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeFunction(documentable: Documentable, signatures: Array<string>): Function;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeMethod(documentable: Documentable, signatures: Array<string>): Method;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeProperty(documentable: Documentable, signature: string): Property;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeClass(documentable: Documentable, signature: string, methods: Array<Method>, staticMethods: Array<Method>, properties: Array<Property>): Class;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeTypeAlias(documentable: Documentable, signature: string): TypeAlias;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeConstant(documentable: Documentable, signature: string): Constant;
/**
 * @category constructor
 * @since 0.5.0
 */
export declare function makeExport(documentable: Documentable, signature: string): Export;
/**
 * @category constructor
 * @since 0.5.0
 */
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;
/**
 * @category instance
 * @since 0.5.0
 */
export declare const ordModule: Ord<Module>;
/**
 * A module without documentation is considered not deprecated
 *
 * @category utils
 * @since 0.6.0
 */
export declare const isModuleDeprecated: (module: Module) => boolean;