index.ts overview
The abstract data type Doc<A> represents prettified documents that have been annotated with data of type A.
More specifically, a value of type Doc represents a non-empty set of possible layouts for a given document. The layout algorithms select one of these possibilities, taking into account variables such as the width of the document.
The annotation is an arbitrary piece of data associated with (part of) a document. Annotations may be used by rendering algorithms to display documents differently by providing information such as:
- color information (e.g., when rendering to the terminal)
- mouseover text (e.g., when rendering to rich HTML)
- whether to show something or not (to allow simple or detailed versions)
Since v1.0.0
Exports Grouped by Category
utils
Doc (namespace export)
Re-exports all named exports from the “./Doc.js” module as Doc.
Signature
export * as Doc from "./Doc.js"
Since v1.0.0
DocStream (namespace export)
Re-exports all named exports from the “./DocStream.js” module as DocStream.
Signature
export * as DocStream from "./DocStream.js"
Since v1.0.0
DocTree (namespace export)
Re-exports all named exports from the “./DocTree.js” module as DocTree.
Signature
export * as DocTree from "./DocTree.js"
Since v1.0.0
Flatten (namespace export)
Re-exports all named exports from the “./Flatten.js” module as Flatten.
Signature
export * as Flatten from "./Flatten.js"
Since v1.0.0
Layout (namespace export)
Re-exports all named exports from the “./Layout.js” module as Layout.
Signature
export * as Layout from "./Layout.js"
Since v1.0.0
Optimize (namespace export)
Re-exports all named exports from the “./Optimize.js” module as Optimize.
Signature
export * as Optimize from "./Optimize.js"
Since v1.0.0
PageWidth (namespace export)
Re-exports all named exports from the “./PageWidth.js” module as PageWidth.
Signature
export * as PageWidth from "./PageWidth.js"
Since v1.0.0