Skip to content

[V] fileRef

const fileRef: object;

Factories for lazy file references whose content is read later by documentation tooling.

NameTypeDescription
fromPackageRoot()(path) => FileRefCreate a FileRef pointing to a file relative to the package root (the directory containing the library’s package.json). Example docs: fileRef.fromPackageRoot("src/rules/my-rule.md"),