Skip to content

docs(circular): clarify JSON escaping for custom markers #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BridgeAR merged 1 commit into from
Oct 13, 2026
Merged

docs(circular): clarify JSON escaping for custom markers #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ stringify(circular, ['a', 'b'], 2)
number. If set to `'string'`, bigint values are serialized as JSON strings.
Otherwise they are ignored. **Default:** `true`.
* `circularValue` {string|null|undefined|ErrorConstructor} Defines the value for
circular references. Set to `undefined`, circular properties are not
circular references. String values are wrapped in double quotes without JSON
escaping. Escape JSON special characters in the value to keep the output valid
JSON. Set to `undefined`, circular properties are not
serialized (array entries are replaced with `null`). Set to `Error`, to throw
on circular references. **Default:** `'[Circular: N]'`, where `N` is the
referenced ancestor's depth, starting at 0 for the root. Set to `'[Circular]'`
Expand Down
Loading