Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @electron-forge/shared-types

Index

Modules

Interfaces

Type aliases

Type aliases

ElectronProcess

ElectronProcess: ChildProcess & { restarted: boolean }

ForgeArch

ForgeArch: ArchOption

ForgeConfig

ForgeConfig: Partial<Omit<ResolvedForgeConfig, "pluginInterface">>

ForgeConfigMaker

ForgeConfigMaker: IForgeResolvableMaker | IForgeMaker

ForgeConfigPlugin

ForgeConfigPlugin: IForgeResolvablePlugin | IForgePlugin

ForgeConfigPublisher

ForgeConfigPublisher: IForgeResolvablePublisher | IForgePublisher

ForgeHookFn

ForgeHookFn<Hook>: Hook extends keyof ForgeSimpleHookSignatures ? ForgeSimpleHookFn<Hook> : Hook extends keyof ForgeMutatingHookSignatures ? ForgeMutatingHookFn<Hook> : never

Type parameters

ForgeHookMap

ForgeHookMap: { [ S in ForgeHookName]?: ForgeHookFn<S> }

ForgeHookName

ForgeHookName: keyof ForgeSimpleHookSignatures & ForgeMutatingHookSignatures

ForgeListrTask

ForgeListrTask<T>: TaskWrapper<T, ListrDefaultRenderer>

Type parameters

  • T

ForgeListrTaskDefinition

ForgeListrTaskDefinition: ListrTask<never>

ForgeListrTaskFn

ForgeListrTaskFn<Ctx>: ListrTask<Ctx, ListrDefaultRenderer>["task"]

Type parameters

  • Ctx = any

ForgeMultiHookMap

ForgeMultiHookMap: { [ S in ForgeHookName]?: ForgeHookFn<S> | ForgeHookFn<S>[] }

ForgeMutatingHookFn

ForgeMutatingHookFn<Hook>: (forgeConfig: ResolvedForgeConfig, ...args: ForgeMutatingHookSignatures[Hook]) => Promise<ForgeMutatingHookSignatures[Hook][0] | undefined>

Type parameters

Type declaration

ForgePackagerOptions

ForgePackagerOptions: Omit<Options, "dir" | "arch" | "platform" | "out" | "electronVersion">

ForgePlatform

ForgePlatform: TargetPlatform

ForgeRebuildOptions

ForgeRebuildOptions: Omit<RebuildOptions, "buildPath" | "electronVersion" | "arch">

ForgeSimpleHookFn

ForgeSimpleHookFn<Hook>: (forgeConfig: ResolvedForgeConfig, ...args: ForgeSimpleHookSignatures[Hook]) => Promise<void>

Type parameters

Type declaration

InnerStartResult

InnerStartResult: ElectronProcess | string | string[] | false

PackagePerson

PackagePerson: undefined | string | { email?: string; name: string; url?: string }

StartResult

StartResult: InnerStartResult | { result: InnerStartResult; tasks: ForgeListrTaskDefinition[] }