RemoteParameter
A portable description of a command argument or option.
- Kind:
Class - Namespace: Repl.Remote
- Assembly:
Repl.Remote - Source: src/Repl.Remote/RemoteParameter.cs
Signature
Section titled “Signature”public sealed record RemoteParameter : IEquatable<RemoteParameter>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<RemoteParameter>
Constructors
Section titled “Constructors”RemoteParameter(string, string, bool, string?, JsonElement, IReadOnlyList<string>)
Section titled “RemoteParameter(string, string, bool, string?, JsonElement, IReadOnlyList<string>)”A portable description of a command argument or option.
public RemoteParameter(string Name, string Kind, bool Required, string? Description, JsonElement Schema, IReadOnlyList<string> Aliases)Parameters
Section titled “Parameters”Name(string): Canonical invocation key.Kind(string): Either argument or option.Required(bool): Whether a value is required.Description(string): User-facing help.Schema(JsonElement): JSON Schema Draft 7 describing the value.Aliases(IReadOnlyList<string>): CLI aliases for this parameter.
Properties
Section titled “Properties”Aliases
Section titled “Aliases”CLI aliases for this parameter.
public IReadOnlyList<string> Aliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
Description
Section titled “Description”User-facing help.
public string? Description { get; init; }Returns
Section titled “Returns”Either argument or option.
public string Kind { get; init; }Returns
Section titled “Returns”Canonical invocation key.
public string Name { get; init; }Returns
Section titled “Returns”Required
Section titled “Required”Whether a value is required.
public bool Required { get; init; }Returns
Section titled “Returns”Schema
Section titled “Schema”JSON Schema Draft 7 describing the value.
public JsonElement Schema { get; init; }