Circle V2 API Docs
    Preparing search index...

    Type Alias ExtractedSection

    type ExtractedSection = {
        extend: ExtractedSectionProvenance;
        extractor: string | null;
        identifier: string | null;
        index: number;
        pages: [number, number] | null;
        text?: string;
        text_source?: ExtractedTextSource;
        type: string;
        value: unknown;
    }
    Index

    Properties

    extend extractor identifier index pages text? text_source? type value

    Properties

    extend: ExtractedSectionProvenance
    extractor: string | null
    identifier: string | null
    index: number

    1-based position in page order; also the heading number in the rendered text.

    pages: [number, number] | null

    Null for a piece extracted over a file no split lists, so its pages are unknown.

    Optionaltext

    text?: string

    The parse markdown of this section's own pages; absent until the parse run has been fetched.

    Optionaltext_source

    text_source?: ExtractedTextSource
    type: string
    value: unknown

    Null when Extend split the piece off but ran no extraction over it.

    Settings

    Member Visibility

    On This Page

    Properties