Skip to content
Interfaceutilsv0.8.17

FilterCircularsOptions

Configuration for filterCirculars.

interface FilterCircularsOptions<
    Marker extends string = "[Circular]"
>

Marker

Marker extends string = '[Circular]'

logger

Optional ILogger used to log stringify or parse errors.

logger?: ILogger

marker

Override the circular placeholder.

marker?: Marker

Default:'[Circular]'

mode

Processing mode. json uses stringify and parse (might end up using a toJSON() if found). decycle builds a safe clone first.

mode?: 'json' | 'decycle'

Default:'decycle'