Header menu logo arc-validate

Config Type

Record fields

Record Field Description

ConfigFilePath

Full Usage: ConfigFilePath

Field type: string
Field type: string

IndexLastUpdated

Full Usage: IndexLastUpdated

Field type: DateTimeOffset
Field type: DateTimeOffset

PackageCacheFolder

Full Usage: PackageCacheFolder

Field type: string
Field type: string

PackageIndex

Full Usage: PackageIndex

Field type: ValidationPackageIndex[]
Field type: ValidationPackageIndex[]

Static members

Static member Description

Config.create (packageIndex, indexLastUpdated, packageCacheFolder, configFilePath)

Full Usage: Config.create (packageIndex, indexLastUpdated, packageCacheFolder, configFilePath)

Parameters:
Returns: Config
packageIndex : ValidationPackageIndex[]
indexLastUpdated : DateTimeOffset
packageCacheFolder : string
configFilePath : string
Returns: Config

Config.exists ?Path

Full Usage: Config.exists ?Path

Parameters:
    ?Path : string

Returns: bool
?Path : string
Returns: bool

Config.get (?Path, ?CacheFolder, ?Token)

Full Usage: Config.get (?Path, ?CacheFolder, ?Token)

Parameters:
    ?Path : string
    ?CacheFolder : string
    ?Token : string

Returns: Config
?Path : string
?CacheFolder : string
?Token : string
Returns: Config

Config.getIndexedPackageByNameAndVersion packageName semverString config

Full Usage: Config.getIndexedPackageByNameAndVersion packageName semverString config

Parameters:
    packageName : string
    semverString : string
    config : Config

Returns: ValidationPackageIndex
packageName : string
semverString : string
config : Config
Returns: ValidationPackageIndex

Config.getIndexedPackagesByName packageName config

Full Usage: Config.getIndexedPackagesByName packageName config

Parameters:
    packageName : string
    config : Config

Returns: ValidationPackageIndex[]
packageName : string
config : Config
Returns: ValidationPackageIndex[]

Config.getLatestPackage packageName config

Full Usage: Config.getLatestPackage packageName config

Parameters:
    packageName : string
    config : Config

Returns: ValidationPackageIndex
packageName : string
config : Config
Returns: ValidationPackageIndex

Config.indexContainsPackage packageName semverString config

Full Usage: Config.indexContainsPackage packageName semverString config

Parameters:
    packageName : string
    semverString : string
    config : Config

Returns: bool
packageName : string
semverString : string
config : Config
Returns: bool

Config.indexContainsPackages packageName config

Full Usage: Config.indexContainsPackages packageName config

Parameters:
    packageName : string
    config : Config

Returns: bool
packageName : string
config : Config
Returns: bool

Config.initDefault (?Token, ?ConfigPath, ?CacheFolder)

Full Usage: Config.initDefault (?Token, ?ConfigPath, ?CacheFolder)

Parameters:
    ?Token : string
    ?ConfigPath : string
    ?CacheFolder : string

Returns: Config
?Token : string
?ConfigPath : string
?CacheFolder : string
Returns: Config

Config.read ?Path

Full Usage: Config.read ?Path

Parameters:
    ?Path : string

Returns: Config
?Path : string
Returns: Config

Config.tryGetIndexedPackageByNameAndVersion packageName semverString config

Full Usage: Config.tryGetIndexedPackageByNameAndVersion packageName semverString config

Parameters:
    packageName : string
    semverString : string
    config : Config

Returns: ValidationPackageIndex option
packageName : string
semverString : string
config : Config
Returns: ValidationPackageIndex option

Config.tryGetLatestPackage packageName config

Full Usage: Config.tryGetLatestPackage packageName config

Parameters:
    packageName : string
    config : Config

Returns: ValidationPackageIndex option
packageName : string
config : Config
Returns: ValidationPackageIndex option

Config.withIndex index config

Full Usage: Config.withIndex index config

Parameters:
Returns: Config
index : ValidationPackageIndex[]
config : Config
Returns: Config

Config.write ?Path

Full Usage: Config.write ?Path

Parameters:
    ?Path : string

Returns: Config -> unit
?Path : string
Returns: Config -> unit

Type something to start searching.