RemoteCommand
A command’s canonical identity and discoverable parameters.
- Kind:
Class - Namespace: Repl.Remote
- Assembly:
Repl.Remote - Source: src/Repl.Remote/RemoteCommand.cs
Signature
Section titled “Signature”public sealed record RemoteCommand : IEquatable<RemoteCommand>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<RemoteCommand>
Constructors
Section titled “Constructors”RemoteCommand(string, string?, IReadOnlyList<string>, IReadOnlyList<RemoteParameter>)
Section titled “RemoteCommand(string, string?, IReadOnlyList<string>, IReadOnlyList<RemoteParameter>)”A command’s canonical identity and discoverable parameters.
public RemoteCommand(string Path, string? Description, IReadOnlyList<string> Aliases, IReadOnlyList<RemoteParameter> Parameters)Parameters
Section titled “Parameters”Path(string): Registered route template.Description(string): User-facing description.Aliases(IReadOnlyList<string>): CLI aliases.Parameters(IReadOnlyList<RemoteParameter>): Arguments and options in declaration order.
Properties
Section titled “Properties”Aliases
Section titled “Aliases”CLI aliases.
public IReadOnlyList<string> Aliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
Description
Section titled “Description”User-facing description.
public string? Description { get; init; }Returns
Section titled “Returns”Parameters
Section titled “Parameters”Arguments and options in declaration order.
public IReadOnlyList<RemoteParameter> Parameters { get; init; }Returns
Section titled “Returns”IReadOnlyList<RemoteParameter>
Registered route template.
public string Path { get; init; }