resolveIncludes

resolveIncludes(entry, entryFormat, fileProvider): Promise<CompositeSource>

Defined in: packages/speculator/src/preprocess/include/resolver.ts:235

Resolve all includes from an entry file

Parameters

entry

string

Canonical path to entry file

entryFormat

Format of entry file (inferred if not provided)

SourceFormat | undefined

fileProvider

FileProvider

File provider for reading files

Returns

Promise<CompositeSource>

CompositeSource with resolved includes

Throws

IncludeResolveError on cycle detection or file not found

Example

const source = await resolveIncludes(
  '/spec/format.md',
  'markdown',
  fileProvider
);

// source.units is ordered by document flow
for (const unit of source.units) {
  console.log(`${unit.file}:${unit.startLine}`);
}