API (arc-validate)

API Type

Namespace: ARCValidationPackages
Assembly: ARCValidationPackages.dll
Base Type: obj

Static members

Static member	Description
`API.GetSyncedConfigAndCache(?ConfigPath, ?CacheFolder, ?CacheFileName, ?Token)` Full Usage: `API.GetSyncedConfigAndCache(?ConfigPath, ?CacheFolder, ?CacheFileName, ?Token)` Parameters: ?ConfigPath : `string` ?CacheFolder : `string` ?CacheFileName : `string` ?Token : `string` Returns: `Result<(Config * PackageCache), GetSyncedConfigAndCacheError>`	?ConfigPath : `string` ?CacheFolder : `string` ?CacheFileName : `string` ?Token : `string` Returns: `Result<(Config * PackageCache), GetSyncedConfigAndCacheError>`
`API.InstallPackage(config, cache, packageName, ?SemVer, ?Verbose, ?Token)` Full Usage: `API.InstallPackage(config, cache, packageName, ?SemVer, ?Verbose, ?Token)` Parameters: config : `Config` cache : `PackageCache` packageName : `string` ?SemVer : `string` ?Verbose : `bool` ?Token : `string` Returns: `Result<string, PackageInstallError>`	config : `Config` cache : `PackageCache` packageName : `string` ?SemVer : `string` ?Verbose : `bool` ?Token : `string` Returns: `Result<string, PackageInstallError>`
`API.ListCachedPackages(cache, ?Verbose)` Full Usage: `API.ListCachedPackages(cache, ?Verbose)` Parameters: cache : `PackageCache` ?Verbose : `bool` Returns: `Result<ARCValidationPackage seq, string>`	cache : `PackageCache` ?Verbose : `bool` Returns: `Result<ARCValidationPackage seq, string>`
`API.ListIndexedPackages(config, ?Verbose)` Full Usage: `API.ListIndexedPackages(config, ?Verbose)` Parameters: config : `Config` ?Verbose : `bool` Returns: `Result<ValidationPackageIndex list, string>`	config : `Config` ?Verbose : `bool` Returns: `Result<ValidationPackageIndex list, string>`
`API.SaveAndCachePackage(cache, indexedPackage, ?CacheFolder, ?Token)` Full Usage: `API.SaveAndCachePackage(cache, indexedPackage, ?CacheFolder, ?Token)` Parameters: cache : `PackageCache` indexedPackage : `ValidationPackageIndex` ?CacheFolder : `string` ?Token : `string` Returns: `Result<string, PackageInstallError>`	cache : `PackageCache` indexedPackage : `ValidationPackageIndex` ?CacheFolder : `string` ?Token : `string` Returns: `Result<string, PackageInstallError>`
`API.UninstallPackage(cache, packageName, ?SemVer, ?Verbose)` Full Usage: `API.UninstallPackage(cache, packageName, ?SemVer, ?Verbose)` Parameters: cache : `PackageCache` packageName : `string` ?SemVer : `string` ?Verbose : `bool` Returns: `Result<string, PackageUninstallError>`	cache : `PackageCache` packageName : `string` ?SemVer : `string` ?Verbose : `bool` Returns: `Result<string, PackageUninstallError>`
`API.UpdateIndex(config, ?Token)` Full Usage: `API.UpdateIndex(config, ?Token)` Parameters: config : `Config` ?Token : `string` Returns: `Result<Config, UpdateIndexError>`	config : `Config` ?Token : `string` Returns: `Result<Config, UpdateIndexError>`