Interface ReviewerRegistration<PARAMS>

Register a reviewer. This can return structured data based on a project.

Type parameters

PARAMS = NoParameters

Hierarchy

AutoInspectRegistration<ProjectReview, PARAMS>
- ReviewerRegistration

Index

Properties

Methods

onInspectionResult

Properties

inspection

inspection: CodeInspection<ProjectReview, PARAMS>

Inspection function to run on each project

name

name: string

Optional parametersInstance

parametersInstance: PARAMS

Parameters used for all inspections

Optional pushTest

pushTest: PushTest

Methods

Optional onInspectionResult

onInspectionResult(result: ProjectReview, ci: ParametersInvocation<PARAMS>): Promise<PushImpactResponse | void>

Inherited from AutoInspectRegistration.onInspectionResult
- Defined in lib/api/registration/AutoInspectRegistration.ts:46
Invoked after each inspection result, if provided. A void return means keep processing this push. Return a PushImpactResponse to demand approval or fail goals.

Parameters
- result: ProjectReview
- ci: ParametersInvocation<PARAMS>
Returns Promise<PushImpactResponse | void>

Generated using TypeDoc