Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JsonIncludeBaseOptions

Decorator base options for JsonInclude.

Hierarchy

  • JsonIncludeBaseOptions

Index

Properties

Properties

Optional content

content: JsonIncludeType

Inclusion rule to use for entries ("content") of decorated Map or "Object Literal" properties.

default

JsonIncludeType.ALWAYS

Optional contentFilter

contentFilter: (value: any) => boolean

Specifies a function to use in case content is JsonIncludeType.CUSTOM for filtering the content value. If it returns true, then the content value is not serialized.

param

content value to be filtered.

returns

boolean

Type declaration

    • (value: any): boolean

    • Parameters

      • value: any

      Returns boolean

Optional value

value: JsonIncludeType

Inclusion rule to use for instances (values) of types (Classes) or properties decorated.

default

JsonIncludeType.ALWAYS

Optional valueFilter

valueFilter: (value: any) => boolean

Specifies a function to use in case value is JsonIncludeType.CUSTOM for filtering the value. If it returns true, then the value is not serialized.

param

value to be filtered.

returns

boolean

Type declaration

    • (value: any): boolean

    • Parameters

      • value: any

      Returns boolean

Generated using TypeDoc