Module "api-helper/goal/storeGoals"

Index

Interfaces

UpdateSdmGoalParams

Functions

Functions

cleanPush

cleanPush(push: Fragment): Fragment

- Defined in lib/api-helper/goal/storeGoals.ts:338
Parameters
- push: Fragment
Returns Fragment

constructGoalSet

constructGoalSet(ctx: HandlerContext, goalSetId: string, goalSet: string, sdmGoals: SdmGoalMessage[], tags: GoalSetTag[], push: Push): SdmGoalSetMessage

- Defined in lib/api-helper/goal/storeGoals.ts:251
Parameters
- ctx: HandlerContext
- goalSetId: string
- goalSet: string
- sdmGoals: SdmGoalMessage[]
- tags: GoalSetTag[]
- push: Push
Returns SdmGoalSetMessage

constructProvenance

constructProvenance(ctx: HandlerContext): SdmProvenance

- Defined in lib/api-helper/goal/storeGoals.ts:214
Parameters
- ctx: HandlerContext
Returns SdmProvenance

constructSdmGoal

constructSdmGoal(ctx: HandlerContext, parameters: { fulfillment?: SdmGoalFulfillment; goal: Goal; goalSet: string; goalSetId: string; id: RemoteRepoRef; providerId: string; state: SdmGoalState; url?: string }): SdmGoalMessage

- Defined in lib/api-helper/goal/storeGoals.ts:120
Parameters
- ctx: HandlerContext
- parameters: { fulfillment?: SdmGoalFulfillment; goal: Goal; goalSet: string; goalSetId: string; id: RemoteRepoRef; providerId: string; state: SdmGoalState; url?: string }
  - Optional fulfillment?: SdmGoalFulfillment
  - goal: Goal
  - goalSet: string
  - goalSetId: string
  - id: RemoteRepoRef
  - providerId: string
  - state: SdmGoalState
  - Optional url?: string
Returns SdmGoalMessage

constructSdmGoalImplementation

constructSdmGoalImplementation(gi: GoalImplementation, registration: string): SdmGoalFulfillment

- Defined in lib/api-helper/goal/storeGoals.ts:112
Parameters
- gi: GoalImplementation
- registration: string
Returns SdmGoalFulfillment

descriptionFromState

descriptionFromState(goal: Goal, state: SdmGoalState, goalEvent?: SdmGoalEvent): string

- Defined in lib/api-helper/goal/storeGoals.ts:224
Parameters
- goal: Goal
- state: SdmGoalState
- Optional goalEvent: SdmGoalEvent
Returns string

environmentFromGoal

environmentFromGoal(goal: Goal): string

- Defined in lib/api-helper/goal/storeGoals.ts:52
Parameters
- goal: Goal
Returns string

eventToMessage

eventToMessage(event: SdmGoalEvent): SdmGoalMessage

- Defined in lib/api-helper/goal/storeGoals.ts:96
Parameters
- event: SdmGoalEvent
Returns SdmGoalMessage

goalCorrespondsToSdmGoal

goalCorrespondsToSdmGoal(goal: Goal, sdmGoal: SdmGoalKey): boolean

- Defined in lib/api-helper/goal/storeGoals.ts:108
Parameters
- goal: Goal
- sdmGoal: SdmGoalKey
Returns boolean

goalSetState

goalSetState(goals: Array<Pick<SdmGoalMessage, "name" | "state">>): SdmGoalState

- Defined in lib/api-helper/goal/storeGoals.ts:307
Parameters
- goals: Array<Pick<SdmGoalMessage, "name" | "state">>
Returns SdmGoalState

storeGoal

storeGoal(ctx: HandlerContext, sdmGoal: SdmGoalMessage): Promise<SdmGoalMessage>

- Defined in lib/api-helper/goal/storeGoals.ts:199
Parameters
- ctx: HandlerContext
- sdmGoal: SdmGoalMessage
Returns Promise<SdmGoalMessage>

storeGoalSet

storeGoalSet(ctx: HandlerContext, goalSet: SdmGoalSetMessage): Promise<void>

- Defined in lib/api-helper/goal/storeGoals.ts:294
Parameters
- ctx: HandlerContext
- goalSet: SdmGoalSetMessage
Returns Promise<void>

updateGoal

updateGoal(ctx: HandlerContext, before: SdmGoalEvent, params: UpdateSdmGoalParams): Promise<void>

- Defined in lib/api-helper/goal/storeGoals.ts:67
Parameters
- ctx: HandlerContext
- before: SdmGoalEvent
- params: UpdateSdmGoalParams
Returns Promise<void>

Generated using TypeDoc