Version: Next

getDocFilesFromRepository()

Home > @backstage/plugin-techdocs-node > getDocFilesFromRepository

Returns a preparer response PreparerResponse

Signature:

getDocFilesFromRepository: (reader: UrlReaderService, entity: Entity, opts?: {
    etag?: string;
    logger?: LoggerService;
}) => Promise<PreparerResponse>

Parameters

Parameter	Type	Description
reader	UrlReaderService	Read a tree of files from a repository
entity	Entity	A TechDocs entity instance
opts	{ etag?: string; logger?: LoggerService; }	(Optional) Options for configuring the reader, e.g. logger, etag, etc.

**Returns:**

Promise<PreparerResponse>

Parameters​

Parameters