Skip to content

Span

22 exports Added in v1.0.0 Source

Combinators

concat

Added in v1.0.0 Source

Signature

declare const concat: {
  (that: Span): (self: Span) => Span;
  (self: Span, that: Span): Span;
};

spans

Added in v1.0.0 Source

Signature

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

Constructors

code

Added in v1.0.0 Source

Signature

declare const code: (value: string | Span) => Span;

empty

Added in v1.0.0 Source

Signature

declare const empty: Span;

error

Added in v1.0.0 Source

Signature

declare const error: (value: string | Span) => Span;

space

Added in v1.0.0 Source

Signature

declare const space: Span;

strong

Added in v1.0.0 Source

Signature

declare const strong: (value: string | Span) => Span;

text

Added in v1.0.0 Source

Signature

declare const text: (value: string) => Span;

uri

Added in v1.0.0 Source

Signature

declare const uri: (value: string) => Span;

weak

Added in v1.0.0 Source

Signature

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

Models

Highlight interface

Added in v1.0.0 Source

Signature

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

Sequence interface

Added in v1.0.0 Source

Signature

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

Span type

Added in v1.0.0 Source

Signature

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

Strong interface

Added in v1.0.0 Source

Signature

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

Text interface

Added in v1.0.0 Source

Signature

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

URI interface

Added in v1.0.0 Source

Signature

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

Weak interface

Added in v1.0.0 Source

Signature

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

Refinements

isSequence

Added in v1.0.0 Source

Signature

declare const isSequence: (self: Span) => self is Sequence;

isStrong

Added in v1.0.0 Source

Signature

declare const isStrong: (self: Span) => self is Strong;

isText

Added in v1.0.0 Source

Signature

declare const isText: (self: Span) => self is Text;

isUri

Added in v1.0.0 Source

Signature

declare const isUri: (self: Span) => self is URI;

isWeak

Added in v1.0.0 Source

Signature

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