Module "operations/generate/generatorUtils"

generate

• generate<P, PARAMS>(startingPoint: Promise<Project> | Project, ctx: HandlerContext, credentials: ProjectOperationCredentials, editor: AnyProjectEditor, persist: ProjectPersister<P>, targetId: RepoId, params?: PARAMS, afterAction?: ProjectAction<PARAMS, P>, directoryManager?: DirectoryManager): Promise<ActionResult<P>>

• Generate a new project given the starting point project. Do not change the starting point. May perform additional action after persisting the project.

  Type parameters

  • P: Project = Project

  • PARAMS = object

  Parameters

  • startingPoint: Promise<Project> | Project

  • ctx: HandlerContext

  • credentials: ProjectOperationCredentials

  • editor: AnyProjectEditor

    editor that does the actual transformation

  • persist: ProjectPersister<P>

    persist function to persist the new project: for example, to GitHub

  • targetId: RepoId

    id of target repo for persistence

  • Optional params: PARAMS

    optional parameters to be passed to persister

  • Optional afterAction: ProjectAction<PARAMS, P>

    action to perform after project persistence.

  • Default value directoryManager: DirectoryManager = TmpDirectoryManager

    finds a directory for the new project; defaults to tmp

  Returns Promise<ActionResult<P>>