Interface CitationFileSource

File access for the verifier. Paths from listFiles are relative to the root and use the platform separator; isFile and readFile take absolute paths.

interface CitationFileSource {
    isFile(path: string): boolean;
    listFiles(): readonly string[];
    readFile(path: string): string;
}

Index

Methods

isFile listFiles readFile

Methods

isFile

isFile(path: string): boolean
true when the absolute path is an existing file.
Parameters
- path: string
Returns boolean

listFiles

listFiles(): readonly string[]
Repository files relative to the root (dependency and build folders excluded).

Returns readonly string[]

readFile

readFile(path: string): string
Content of an existing file.
Parameters
- path: string
Returns string