@softwareventures/maintain-project/project/read-yaml.d.ts

Automatically create and maintain TypeScript projects with standard settings for Software Ventures Limited

import type { Document } from "yaml";
import type { Result } from "../result/result.js";
import type { ProjectSource } from "./project.js";
import type { ReadTextFailureReason } from "./read-text.js";
export type ReadYamlResult = Result<ReadYamlFailureReason, any>;
export type ReadYamlFailureReason = ReadTextFailureReason | InvalidYaml;
export interface InvalidYaml {
    readonly type: "invalid-yaml";
    readonly reason: Error;
    readonly path: string;
}
export declare function readProjectYaml(project: ProjectSource, path: string): Promise<ReadYamlResult>;
export type ReadYamlAsDocumentResult = Result<ReadYamlFailureReason, Document.Parsed>;
export declare function readProjectYamlAsDocument(project: ProjectSource, path: string): Promise<ReadYamlAsDocumentResult>;