Table of Contents

Class ParamArg

Namespace
Invex.Atom.Build.Args
Assembly
Invex.Atom.Build.dll

Represents a parameter argument, which provides a configurable value to a build target.

public sealed record ParamArg : IArg
Inheritance
object
ParamArg
Implements

Examples

For the command atom Build --configuration Release, a ParamArg would be created where ArgName is "--configuration", ParamName is "Configuration", and ParamValue is "Release".

Remarks

The ParamName must match a parameter defined in the IBuildDefinition.

Constructors

ParamArg(string, string, string)

Represents a parameter argument, which provides a configurable value to a build target.

public ParamArg(string ArgName, string ParamName, string ParamValue)

Parameters

ArgName string

The name of the argument as specified on the command line (e.g., "--version").

ParamName string

The canonical name of the parameter as defined in the build (e.g., "Version").

ParamValue string

The value provided for the parameter.

Examples

For the command atom Build --configuration Release, a ParamArg would be created where ArgName is "--configuration", ParamName is "Configuration", and ParamValue is "Release".

Remarks

The ParamName must match a parameter defined in the IBuildDefinition.

Properties

ArgName

The name of the argument as specified on the command line (e.g., "--version").

public string ArgName { get; init; }

Property Value

string

ParamName

The canonical name of the parameter as defined in the build (e.g., "Version").

public string ParamName { get; init; }

Property Value

string

ParamValue

The value provided for the parameter.

public string ParamValue { get; init; }

Property Value

string