LockFile (Paket)

LockFile Type

Namespace: Paket
Assembly: Paket.Core.dll
Base Type: obj

Allows to parse and analyze paket.lock files.

Constructors

Constructor	Description
`LockFile(fileName, groups)` Full Usage: `LockFile(fileName, groups)` Parameters: fileName : `string` groups : `Map<GroupName, LockFileGroup>` Returns: `LockFile`	fileName : `string` groups : `Map<GroupName, LockFileGroup>` Returns: `LockFile`

Instance members

Static members

Static member	Description
`LockFile.LoadFrom(lockFileName)` Full Usage: `LockFile.LoadFrom(lockFileName)` Parameters: lockFileName : `string` Returns: `LockFile`	Parses a paket.lock file from file lockFileName : `string` Returns: `LockFile`
`LockFile.Parse(lockFileName, lines)` Full Usage: `LockFile.Parse(lockFileName, lines)` Parameters: lockFileName : `string` lines : `string[]` Returns: `LockFile`	Parses a paket.lock file from lines lockFileName : `string` lines : `string[]` Returns: `LockFile`

Instance member	Description
`this.CheckIfPackageExistsInAnyGroup` Full Usage: `this.CheckIfPackageExistsInAnyGroup` Parameters: packageName : `PackageName` Returns: `string`	packageName : `PackageName` Returns: `string`
`this.FailPackageNotFoundInLockFile` Full Usage: `this.FailPackageNotFoundInLockFile` Parameters: package : `PackageName` context : `string` groupName : `GroupName` Returns: `'a` Type parameters: 'a	Raises the standard "package not found in paket.lock" error, including a hint about where else the package might be. package : `PackageName` context : `string` groupName : `GroupName` Returns: `'a`
`this.FileName` Full Usage: `this.FileName` Returns: `string`	Returns: `string`
`this.GetAllDependenciesOf` Full Usage: `this.GetAllDependenciesOf` Parameters: groupName : `GroupName` package : `PackageName` context : `string` Returns: `HashSet<PackageName>`	Gets all dependencies of the given package groupName : `GroupName` package : `PackageName` context : `string` Returns: `HashSet<PackageName>`
`this.GetAllDependenciesOfSafe` Full Usage: `this.GetAllDependenciesOfSafe` Parameters: groupName : `GroupName` package : `PackageName` Returns: `HashSet<PackageName> option`	Gets all dependencies of the given package in the given group. groupName : `GroupName` package : `PackageName` Returns: `HashSet<PackageName> option`
`this.GetAllNormalizedDependenciesOf` Full Usage: `this.GetAllNormalizedDependenciesOf` Parameters: groupName : `GroupName` package : `PackageName` context : `string` Returns: `HashSet<GroupName * PackageName>`	Gets all dependencies of the given package groupName : `GroupName` package : `PackageName` context : `string` Returns: `HashSet<GroupName * PackageName>`
`this.GetDependencyLookupTable` Full Usage: `this.GetDependencyLookupTable` Returns: `Map<(GroupName * PackageName), Set<PackageName>>`	Returns: `Map<(GroupName * PackageName), Set<PackageName>>`
`this.GetDirectDependenciesOfSafe` Full Usage: `this.GetDirectDependenciesOfSafe` Parameters: groupName : `GroupName` package : `PackageName` context : `string` Returns: `Set<PackageName>`	Gets only direct dependencies of the given package in the given group. groupName : `GroupName` package : `PackageName` context : `string` Returns: `Set<PackageName>`
`this.GetGroup` Full Usage: `this.GetGroup` Parameters: groupName : `GroupName` Returns: `LockFileGroup`	groupName : `GroupName` Returns: `LockFileGroup`
`this.GetGroupedResolution` Full Usage: `this.GetGroupedResolution` Returns: `Map<(GroupName * PackageName), PackageInfo>`	Returns: `Map<(GroupName * PackageName), PackageInfo>`
`this.GetInstalledPackageModel` Full Usage: `this.GetInstalledPackageModel` Parameters: arg0 : `QualifiedPackageName` Returns: `InstallModel`	arg0 : `QualifiedPackageName` Returns: `InstallModel`
`this.GetOrderedPackageHull` Full Usage: `this.GetOrderedPackageHull` Parameters: groupName : `GroupName` referencesFile : `ReferencesFile` Returns: `((GroupName * PackageName) * PackageInstallSettings * Set<PackageName>) list * Set<ResolvedPackage>`	groupName : `GroupName` referencesFile : `ReferencesFile` Returns: `((GroupName * PackageName) * PackageInstallSettings * Set<PackageName>) list * Set<ResolvedPackage>`
`this.GetOrderedPackageHull` Full Usage: `this.GetOrderedPackageHull` Parameters: groupName : `GroupName` referencesFile : `ReferencesFile` targetProfileOpt : `TargetProfile option` Returns: `((GroupName * PackageName) * PackageInstallSettings * Set<PackageName>) list * Set<ResolvedPackage>`	groupName : `GroupName` referencesFile : `ReferencesFile` targetProfileOpt : `TargetProfile option` Returns: `((GroupName * PackageName) * PackageInstallSettings * Set<PackageName>) list * Set<ResolvedPackage>`
`this.GetPackageHull` Full Usage: `this.GetPackageHull` Parameters: groupName : `GroupName` referencesFile : `ReferencesFile` Returns: `Dictionary<(GroupName * PackageName), PackageInstallSettings>`	groupName : `GroupName` referencesFile : `ReferencesFile` Returns: `Dictionary<(GroupName * PackageName), PackageInstallSettings>`
`this.GetPackageHull` Full Usage: `this.GetPackageHull` Parameters: referencesFile : `ReferencesFile` Returns: `Dictionary<(GroupName * PackageName), PackageInstallSettings>`	referencesFile : `ReferencesFile` Returns: `Dictionary<(GroupName * PackageName), PackageInstallSettings>`
`this.GetPackageHullSafe` Full Usage: `this.GetPackageHullSafe` Parameters: referencesFile : `ReferencesFile` groupName : `GroupName` Returns: `Result<Set<PackageName>, DomainMessage>`	referencesFile : `ReferencesFile` groupName : `GroupName` Returns: `Result<Set<PackageName>, DomainMessage>`
`this.GetRemoteReferencedPackages` Full Usage: `this.GetRemoteReferencedPackages` Parameters: referencesFile : `ReferencesFile` installGroup : `InstallGroup` Returns: `PackageInstallSettings list`	referencesFile : `ReferencesFile` installGroup : `InstallGroup` Returns: `PackageInstallSettings list`
`this.GetResolvedPackages` Full Usage: `this.GetResolvedPackages` Returns: `Map<GroupName, PackageInfo list>`	Returns: `Map<GroupName, PackageInfo list>`
`this.GetTopLevelDependencies` Full Usage: `this.GetTopLevelDependencies` Parameters: groupName : `GroupName` Returns: `Map<PackageName, PackageInfo>`	groupName : `GroupName` Returns: `Map<PackageName, PackageInfo>`
`this.GetTransitiveDependencies` Full Usage: `this.GetTransitiveDependencies` Parameters: groupName : `GroupName` Returns: `Set<PackageName>`	groupName : `GroupName` Returns: `Set<PackageName>`
`this.Groups` Full Usage: `this.Groups` Returns: `Map<GroupName, LockFileGroup>`	Returns: `Map<GroupName, LockFileGroup>`
`this.InstalledPackages` Full Usage: `this.InstalledPackages` Returns: `(GroupName * PackageName * SemVerInfo) list`	Returns a list of packages inside the lockfile with their group and version number Returns: `(GroupName * PackageName * SemVerInfo) list`
`this.ResolveFrameworksForScriptGeneration` Full Usage: `this.ResolveFrameworksForScriptGeneration` Returns: `Lazy<FrameworkIdentifier seq>`	Returns: `Lazy<FrameworkIdentifier seq>`
`this.RootPath` Full Usage: `this.RootPath` Returns: `string`	Returns: `string`
`this.Save` Full Usage: `this.Save` Returns: `bool`	Updates the paket.lock file with the analyzed dependencies from the paket.dependencies file. Returns: `bool`