Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PackMan

An object representing the Windows 96 package manager.

Hierarchy

  • PackMan

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PackMan(): any

  • Returns any

Properties

logger

logger: PkMgrLogger

The logger used to log messages.

packageCache

packageCache: Package[]

The currently loaded package metadatas.

repoCache

repoCache: PackageRepository[]

A cache containing all loaded repositories.

srcConfig

srcConfig: PkMgrSourcesList

The parsed sources list to be used by the package manager.

unpackPathMappings

unpackPathMappings: { dest: String; source: String }[]

Path unpack mappings.

Methods

checkFS

  • checkFS(): Promise<void>

  • Checks the filesystem for package manager.

    Returns Promise<void>

checkFeatures

  • checkFeatures(pkg: Package): Promise<string[]>

  • Checks the required features of a package.

    Parameters

    • pkg: Package

      The package to check for.

    Returns Promise<string[]>

    Missing features.

getPackage

  • getPackage(packageName: String): Package

  • Gets a package by name.

    Parameters

    • packageName: String

      The package name.

    Returns Package

    The package.

getPackageInstallState

  • getPackageInstallState(packageName: String): Promise<"NOT_INSTALLED" | "UPGRADEABLE" | "INSTALLED" | "BROKEN">

  • Gets the install state for a package.

    Parameters

    • packageName: String

      The package name of the package to query install state for.

    Returns Promise<"NOT_INSTALLED" | "UPGRADEABLE" | "INSTALLED" | "BROKEN">

getPackagesByCategory

  • getPackagesByCategory(cat: String): Package[]

  • Gets all packages by category.

    Parameters

    • cat: String

      The category to filter with.

    Returns Package[]

    The results.

getSourceIndexFromId

  • getSourceIndexFromId(id: string): Number

  • Resolves a source index from id.

    Parameters

    • id: string

      The id.

    Returns Number

installPackage

  • Installs a package.

    Parameters

    Returns Promise<void>

onfailure

  • onfailure(e: { code: String; e: Error }): void

  • Executed on failure.

    Parameters

    • e: { code: String; e: Error }
      • code: String
      • e: Error

    Returns void

performChecks

  • performChecks(): Promise<void>

  • [internal] Performs Package Manager checks.

    Returns Promise<void>

readSources

  • readSources(): Promise<boolean>

  • Reads the sources file and returns whether it completed successfully.

    Returns Promise<boolean>

    A value indicating whether the source reading has succeeded.

reloadPackageCache

  • reloadPackageCache(): Promise<void>

  • Reloads the package cache.

    Returns Promise<void>

removePackage

  • Removes a package.

    Parameters

    Returns Promise<void>

resolveSourceFromIndex

  • Resolves a source from index.

    Parameters

    • index: Number

      The index to use.

    Returns PackageRepository

unpackContentZip

  • unpackContentZip(binData: Uint8Array, pkg: Package, onprogress?: (params: OnProgressParams) => void): Promise<void>

  • Unpack content zip from package.

    Parameters

    Returns Promise<void>

walkDependencies

  • walkDependencies(pkgName: String): Promise<Package[]>

  • Gets an array of all dependencies to be installed for a certain package name.

    Parameters

    • pkgName: String

    Returns Promise<Package[]>

    The packages to install.

Generated using TypeDoc