Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Types

Index

Interfaces

Type aliases

Type aliases

ArrayLengthMutationKeys

ArrayLengthMutationKeys: "splice" | "push" | "pop" | "shift" | "unshift"

ClassType

ClassType<T>: {} | {} | ((...args: any[]) => T) | ((...args: any[]) => (cls: any) => T) | { name: string; prototype: T }

Helper type that represents a general JavaScript type.

Type parameters

  • T

ClassTypeWithDecoratorDefinitions

ClassTypeWithDecoratorDefinitions: () => { decorators: { name: string; options: JsonDecoratorOptions }[]; target: ClassType<any> }

Helper type used in JsonClassType to declare a ClassType and apply decorators to it.

Type declaration

Deserializer

Deserializer: (key: string, value: any, context?: JsonParserTransformerContext) => any

Deserializer type.

Type declaration

FixedLengthArray

FixedLengthArray<T, L, TObj>: Pick<TObj, Exclude<keyof TObj, ArrayLengthMutationKeys>> & { [Symbol.iterator]: () => IterableIterator<T>; length: L }

Type parameters

  • T

  • L: number

  • TObj

JacksonDecorator

JacksonDecorator<T, TDecorator>: JacksonDecoratorWithOptions<T, TDecorator> | JacksonDecoratorWithOptionalOptions<T, TDecorator>

Decorator type.

Type parameters

JacksonDecoratorWithOptionalOptions

JacksonDecoratorWithOptionalOptions<T, TDecorator>: (options?: T) => TDecorator

Decorator type with optional options.

Type parameters

Type declaration

    • (options?: T): TDecorator

    • Parameters

      • Optional options: T

      Returns TDecorator

JacksonDecoratorWithOptions

JacksonDecoratorWithOptions<T, TDecorator>: (options: T) => TDecorator

Decorator type with at least one required option.

Type parameters

Type declaration

    • (options: T): TDecorator

    • Parameters

      • options: T

      Returns TDecorator

JsonAliasDecorator

JsonAliasDecorator: JacksonDecoratorWithOptions<JsonAliasOptions, PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonAlias.

JsonAnyGetterDecorator

JsonAnyGetterDecorator: JacksonDecoratorWithOptionalOptions<JsonAnyGetterOptions, MethodDecorator>

Decorator type for JsonAnyGetter.

JsonAnySetterDecorator

JsonAnySetterDecorator: JacksonDecoratorWithOptionalOptions<JsonAnySetterOptions, MethodDecorator>

Decorator type for JsonAnySetter.

JsonAnySetterOptions

JsonAnySetterOptions: JsonDecoratorOptions

Decorator options for JsonAnySetter.

JsonAppendDecorator

JsonAppendDecorator: JacksonDecoratorWithOptions<JsonAppendOptions, ClassDecorator>

Decorator type for JsonAppend.

JsonBackReferenceDecorator

JsonBackReferenceDecorator: JacksonDecoratorWithOptionalOptions<JsonBackReferenceOptions, PropertyDecorator & MethodDecorator>

Decorator type for JsonBackReference.

JsonClassTypeDecorator

JsonClassTypeDecorator: JacksonDecoratorWithOptions<JsonClassTypeOptions, PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonClassType.

JsonCreatorDecorator

JsonCreatorDecorator: JacksonDecoratorWithOptionalOptions<JsonCreatorOptions, ClassDecorator & MethodDecorator>

Decorator type for JsonCreator.

JsonDecorator

