Interface ToJSONOptions

Options for toJSON method

interface ToJSONOptions {
    attributes?: string[];
    exclude?: string[];
    raw?: boolean;
    include?: IncludeOptions[] | Includeable[];
    clone?: boolean;
}

Index

Properties

attributes? exclude? raw? include? clone?

Properties

`Optional`attributes

attributes?: string[]

Only include these attributes in the output

`Optional`exclude

exclude?: string[]

Exclude these attributes from the output

`Optional`raw

raw?: boolean

When true, bypass all transformations (no virtual fields, no hidden filtering)

`Optional`include

include?: IncludeOptions[] | Includeable[]

Include nested associations

`Optional`clone

clone?: boolean

Clone the result before returning (prevents mutation)