Span.ts overview
Since v1.0.0
Exports Grouped by Category
combinators
concat
Signature
declare const concat: { (that: Span): (self: Span) => Span; (self: Span, that: Span): Span }
Since v1.0.0
spans
Signature
declare const spans: (spans: Iterable<Span>) => Span
Since v1.0.0
constructors
code
Signature
declare const code: (value: string | Span) => Span
Since v1.0.0
empty
Signature
declare const empty: Span
Since v1.0.0
error
Signature
declare const error: (value: string | Span) => Span
Since v1.0.0
space
Signature
declare const space: Span
Since v1.0.0
strong
Signature
declare const strong: (value: string | Span) => Span
Since v1.0.0
text
Signature
declare const text: (value: string) => Span
Since v1.0.0
uri
Signature
declare const uri: (value: string) => Span
Since v1.0.0
weak
Signature
declare const weak: (value: string | Span) => Span
Since v1.0.0
models
Highlight (interface)
Signature
export interface Highlight {
readonly _tag: "Highlight"
readonly value: Span
readonly color: Color
}
Since v1.0.0
Sequence (interface)
Signature
export interface Sequence {
readonly _tag: "Sequence"
readonly left: Span
readonly right: Span
}
Since v1.0.0
Span (type alias)
Signature
type Span = Highlight | Sequence | Strong | Text | URI | Weak
Since v1.0.0
Strong (interface)
Signature
export interface Strong {
readonly _tag: "Strong"
readonly value: Span
}
Since v1.0.0
Text (interface)
Signature
export interface Text {
readonly _tag: "Text"
readonly value: string
}
Since v1.0.0
URI (interface)
Signature
export interface URI {
readonly _tag: "URI"
readonly value: string
}
Since v1.0.0
Weak (interface)
Signature
export interface Weak {
readonly _tag: "Weak"
readonly value: Span
}
Since v1.0.0
refinements
isSequence
Signature
declare const isSequence: (self: Span) => self is Sequence
Since v1.0.0
isStrong
Signature
declare const isStrong: (self: Span) => self is Strong
Since v1.0.0
isText
Signature
declare const isText: (self: Span) => self is Text
Since v1.0.0
isUri
Signature
declare const isUri: (self: Span) => self is URI
Since v1.0.0
isWeak
Signature
declare const isWeak: (self: Span) => self is Weak
Since v1.0.0