JsonDecorator: <T>(options: JsonDecoratorOptions, target: Record<string, any>, propertyKey: string | symbol, descriptorOrParamIndex: number | TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void

General decorator type.

Type declaration

    • <T>(options: JsonDecoratorOptions, target: Record<string, any>, propertyKey: string | symbol, descriptorOrParamIndex: number | TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void

    • Type parameters

      • T

      Parameters

      • options: JsonDecoratorOptions
      • target: Record<string, any>
      • propertyKey: string | symbol
      • descriptorOrParamIndex: number | TypedPropertyDescriptor<T>

      Returns TypedPropertyDescriptor<T> | void

JsonDeserializeDecorator

JsonDeserializeDecorator: JacksonDecoratorWithOptions<JsonDeserializeOptions, ClassDecorator & PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonDeserialize.

JsonFilterDecorator

JsonFilterDecorator: JacksonDecoratorWithOptions<JsonFilterOptions, ClassDecorator & PropertyDecorator & MethodDecorator>

Decorator type for JsonFilter.

JsonFormatDecorator

JsonFormatDecorator: JacksonDecoratorWithOptionalOptions<JsonFormatOptions, ClassDecorator & PropertyDecorator & MethodDecorator>

Decorator type for JsonFormat.

JsonFormatOptions

JsonFormatOptions: JsonFormatAny | JsonFormatArray | JsonFormatBoolean | JsonFormatNumberFloat | JsonFormatNumberInt | JsonFormatObject | JsonFormatScalar | JsonFormatString

Decorator options for JsonFormat.

default

JsonFormatAny

JsonGetterDecorator

JsonGetterDecorator: JacksonDecoratorWithOptionalOptions<JsonGetterOptions, MethodDecorator & PropertyDecorator>

Decorator type for JsonGetter.

JsonIdentityInfoDecorator

JsonIdentityInfoDecorator: JacksonDecoratorWithOptions<JsonIdentityInfoOptions, ClassDecorator & PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonIdentityInfo.

JsonIdentityReferenceDecorator

JsonIdentityReferenceDecorator: JacksonDecoratorWithOptions<JsonIdentityReferenceOptions, ClassDecorator & PropertyDecorator & MethodDecorator>

Decorator type for JsonIdentityReference.

JsonIgnoreDecorator

JsonIgnoreDecorator: JacksonDecoratorWithOptionalOptions<JsonIgnoreOptions, PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonIgnore.

JsonIgnoreOptions

JsonIgnoreOptions: JsonDecoratorOptions

Decorator options for JsonIgnore.

JsonIgnorePropertiesDecorator

JsonIgnorePropertiesDecorator: JacksonDecoratorWithOptions<JsonIgnorePropertiesOptions, ClassDecorator & PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonIgnoreProperties.

JsonIgnoreTypeDecorator

JsonIgnoreTypeDecorator: JacksonDecoratorWithOptionalOptions<JsonIgnoreTypeOptions, ClassDecorator>

Decorator type for JsonIgnoreType.

JsonIgnoreTypeOptions

JsonIgnoreTypeOptions: JsonDecoratorOptions

Decorator options for JsonIgnoreType.

JsonIncludeDecorator

JsonIncludeDecorator: JacksonDecoratorWithOptionalOptions<JsonIncludeOptions, ClassDecorator & PropertyDecorator & MethodDecorator>

Decorator type for JsonInclude.

JsonIncludeOptions

JsonIncludeOptions: JsonIncludeBaseOptions & JsonDecoratorOptions

Decorator options for JsonInclude.

JsonInjectDecorator

JsonInjectDecorator: JacksonDecoratorWithOptionalOptions<JsonInjectOptions, PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonInject.

JsonManagedReferenceDecorator

JsonManagedReferenceDecorator: JacksonDecoratorWithOptionalOptions<JsonManagedReferenceOptions, PropertyDecorator & MethodDecorator>

Decorator type for JsonManagedReference.

JsonNamingDecorator

JsonNamingDecorator: JacksonDecoratorWithOptions<JsonNamingOptions, ClassDecorator>

Decorator type for JsonNaming.

JsonParserTransformerContext

JsonParserTransformerContext: Modify<JsonParserContext, { mainCreator?: ClassList<ClassType<any>> }>

Context properties used by JsonParser.transform during deserialization.

JsonPropertyDecorator

JsonPropertyDecorator: JacksonDecoratorWithOptionalOptions<JsonPropertyOptions, PropertyDecorator & MethodDecorator & ParameterDecorator>

Decorator type for JsonProperty.

JsonPropertyOrderDecorator

JsonPropertyOrderDecorator: JacksonDecoratorWithOptions<JsonPropertyOrderOptions, ClassDecorator & PropertyDecorator & MethodDecorator>

Decorator type for JsonPropertyOrder.

JsonRawValueDecorator

JsonRawValueDecorator: JacksonDecoratorWithOptionalOptions<JsonRawValueOptions, PropertyDecorator & MethodDecorator>

Decorator type for JsonRawValue.

JsonRawValueOptions

JsonRawValueOptions: JsonDecoratorOptions

Decorator options for JsonRawValue.

JsonRootNameDecorator

JsonRootNameDecorator: JacksonDecoratorWithOptionalOptions<JsonRootNameOptions, ClassDecorator>

Decorator type for JsonRootName.

JsonSerializeDecorator

JsonSerializeDecorator: JacksonDecoratorWithOptions<JsonSerializeOptions, ClassDecorator & PropertyDecorator & ParameterDecorator & MethodDecorator>

Decorator type for JsonSerialize.

JsonSetterDecorator

JsonSetterDecorator: JacksonDecoratorWithOptionalOptions<JsonSetterOptions, MethodDecorator & PropertyDecorator>

Decorator type for JsonSetter.

JsonStringifierTransformerContext

JsonStringifierTransformerContext: Modify<JsonStringifierContext, { mainCreator?: ClassList<ClassType<any>> }>

Context properties used by JsonStringifier.transform during serialization.

JsonSubTypesDecorator

JsonSubTypesDecorator: JacksonDecoratorWithOptions<JsonSubTypesOptions, ClassDecorator & MethodDecorator & PropertyDecorator & ParameterDecorator>

Decorator type for JsonSubTypes.

JsonTypeIdDecorator

JsonTypeIdDecorator: JacksonDecoratorWithOptionalOptions<JsonTypeIdOptions, PropertyDecorator & MethodDecorator>

Decorator type for JsonTypeId.

JsonTypeIdOptions

JsonTypeIdOptions: JsonDecoratorOptions

Decorator options for JsonTypeId.

JsonTypeIdResolverDecorator

JsonTypeIdResolverDecorator: JacksonDecoratorWithOptions<JsonTypeIdResolverOptions, ClassDecorator & MethodDecorator & PropertyDecorator & ParameterDecorator>

Decorator type for JsonTypeIdResolver.

JsonTypeInfoDecorator

JsonTypeInfoDecorator: JacksonDecoratorWithOptions<JsonTypeInfoOptions, ClassDecorator & MethodDecorator & PropertyDecorator & ParameterDecorator>

Decorator type for JsonTypeInfo.

JsonTypeNameDecorator

JsonTypeNameDecorator: JacksonDecoratorWithOptionalOptions<JsonTypeNameOptions, ClassDecorator>

Decorator type for JsonTypeName.

JsonUnwrappedDecorator

JsonUnwrappedDecorator: JacksonDecoratorWithOptionalOptions<JsonUnwrappedOptions, PropertyDecorator & MethodDecorator>

Decorator type for JsonUnwrapped.

JsonValueDecorator

JsonValueDecorator: JacksonDecoratorWithOptionalOptions<JsonValueOptions, MethodDecorator & PropertyDecorator>

Decorator type for JsonValue.

JsonValueOptions

JsonValueOptions: JsonDecoratorOptions

Decorator options for JsonValue.

JsonViewDecorator

JsonViewDecorator: JacksonDecoratorWithOptions<JsonViewOptions, ClassDecorator & MethodDecorator & PropertyDecorator & ParameterDecorator>

Decorator type for JsonView.

Modify

Modify<T, R>: Omit<T, keyof R> & R

https://stackoverflow.com/a/55032655/4637638

Type parameters

  • T

  • R

Serializer

Serializer: (key: string, value: any, context?: JsonStringifierTransformerContext) => any

Serializer type.

Type declaration

Generated using TypeDoc