PackageUsageModel
Defined in: packages/core/src/models/usage.ts:59
Data operations for build package usage and project links.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PackageUsageModel(
db,tables?):PackageUsageModel
Defined in: packages/core/src/models/usage.ts:68
Parameters
Section titled “Parameters”Database adapter.
tables?
Section titled “tables?”Table handles.
Returns
Section titled “Returns”PackageUsageModel
Methods
Section titled “Methods”listForBuild()
Section titled “listForBuild()”listForBuild(
buildId):Promise<BuildPackageUsage[]>
Defined in: packages/core/src/models/usage.ts:124
List all usage rows of a build.
Parameters
Section titled “Parameters”buildId
Section titled “buildId”string
Returns
Section titled “Returns”Promise<BuildPackageUsage[]>
listForStory()
Section titled “listForStory()”listForStory(
buildId,storyImportPath):Promise<BuildPackageUsage[]>
Defined in: packages/core/src/models/usage.ts:139
List the usage rows of one story file within a build.
Parameters
Section titled “Parameters”buildId
Section titled “buildId”string
storyImportPath
Section titled “storyImportPath”string
Returns
Section titled “Returns”Promise<BuildPackageUsage[]>
listLinks()
Section titled “listLinks()”listLinks(
downstreamId):Promise<ProjectLink[]>
Defined in: packages/core/src/models/usage.ts:131
List the packages a downstream project links to upstream projects.
Parameters
Section titled “Parameters”downstreamId
Section titled “downstreamId”string
Returns
Section titled “Returns”Promise<ProjectLink[]>
removeForBuild()
Section titled “removeForBuild()”removeForBuild(
buildId):Promise<number>
Defined in: packages/core/src/models/usage.ts:119
Explicitly remove all usage rows of a build (no reliance on FK cascade).
Parameters
Section titled “Parameters”buildId
Section titled “buildId”string
Returns
Section titled “Returns”Promise<number>
The number of rows removed.
replaceForBuild()
Section titled “replaceForBuild()”replaceForBuild(
projectId,buildId,rows):Promise<number>
Defined in: packages/core/src/models/usage.ts:83
Replace the usage rows of a build, so re-reporting is idempotent. Runs in one transaction when the driver supports it and is serialized per build, so concurrent re-reports leave exactly one report’s rows.
Parameters
Section titled “Parameters”projectId
Section titled “projectId”string
buildId
Section titled “buildId”string
readonly PackageUsageInput[]
Returns
Section titled “Returns”Promise<number>
The number of rows stored.
replaceLinks()
Section titled “replaceLinks()”replaceLinks(
downstreamId,links):Promise<ProjectLink[]>
Defined in: packages/core/src/models/usage.ts:155
Replace a downstream project’s links with the given list, atomically when the driver supports transactions and serialized per downstream project.
Parameters
Section titled “Parameters”downstreamId
Section titled “downstreamId”string
readonly object[]
Returns
Section titled “Returns”Promise<ProjectLink[]>
The stored links.