Interface ImportOptions

Hierarchy

ImportOptions

Index

Properties

Methods

Properties

Optional dir

dir?: string

The path to the app to be imported

Optional interactive

interactive?: boolean

Whether to use sensible defaults or prompt the user visually

Optional outDir

outDir?: string

The path to the directory containing generated distributables

Methods

Optional confirmImport

confirmImport(): Promise<boolean>

- Defined in packages/api/core/src/api/import.ts:35
An async function that returns true or false in order to confirm the start of importing

Returns Promise<boolean>

Optional shouldContinueOnExisting

shouldContinueOnExisting(): Promise<boolean>

- Defined in packages/api/core/src/api/import.ts:40
An async function that returns whether the import should continue if it looks like a forge project already

Returns Promise<boolean>

Optional shouldRemoveDependency

shouldRemoveDependency(dependency: string, explanation: string): Promise<boolean>

- Defined in packages/api/core/src/api/import.ts:44
An async function that returns whether the given dependency should be removed

Parameters
- dependency: string
- explanation: string
Returns Promise<boolean>

Optional shouldUpdateScript

shouldUpdateScript(scriptName: string, newValue: string): Promise<boolean>

- Defined in packages/api/core/src/api/import.ts:48
An async function that returns whether the given script should be overridden with a forge one

Parameters
- scriptName: string
- newValue: string
Returns Promise<boolean>