SerializeOptions <T, P, E>

Index

Properties

• exclude
• forceObject
• groups
• ignoreSerializers
• populate
• skipNull

Properties

optionalexclude

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

Specify which properties should be omitted.

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.

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.