Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

Span

22 exports Since v1.0.0 Source

Combinators

Since v1.0.0

Signature

declare const concat: {
(that: Span): (self: Span) => Span;
(self: Span, that: Span): Span;
}
Since v1.0.0

Signature

declare const spans: (spans: Iterable<Span>) => Span

Constructors

Since v1.0.0

Signature

declare const code: (value: string | Span) => Span
Since v1.0.0

Signature

declare const empty: Span
Since v1.0.0

Signature

declare const error: (value: string | Span) => Span
Since v1.0.0

Signature

declare const space: Span
Since v1.0.0

Signature

declare const strong: (value: string | Span) => Span
Since v1.0.0

Signature

declare const text: (value: string) => Span
Since v1.0.0

Signature

declare const uri: (value: string) => Span
Since v1.0.0

Signature

declare const weak: (value: string | Span) => Span

Models

Highlight

interface
Since v1.0.0

Signature

interface Highlight {
readonly _tag: "Highlight";
readonly color: Color;
readonly value: Span;
}

Sequence

interface
Since v1.0.0

Signature

interface Sequence {
readonly _tag: "Sequence";
readonly left: Span;
readonly right: Span;
}

Span

type
Since v1.0.0

Signature

type Span = Highlight | Sequence | Strong | Text | URI | Weak

Strong

interface
Since v1.0.0

Signature

interface Strong {
readonly _tag: "Strong";
readonly value: Span;
}

Text

interface
Since v1.0.0

Signature

interface Text {
readonly _tag: "Text";
readonly value: string;
}

URI

interface
Since v1.0.0

Signature

interface URI {
readonly _tag: "URI";
readonly value: string;
}

Weak

interface
Since v1.0.0

Signature

interface Weak {
readonly _tag: "Weak";
readonly value: Span;
}

Refinements

Signature

declare const isSequence: (self: Span) => self is Sequence
Since v1.0.0

Signature

declare const isStrong: (self: Span) => self is Strong
Since v1.0.0

Signature

declare const isText: (self: Span) => self is Text
Since v1.0.0

Signature

declare const isUri: (self: Span) => self is URI
Since v1.0.0

Signature

declare const isWeak: (self: Span) => self is Weak