Logo Paket

DependenciesFile Type

Allows to parse and analyze paket.dependencies files.

Constructors

Constructor Description

DependenciesFile(fileName, groups, textRepresentation)

Full Usage: DependenciesFile(fileName, groups, textRepresentation)

Parameters:
Returns: DependenciesFile
fileName : string
groups : Map<GroupName, DependenciesGroup>
textRepresentation : string[]
Returns: DependenciesFile

Instance members

Instance member Description

this.Add

Full Usage: this.Add

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
installSettings : InstallSettings
kind : PackageRequirementKind
Returns: DependenciesFile

this.Add

Full Usage: this.Add

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
installSettings : InstallSettings
Returns: DependenciesFile

this.Add

Full Usage: this.Add

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
Returns: DependenciesFile

this.Add

Full Usage: this.Add

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
versionRange : VersionRange
installSettings : InstallSettings
kind : PackageRequirementKind
Returns: DependenciesFile

this.Add

Full Usage: this.Add

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
versionRange : VersionRange
installSettings : InstallSettings
Returns: DependenciesFile

this.AddAdditionalPackage

Full Usage: this.AddAdditionalPackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
vr : VersionStrategy
settings : InstallSettings
kind : PackageRequirementKind
Returns: DependenciesFile

this.AddAdditionalPackage

Full Usage: this.AddAdditionalPackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
settings : InstallSettings
kind : PackageRequirementKind
Returns: DependenciesFile

this.AddAdditionalPackage

Full Usage: this.AddAdditionalPackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
versionRequirement : VersionRequirement
resolverStrategy : ResolverStrategy option
settings : InstallSettings
kind : PackageRequirementKind
?pinDown : bool
Returns: DependenciesFile

this.AddFixedPackage

Full Usage: this.AddFixedPackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
Returns: DependenciesFile

this.AddFixedPackage

Full Usage: this.AddFixedPackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
settings : InstallSettings
Returns: DependenciesFile

this.AddGit

Full Usage: this.AddGit

Parameters:
    groupName : GroupName
    repository : string
    version : string

Returns: DependenciesFile
groupName : GroupName
repository : string
version : string
Returns: DependenciesFile

this.AddGit

Full Usage: this.AddGit

Parameters:
Returns: DependenciesFile
groupName : GroupName
repository : string
Returns: DependenciesFile

this.AddGithub

Full Usage: this.AddGithub

Parameters:
    groupName : GroupName
    repository : string
    file : string
    version : string

Returns: DependenciesFile
groupName : GroupName
repository : string
file : string
version : string
Returns: DependenciesFile

this.AddGithub

Full Usage: this.AddGithub

Parameters:
Returns: DependenciesFile
groupName : GroupName
repository : string
Returns: DependenciesFile

this.CheckIfPackageExistsInAnyGroup

Full Usage: this.CheckIfPackageExistsInAnyGroup

Parameters:
Returns: string
packageName : PackageName
Returns: string

this.Directory

Full Usage: this.Directory

Returns: string

The full path of the directory that containes this paket.dependencies file

Returns: string

this.DirectoryInfo

Full Usage: this.DirectoryInfo

Returns: DirectoryInfo option

Directory info for the parent of this paket.dependencies file

Returns: DirectoryInfo option

this.FileInfo

Full Usage: this.FileInfo

Returns: FileInfo option
Returns: FileInfo option

this.FileName

Full Usage: this.FileName

Returns: string
Returns: string

this.FindLockFile

Full Usage: this.FindLockFile

Returns: FileInfo

Find the matching lock file to a dependencies file

Returns: FileInfo

this.GetDependenciesInGroup

Full Usage: this.GetDependenciesInGroup

Parameters:
Returns: Map<PackageName, VersionRequirement>

Returns all direct NuGet dependencies in the given group.

groupName : GroupName
Returns: Map<PackageName, VersionRequirement>

this.GetGroup

Full Usage: this.GetGroup

Parameters:
Returns: DependenciesGroup
groupName : GroupName
Returns: DependenciesGroup

this.GetPackage

Full Usage: this.GetPackage

Parameters:
Returns: PackageRequirement
groupName : GroupName
name : PackageName
Returns: PackageRequirement

this.Groups

Full Usage: this.Groups

Returns: Map<GroupName, DependenciesGroup>

this.HasPackage

Full Usage: this.HasPackage

Parameters:
Returns: bool
groupName : GroupName
name : PackageName
Returns: bool

this.Lines

Full Usage: this.Lines

Returns: string[]
Returns: string[]

this.Remove

Full Usage: this.Remove

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
Returns: DependenciesFile

this.RemovePackage

Full Usage: this.RemovePackage

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
Returns: DependenciesFile

this.Resolve

Full Usage: this.Resolve

Parameters:
Returns: Map<GroupName, Resolved>
Type parameters: 'a
force : bool
getSha1 : Origin -> string -> string -> VersionRestriction -> string option -> string
getVersionF : PackageVersionsFunc
getPreferredVersionF : PreferredVersionsFunc
getPackageDetailsF : PackageDetailsFunc
getPackageRuntimeGraph : PackagesFolderGroupConfig option -> GroupName -> ResolvedPackage -> RuntimeGraph option
groupsToResolve : Map<GroupName, 'a>
updateMode : UpdateMode
Returns: Map<GroupName, Resolved>

this.RootPath

Full Usage: this.RootPath

Returns: string
Returns: string

this.Save

Full Usage: this.Save

this.SimplifyFrameworkRestrictions

Full Usage: this.SimplifyFrameworkRestrictions

Returns: DependenciesFile

this.TryGetPackage

Full Usage: this.TryGetPackage

Parameters:
Returns: PackageRequirement option
groupName : GroupName
name : PackageName
Returns: PackageRequirement option

this.UpdateFilteredPackageVersion

Full Usage: this.UpdateFilteredPackageVersion

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageFilter : PackageFilter
version : string
Returns: DependenciesFile

this.UpdatePackageVersion

Full Usage: this.UpdatePackageVersion

Parameters:
Returns: DependenciesFile
groupName : GroupName
packageName : PackageName
version : string
Returns: DependenciesFile

Static members

Static member Description

DependenciesFile.FindLocalfile(dependenciesFileName)

Full Usage: DependenciesFile.FindLocalfile(dependenciesFileName)

Parameters:
    dependenciesFileName : string

Returns: FileInfo
dependenciesFileName : string
Returns: FileInfo

DependenciesFile.FindLockfile(dependenciesFileName)

Full Usage: DependenciesFile.FindLockfile(dependenciesFileName)

Parameters:
    dependenciesFileName : string

Returns: FileInfo

Find the matching lock file to a dependencies file

dependenciesFileName : string
Returns: FileInfo

DependenciesFile.FromSource(source)

Full Usage: DependenciesFile.FromSource(source)

Parameters:
    source : string

Returns: DependenciesFile
source : string
Returns: DependenciesFile

DependenciesFile.FromSource(rootPath, source)

Full Usage: DependenciesFile.FromSource(rootPath, source)

Parameters:
    rootPath : string
    source : string

Returns: DependenciesFile
rootPath : string
source : string
Returns: DependenciesFile

DependenciesFile.ReadFromFile(fileName)

Full Usage: DependenciesFile.ReadFromFile(fileName)

Parameters:
    fileName : string

Returns: DependenciesFile
fileName : string
Returns: DependenciesFile

Type something to start searching.