Class Pakk

Readonlycontext

Readonlyoptions

createUpdatedPackageJson

• createUpdatedPackageJson(
      packageJsonKind: PackageJsonKindType,
  ): Promise<{ path: string; updatedPackageJson: Replace }>

  Will return a path adjusted packageJson object based on the content of the workspace for both the SOURCE and DISTRIBUTION packageJson files.

  And also returns the path where it should be written to.

  Parameters

  • packageJsonKind: PackageJsonKindType

  Returns Promise<{ path: string; updatedPackageJson: Replace }>

examinePackage

• examinePackage(
      workspacePackage?: WorkspacePackage,
  ): Promise<PackageExaminationResult>

  1st step, examining the package. This step does not write anything. It can be done before the build takes place as it's only supposed to take a look at your source code.

  Parameters

  • workspacePackage: WorkspacePackage = ...

  Returns Promise<PackageExaminationResult>

getLogger

• getLogger(): Logger<unknown>

  Returns Logger<unknown>

getTargetPackageJsonKinds

• getTargetPackageJsonKinds(): PackageJsonKindType[]

  Returns PackageJsonKindType[]

StaticprimaryLibraryFormat

• primaryLibraryFormat(packageJson: Replace): LibraryFormats

  Parameters

  • packageJson: Replace

  Returns LibraryFormats

StaticwithContext

• withContext(
      manualContext: Pick<PakkContext, "fileName" | "formats">,
      rawOptions?: PakkOptions,
  ): Promise<Pakk>

  Parameters

  • manualContext: Pick<PakkContext, "fileName" | "formats">
  • OptionalrawOptions: PakkOptions

  Returns Promise<Pakk>