Variable TypedJSONConst

Type declaration

• AnyT: ConcreteTypeDescriptor

• options: {
      mergeOptions: any;
  }

  • mergeOptions: any

• typeDescriptor: {
      ArrayTypeDescriptor: any;
      MapTypeDescriptor: any;
      SetTypeDescriptor: any;
      ensureTypeDescriptor: any;
  }

  • ArrayTypeDescriptor: any

  • MapTypeDescriptor: any

  • SetTypeDescriptor: any

  • ensureTypeDescriptor: any

• utils: {
      isInstanceOf: any;
      isSubtypeOf: any;
      isValueDefined: any;
      nameof: any;
  }

  • isInstanceOf: any

  • isSubtypeOf: any

  • isValueDefined: any

  • nameof: any

• ArrayT:function

  • ArrayT(elementType): ArrayTypeDescriptor

  • Parameters

    • elementType: Typelike

    Returns ArrayTypeDescriptor

• MapT:function

  • MapT(keyType, valueType, options?): MapTypeDescriptor

  • Parameters

    • keyType: Typelike
    • valueType: Typelike
    • Optional options: Partial<MapOptions>

    Returns MapTypeDescriptor

• SetT:function

  • SetT(elementType): SetTypeDescriptor

  • Parameters

    • elementType: Typelike

    Returns SetTypeDescriptor

• defaultTypeEmitter:function

  • defaultTypeEmitter(targetObject, sourceObject, expectedSourceType, sourceTypeMetadata?): void

  • Parameters

    • targetObject: IndexedObject
    • sourceObject: IndexedObject
    • expectedSourceType: Function
    • Optional sourceTypeMetadata: JsonObjectMetadata

    Returns void

• defaultTypeResolver:function

  • defaultTypeResolver(sourceObject, knownTypes): Function | undefined

  • Parameters

    • sourceObject: IndexedObject
    • knownTypes: Map<string, Function>

    Returns Function | undefined

• jsonArrayMember:function

  • jsonArrayMember(maybeTypeThunk, options?): ((target, propKey) => void)

  • Specifies that a property, of type array, is part of an object when serializing.

    Parameters

    • maybeTypeThunk: MaybeTypeThunk

      Constructor of array elements (e.g. 'Number' for 'number[]', or 'Date' for 'Date[]').
    • Optional options: IJsonArrayMemberOptions

      Additional options.

    Returns ((target, propKey) => void)

    • • (target, propKey): void

      • Parameters

        • target: Object
        • propKey: string | symbol

        Returns void

• jsonMapMember:function

  • jsonMapMember(maybeKeyThunk, maybeValueThunk, options?): ((target, propKey) => void)

  • Specifies that the property is part of the object when serializing. Use this decorator on properties of type Map<K, V>.

    Parameters

    • maybeKeyThunk: MaybeTypeThunk

      Constructor of map keys (e.g. 'Number' for 'Map<number, Date>').
    • maybeValueThunk: MaybeTypeThunk

      Constructor of map values (e.g. 'Date' for 'Map<number, Date>').
    • Optional options: IJsonMapMemberOptions

      Additional options.

    Returns ((target, propKey) => void)

    • • (target, propKey): void

      • Parameters

        • target: Object
        • propKey: string | symbol

        Returns void

• jsonMember:function

  • jsonMember<T>(prototype, propertyKey): void

  • Specifies that a property is part of the object when serializing. Requires ReflectDecorators.

    Type Parameters

    • T extends Function

    Parameters

    • prototype: IndexedObject
    • propertyKey: string | symbol

    Returns void
  • jsonMember(options): PropertyDecorator

  • Specifies that a property is part of the object when serializing, with additional options. Requires ReflectDecorators.

    Parameters

    • options: IJsonMemberOptions

    Returns PropertyDecorator
  • jsonMember(type, options?): PropertyDecorator

  • Specifies that a property is part of the object when serializing, with a defined type and extra options.

    Parameters

    • type: MaybeTypeThunk
    • Optional options: IJsonMemberOptions

    Returns PropertyDecorator

• jsonObject:function

  • jsonObject<T>(options?): ((target) => void)

  • Marks that a class with a parameterized constructor is serializable using TypedJSON, with additional settings. The 'initializer' setting must be specified.

    Type Parameters

    • T

    Parameters

    • Optional options: IJsonObjectOptionsWithInitializer<T>

      Configuration settings.

    Returns ((target) => void)

    • • (target): void

      • Parameters

        • target: Serializable<T>

        Returns void
  • jsonObject<T>(options?): ((target) => void)

  • Marks that a class is serializable using TypedJSON, with additional settings.

    Type Parameters

    • T

    Parameters

    • Optional options: IJsonObjectOptions<T>

      Configuration settings.

    Returns ((target) => void)

    • • (target): void

      • Parameters

        • target: Serializable<T>

        Returns void
  • jsonObject<T>(target): void

  • Marks that a class with a parameterless constructor is serializable using TypedJSON.

    Type Parameters

    • T

    Parameters

    • target: Serializable<T>

    Returns void

• jsonSetMember:function

  • jsonSetMember(maybeTypeThunk, options?): ((target, propKey) => void)

  • Specifies that the property is part of the object when serializing. Use this decorator on properties of type Set.

    Parameters

    • maybeTypeThunk: MaybeTypeThunk

      Constructor of set elements (e.g. 'Number' for Set or 'Date' for Set).
    • Optional options: IJsonSetMemberOptions

      Additional options.

    Returns ((target, propKey) => void)

    • • (target, propKey): void

      • Parameters

        • target: Object
        • propKey: string | symbol

        Returns void

• toJson:function

  • toJson<T>(target): void

  • Decorator that will generate toJSON function on the class prototype that allows JSON.stringify to be used instead of TypedJSON.stringify. Under the hood it will simply delegate to TypedJSON. By default it will throw if the prototype already has a toJSON function defined.

    Type Parameters

    • T extends Object

    Parameters

    • target: Function

      the class which prototype should be modified.

    Returns void
  • toJson<T>(options): ((target) => void)

  • Decorator factory that accepts the options interface.

    Type Parameters

    • T extends Object

    Parameters

    • options: IToJsonOptions

      for configuring the toJSON creation.

    Returns ((target) => void)

    • • (target): void

      • Parameters

        • target: Function

        Returns void