rc-js-util/docs/rc-js-util.ierrorsummary.md

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [rc-js-util](./rc-js-util.md) &gt; [IErrorSummary](./rc-js-util.ierrorsummary.md)

## IErrorSummary interface

A flattened [INestedError](./rc-js-util.inestederror.md)<!-- -->, ready to be localized and shown to the user.

**Signature:**

```typescript
export interface IErrorSummary<TLocalization> 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[detail?](./rc-js-util.ierrorsummary.detail.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ Can be anything libraries are throwing, failing that a stack trace. Generally not appropriate to show to the user, except as additional information after the localized messages.


</td></tr>
<tr><td>

[messages](./rc-js-util.ierrorsummary.messages.md)


</td><td>


</td><td>

TLocalization\[\]


</td><td>

A user-friendly description of what went wrong. The stringified localization can be joined to form a sentence.


</td></tr>
</tbody></table>