CommandOption

@propertyWrapper
public class CommandOption<Value> : CommandOptionSpecification where Value : CommandArgumentValue

An option argument represents a named option and is used to pass a value to the command. It could have a default value, or could be omitted.

Example: -p 8 or --passes 8

  • Undocumented

    Declaration

    Swift

    public let shortName: String?

  • Undocumented

    Declaration

    Swift

    public let valueName: String

  • Undocumented

    Declaration

    Swift

    public let defaultValue: Value

  • Undocumented

    Declaration

    Swift

    public let validationRegex: String?

  • Declaration

    Swift

    public let description: String

  • Undocumented

    Declaration

    Swift

    public var defaultValueString: String { get }

  • Undocumented

    Declaration

    Swift

    public private(set) var name: String?

  • Undocumented

    Declaration

    Swift

    public var wrappedValue: Value { get set }

  • Undocumented

    Declaration

    Swift

    public init(short: String? = nil,
            valueName: String = "value",
            default: Value,
            regex: String? = nil,
            description: String)

  • Undocumented

    Declaration

    Swift

    public func bindValue(_ argument: String) throws

  • Undocumented

    Declaration

    Swift

    public func assignName(_ name: String)