Skip to main content
Version: Next

UrlPreparer.prepare()

Home > @backstage/plugin-techdocs-node > UrlPreparer > prepare

Given an Entity definition from the Software Catalog, go and prepare a directory with contents from the location in temporary storage and return the path.

Signature:

prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>;

Parameters

Parameter

Type

Description

entity

Entity

The entity from the Software Catalog

options

PreparerOptions

(Optional) If etag is provided, it will be used to check if the target has updated since the last build.

**Returns:**

Promise<PreparerResponse>