SerializeOptions <T, P, E, F>

Index

Properties

• convertCustomTypes
• exclude
• fields
• forceObject
• groups
• ignoreSerializers
• includeHidden
• populate
• skipNull

Properties

optionalconvertCustomTypes

convertCustomTypes?: boolean

Convert custom types to their database representation. By default, the Type.toJSON method is invoked instead.

optionalexclude

exclude?: readonly AutoPath<T, E, never, 9>[]

Specify which properties should be omitted.

optionalfields

fields?: readonly AutoPath<T, F, *, 9>[]

Whitelist of properties to serialize, supports dot-paths (e.g. ['name', 'books.title']). When set, only the listed properties end up in the output, including primary keys. A bare property name keeps its entire sub-tree; a dot-path additionally narrows the nested object to the listed sub-keys. exclude takes precedence on conflict.

optionalforceObject

forceObject?: boolean

Enforce unpopulated references to be returned as objects, e.g. { author: { id: 1 } } instead of { author: 1 }.

optionalgroups

groups?: string[]

Only include properties for a specific group. If a property does not specify any group, it will be included, otherwise only properties with a matching group are included.

optionalignoreSerializers

ignoreSerializers?: boolean

Ignore custom property serializers.

optionalincludeHidden

includeHidden?: boolean

Include properties marked as hidden.

optionalpopulate

populate?: readonly AutoPath<T, P, *, 9>[]

Specify which relation should be serialized as populated and which as a FK.

optionalskipNull

skipNull?: boolean

Skip properties with null value.