OutputOptions
Output pipeline configuration.
- Kind:
Class - Namespace: Repl
- Assembly:
Repl.Core - Source: src/Repl.Core/OutputOptions.cs
Signature
Section titled “Signature”public sealed class OutputOptionsInheritance
Section titled “Inheritance”Constructors
Section titled “Constructors”OutputOptions()
Section titled “OutputOptions()”Initializes a new instance of the OutputOptions class.
public OutputOptions()Methods
Section titled “Methods”AddAlias(string, string)
Section titled “AddAlias(string, string)”Adds a flag alias mapped to an output format.
public void AddAlias(string alias, string format)Parameters
Section titled “Parameters”alias(string): Alias name without prefix (for example: “markdown”).format(string): Target output format name.
AddTransformer(string, IOutputTransformer)
Section titled “AddTransformer(string, IOutputTransformer)”Adds a transformer for an output format.
public void AddTransformer(string name, IOutputTransformer transformer)Parameters
Section titled “Parameters”name(string): Format name.transformer(IOutputTransformer): Transformer implementation.
Properties
Section titled “Properties”Aliases
Section titled “Aliases”Gets registered output aliases by alias name.
public IReadOnlyDictionary<string, string> Aliases { get; }Returns
Section titled “Returns”IReadOnlyDictionary<string, string>
AnsiMode
Section titled “AnsiMode”Gets or sets the ANSI mode behavior.
public AnsiMode AnsiMode { get; set; }Returns
Section titled “Returns”BannerEnabled
Section titled “BannerEnabled”Gets or sets a value indicating whether banner output is enabled.
public bool BannerEnabled { get; set; }Returns
Section titled “Returns”BannerFormats
Section titled “BannerFormats”Gets the set of output format names eligible for banner rendering. Only formats in this set will display banners in interactive mode. Add custom format names (e.g. “spectre”) to enable banners for those formats.
public ISet<string> BannerFormats { get; }Returns
Section titled “Returns”ISet<string>
ColorizeStructuredInteractive
Section titled “ColorizeStructuredInteractive”Gets or sets a value indicating whether structured output (for example JSON) should be ANSI colorized during interactive sessions.
public bool ColorizeStructuredInteractive { get; set; }Returns
Section titled “Returns”DefaultFormat
Section titled “DefaultFormat”Gets or sets the default output format.
public string DefaultFormat { get; set; }Returns
Section titled “Returns”FallbackWidth
Section titled “FallbackWidth”Gets or sets the fallback render width when terminal width is unavailable.
public int FallbackWidth { get; set; }Returns
Section titled “Returns”JsonSerializerOptions
Section titled “JsonSerializerOptions”Gets JSON serializer options used by the JSON transformer.
public JsonSerializerOptions JsonSerializerOptions { get; }Returns
Section titled “Returns”PaletteProvider
Section titled “PaletteProvider”Gets or sets the palette provider used when ANSI rendering is enabled.
public IAnsiPaletteProvider PaletteProvider { get; set; }Returns
Section titled “Returns”PreferredWidth
Section titled “PreferredWidth”Gets or sets a preferred render width for human output.
public int? PreferredWidth { get; set; }Returns
Section titled “Returns”int?
ResultFlow
Section titled “ResultFlow”Gets result-flow options for paging and large result sets.
public ResultFlowOptions ResultFlow { get; }Returns
Section titled “Returns”ThemeMode
Section titled “ThemeMode”Gets or sets the theme mode used for ANSI palette selection.
public ThemeMode ThemeMode { get; set; }Returns
Section titled “Returns”Transformers
Section titled “Transformers”Gets registered transformers by name.
public IReadOnlyDictionary<string, IOutputTransformer> Transformers { get; }Returns
Section titled “Returns”IReadOnlyDictionary<string, IOutputTransformer>