SpaEnvelopeDto Pennington.Islands

DTO for JSON serialization (SpaEnvelope uses ImmutableDictionary which needs a simpler shape).

Properties

Description string?: Default: null
Short page description, when available.
Diagnostics System.Collections.Generic.IReadOnlyList<Pennington.Diagnostics.Diagnostic>?: Default: null
Per-request diagnostics emitted during rendering.
Islands System.Collections.Generic.Dictionary<string, string>: Island id to rendered HTML payload.
Reload bool?: Default: null
When set, directs the SPA shell to perform a full reload instead of a client-side swap.
Title string: Page title, surfaced in the browser tab and hero.

Constructors

.ctor

public record SpaEnvelopeDto(
    string Title,
    string? Description,
    Dictionary<string, string> Islands,
    IReadOnlyList<Diagnostic>? Diagnostics = null,
    bool? Reload = null
);

DTO for JSON serialization (SpaEnvelope uses ImmutableDictionary which needs a simpler shape).

Parameters

Title string: Page title, surfaced in the browser tab and hero.
Description string?: Short page description, when available.
Islands Dictionary<string, string>: Island id to rendered HTML payload.
Diagnostics IReadOnlyList<Diagnostic>? (optional): Per-request diagnostics emitted during rendering.
Reload bool? (optional): When set, directs the SPA shell to perform a full reload instead of a client-side swap.

Pennington.Islands.SpaEnvelopeDto

namespace Pennington.Islands;

/// DTO for JSON serialization (SpaEnvelope uses ImmutableDictionary which needs a simpler shape).
public record SpaEnvelopeDto
{
    /// DTO for JSON serialization (SpaEnvelope uses ImmutableDictionary which needs a simpler shape).
    public record SpaEnvelopeDto(
    string Title,
    string? Description,
    Dictionary<string, string> Islands,
    IReadOnlyList<Diagnostic>? Diagnostics = null,
    bool? Reload = null
);

    /// Short page description, when available.
    string? Description;

    /// Per-request diagnostics emitted during rendering.
    IReadOnlyList<Diagnostic>? Diagnostics = null;

    /// Island id to rendered HTML payload.
    Dictionary<string, string> Islands;

    /// When set, directs the SPA shell to perform a full reload instead of a client-side swap.
    bool? Reload = null;

    /// Page title, surfaced in the browser tab and hero.
    string Title;
}