MobX-state-tree

MobX-state-tree

  • Documentation
  • TypeDocs
  • Sponsor
  • GitHub

›Interfaces

Introduction

  • Globals

Interfaces

  • CustomTypeOptions
  • ErrorFormattingOptions
  • FunctionWithFlag
  • IActionContext
  • IActionRecorder
  • IActionTrackingMiddleware2Call
  • IActionTrackingMiddleware2Hooks
  • IActionTrackingMiddlewareHooks
  • IAnyComplexType
  • IAnyModelType
  • IAnyType
  • IHooks
  • IJsonPatch
  • IMiddlewareEvent
  • IModelReflectionData
  • IModelReflectionPropertiesData
  • IModelType
  • IPatchRecorder
  • IReversibleJsonPatch
  • ISerializedActionCall
  • ISimpleType
  • ISnapshotProcessor
  • ISnapshotProcessors
  • IType
  • IValidationContextEntry
  • IValidationError
  • ReferenceOptionsGetSet
  • ReferenceOptionsOnInvalidated
  • UnionOptions
Edit

ErrorFormattingOptions

mobx-state-tree - v7.3.1 › ErrorFormattingOptions

Options that control how snapshots/values and type shapes are rendered inside type-checking error messages (see setErrorFormatting).

Hierarchy

  • ErrorFormattingOptions

Index

Properties

  • enabled
  • indent
  • maxArrayLength
  • maxDepth
  • maxPropertyCount
  • maxStringLength

Properties

enabled

• enabled: boolean

Defined in src/core/type/errorFormatting.ts:13

When false (the default), error messages are rendered exactly as they always have been: the offending value is serialized to a single JSON.stringify line and the message is capped in length. When true, the value is truncated (using the limits below) and, when indent > 0, pretty-printed across multiple lines.


indent

• indent: number

Defined in src/core/type/errorFormatting.ts:19

Number of spaces to indent each nesting level by when pretty-printing. Use 0 to keep everything on a single line while still truncating (handy when you only want to bound the message size, not reflow it).


maxArrayLength

• maxArrayLength: number

Defined in src/core/type/errorFormatting.ts:23

Arrays with more than this many items are clipped, with a note of how many items were omitted.


maxDepth

• maxDepth: number

Defined in src/core/type/errorFormatting.ts:27

Values nested deeper than this are summarized as {…} / […].


maxPropertyCount

• maxPropertyCount: number

Defined in src/core/type/errorFormatting.ts:25

Objects with more than this many keys are clipped, with a note of how many keys were omitted.


maxStringLength

• maxStringLength: number

Defined in src/core/type/errorFormatting.ts:21

Strings longer than this are clipped, with a note of how many characters were omitted.

← CustomTypeOptionsFunctionWithFlag →
  • Hierarchy
  • Index
    • Properties
  • Properties
    • enabled
    • indent
    • maxArrayLength
    • maxDepth
    • maxPropertyCount
    • maxStringLength
MobX-state-tree
Docs
Getting StartedBasic conceptsAdvanced conceptsAPI Reference
Community
GitHub DiscussionsStack Overflow
More
BlogGitHubStar
Facebook Open Source
Copyright © 2026 Michel Weststrate