Skip to content

craft-hub / readProjectOverviewAsset

Function: readProjectOverviewAsset() ​

readProjectOverviewAsset(projectRoot, projectRelativePath): Promise<{ content: Buffer; contentType: string; } | undefined>

Defined in: packages/craft-hub/src/project-overview.ts:178

Read one bounded raster image inside a registered project for README rendering.

Parameters ​

projectRoot ​

string

projectRelativePath ​

string

Returns ​

Promise<{ content: Buffer; contentType: string; } | undefined>

Released under the MIT License.