# FilterCircularsOptions

`interface` in `utils` · v0.4.0

<https://docs.seedcord.org/packages/utils/0.4.0/interfaces/filter-circulars-options>

Configuration for [`filterCirculars`](/packages/utils/0.4.0/functions/filter-circulars).

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

## Properties

### logger

```ts
logger: ILogger;
```

Optional ILogger used to log stringify or parse errors.

### marker

```ts
marker: Marker;
```

Override the circular placeholder. Default is `[Circular]`.

### mode

```ts
mode: "json" | "decycle";
```

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