Header menu logo arc-validate

ARCValidationPackage Type

represents the locally installed version of a validation package, e.g. the path to the local file and the date it was cached.

Record fields

Record Field Description

CacheDate

Full Usage: CacheDate

Field type: DateTimeOffset
Field type: DateTimeOffset

FileName

Full Usage: FileName

Field type: string
Field type: string

LocalPath

Full Usage: LocalPath

Field type: string
Field type: string

Metadata

Full Usage: Metadata

Field type: ValidationPackageMetadata
Field type: ValidationPackageMetadata

Instance members

Instance member Description

this.PrettyPrint

Full Usage: this.PrettyPrint

Returns: string
Returns: string

Static members

Static member Description

ARCValidationPackage.create (fileName, cacheDate, localPath, metadata)

Full Usage: ARCValidationPackage.create (fileName, cacheDate, localPath, metadata)

Parameters:
Returns: ARCValidationPackage
fileName : string
cacheDate : DateTimeOffset
localPath : string
metadata : ValidationPackageMetadata
Returns: ARCValidationPackage

ARCValidationPackage.getSemanticVersionString vp

Full Usage: ARCValidationPackage.getSemanticVersionString vp

Parameters:
Returns: string
vp : ARCValidationPackage
Returns: string

ARCValidationPackage.ofPackageIndex (packageIndex, ?Date, ?CacheFolder)

Full Usage: ARCValidationPackage.ofPackageIndex (packageIndex, ?Date, ?CacheFolder)

Parameters:
    packageIndex : ValidationPackageIndex - The input package index entry
    ?Date : DateTimeOffset - Optional. The date to set the CacheDate to. Defaults to the current date.
    ?CacheFolder : string

Returns: ARCValidationPackage

Creates a new ARCValidationPackage from a ValidationPackageIndex, with the CacheDate set to the current or optionally a custom date, and the LocalPath set to the default cache folder or custom folder.

packageIndex : ValidationPackageIndex

The input package index entry

?Date : DateTimeOffset

Optional. The date to set the CacheDate to. Defaults to the current date.

?CacheFolder : string
Returns: ARCValidationPackage

ARCValidationPackage.ofPackageName (packageName, ?Date, ?Path)

Full Usage: ARCValidationPackage.ofPackageName (packageName, ?Date, ?Path)

Parameters:
Returns: ARCValidationPackage

Creates a new ARCValidationPackage from a package name only, with the CacheDate set to the current or optionally a custom date, and the LocalPath set to the default cache folder or custom folder.

packageName : string

?Date : DateTimeOffset

?Path : string

Returns: ARCValidationPackage

ARCValidationPackage.updateCacheDate date package

Full Usage: ARCValidationPackage.updateCacheDate date package

Parameters:
Returns: ARCValidationPackage

returns a copy of the input ARCValidationPackage with the CacheDate set to the given date.

date : DateTimeOffset

The date to set the CacheDate to

package : ARCValidationPackage

The input package

Returns: ARCValidationPackage

Type something to start searching.