geneea-nlp-client/common/char-span.d.ts

The TypeScript Client for Geneea Interpretor G3 API.

/** Continuous non-empty span of text, relative to some large text. */
declare class CharSpan {
    start: number;
    end: number;
    /**
     *
     * @param start The first character of this span as a zero-based offset within the full text.
     * @param end Zero-based index of the character immediately following this span. The span cannot be empty.
     */
    constructor(start: number, end: number);
    /**
     * Creates a CharSpan object from [start] index and [end] index.
     * @param start The first character of this span as a zero-based offset within the full text.
     * @param end Index of the character immediately following this span.
     */
    static of(start: number, end: number): CharSpan;
    /**
     * Creates a CharSpan object from [start] index and text [length].
     * @param start The first character of this span as a zero-based offset within the full text.
     * @param length The length of this span.
     */
    static withLen(start: number, length: number): CharSpan;
    /** Length of the span in characters. */
    get length(): number;
    /** Substring of a full text as denoted by this span. */
    extractText(fullText: string): string;
    toString(): string;
}
export { CharSpan };