Class ProjectPrompter

Hierarchy

Prompter
- ProjectPrompter

Index

Constructors

Properties

interactive prompts

Methods

compileMode contractCrates defineContract deployment projectMode projectName projectRoot renameContract select text undefineContract untilDone

Constructors

constructor

new ProjectPrompter(prompts?, interactive?): ProjectPrompter
Parameters
- prompts: {
  prompt: any;
  } = Prompts
  - prompt: any
- interactive: boolean = true
Returns ProjectPrompter
Inherited from Prompter.constructor
- Defined in tools.ts:316

Properties

interactive

interactive: boolean = true

prompts

prompts: {
prompt: any;
} = Prompts

Type declaration

prompt: any

Methods

compileMode

compileMode(__namedParameters?, prompts?): Promise<"docker" | "podman" | "raw">
Parameters
- __namedParameters: Partial<SystemTools> = {}
- prompts: {
  prompt: any;
  } = Prompts
  - prompt: any
Returns Promise<"docker" | "podman" | "raw">
- Defined in tools.ts:482

contractCrates

contractCrates(name): Promise<Record<string, Partial<UploadedCode>>>
Parameters
- name: string
Returns Promise<Record<string, Partial<UploadedCode>>>
- Defined in tools.ts:428

defineContract

defineContract(state): Promise<void>
Parameters
- state: Record<string, any>
Returns Promise<void>
- Defined in tools.ts:442

deployment

deployment(store): Promise<string>
Parameters
- store: DeployStore & {
  root?: Path;
  }
Returns Promise<string>
- Defined in tools.ts:374

projectMode

projectMode(prompts?): Promise<number>
Parameters
- prompts: typeof prompts = Prompts
Returns Promise<number>
- Defined in tools.ts:421

projectName

projectName(): Promise<string>
Returns Promise<string>
- Defined in tools.ts:384

projectRoot

projectRoot(name): Promise<Path>
Parameters
- name: string | Promise<string>
Returns Promise<Path>
- Defined in tools.ts:397

renameContract

renameContract(state): Promise<void>
Parameters
- state: Record<string, any>
Returns Promise<void>
- Defined in tools.ts:467

select

select<T>(message, choices): Promise<any>
Type Parameters
- T
Parameters
- message: string
- choices: T[]
Returns Promise<any>
Inherited from Prompter.select
- Defined in tools.ts:345

text

text<T>(message, __namedParameters?): Promise<string>
Type Parameters
- T
Parameters
- message: string
- __namedParameters: {
  clean?: ((x) => string);
  valid?: ((x) => boolean);
  } = {}
  - Optional clean?: ((x) => string)
    - (x): string
      Parameters
      x: string
      Returns string
  - Optional valid?: ((x) => boolean)
    - (x): boolean
      Parameters
      x: string
      Returns boolean
Returns Promise<string>
Inherited from Prompter.text
- Defined in tools.ts:321

undefineContract

undefineContract(state): Promise<void>
Parameters
- state: Record<string, any>
Returns Promise<void>
- Defined in tools.ts:456

untilDone

untilDone<S>(state, selector): Promise<S>
Type Parameters
- S
Parameters
- state: S
- selector: ((state) => Function | Promise<Function>)
  - - (state): Function | Promise<Function>
    - Parameters
      state: S
      Returns Function | Promise<Function>
Returns Promise<S>
Inherited from Prompter.untilDone
- Defined in tools.ts:360

Generated using TypeDoc