Skip to content

craft-hub / SoftwareRepositoryReader

Interface: SoftwareRepositoryReader ​

Defined in: packages/craft-hub/src/software-sources.ts:69

Repository IO seam used by both the source workflow and isolated tests.

Properties ​

local ​

local: (localPath, path) => Promise<{ commit?: string; content: string; localPath: string; repository?: string; }>

Defined in: packages/craft-hub/src/software-sources.ts:71

Identify a local checkout and read its current TypeScript config, including uncommitted changes, without execution.

Parameters ​

localPath ​

string

path ​

string

Returns ​

Promise<{ commit?: string; content: string; localPath: string; repository?: string; }>


remote ​

remote: (repository, branch, path) => Promise<{ commit: string; content: string; }>

Defined in: packages/craft-hub/src/software-sources.ts:70

Read one public catalog at a fixed remote commit, without a checkout or running repository code.

Parameters ​

repository ​

string

branch ​

string

path ​

string

Returns ​

Promise<{ commit: string; content: string; }>

Released under the MIT License.