Interface JoinResult

Result of a join operation containing combined content and metadata.

Provides comprehensive information about the joining process including success status, conflicts, and any issues encountered.

interface JoinResult {
    success: boolean;
    content: string;
    frontmatter: undefined | string;
    sourceFiles: string[];
    conflicts: JoinConflict[];
    warnings: string[];
    errors: string[];
    deduplicatedLinks: string[];
}

Properties

success: boolean

Whether the join was successful

content: string

Combined content

frontmatter: undefined | string

Combined frontmatter

sourceFiles: string[]

List of files that were joined

conflicts: JoinConflict[]

Conflicts that need resolution

warnings: string[]

Warnings

errors: string[]

Errors

deduplicatedLinks: string[]

Duplicate links that were removed