ContractsSerializable class

A JsonSerializable annotation with preset configuration. Only a subset of options can be changed, rest is set to adhere to contracts serialization.

Inheritance

Constructors

ContractsSerializable({bool? explicitToJson, bool? genericArgumentFactories})
Constructs a pre-configured JsonSerializable annotation.
const

Properties

anyMap → bool?
If true, Map types are not assumed to be Map<String, dynamic> – which is the default type of Map instances return by JSON decode in dart:convert.
finalinherited
checked → bool?
If true, generated fromJson functions include extra checks to validate proper deserialization of types.
finalinherited
constructor → String?
Specifies a named constructor to target when creating the fromJson function.
finalinherited
converters → List<JsonConverter>?
A list of JsonConverter to apply to this class.
finalinherited
createFactory → bool?
If true (the default), a private, static _$ExampleFromJson method is created in the generated part file.
finalinherited
createFieldMap → bool?
If true (defaults to false), a private, static _$ExampleJsonMeta constant is created in the generated part file.
finalinherited
createJsonKeys → bool?
If true (defaults to false), a private class _$ExampleJsonKeys class is created in the generated part file.
finalinherited
createPerFieldToJson → bool?
If true (defaults to false), a private, static _$ExamplePerFieldToJson abstract class will be generated in the part file.
finalinherited
createToJson → bool?
If true (the default), A top-level function is created that you can reference from your class.
finalinherited
disallowUnrecognizedKeys → bool?
If false (the default), then the generated FromJson function will ignore unrecognized keys in the provided JSON Map.
finalinherited
explicitToJson → bool?
If true, generated toJson methods will explicitly call toJson on nested objects.
finalinherited
fieldRename → FieldRename?
Defines the automatic naming strategy when converting class field names into JSON map keys.
finalinherited
genericArgumentFactories → bool?
When true on classes with type parameters (generic types), extra "helper" parameters will be generated for fromJson and/or toJson to support serializing values of those types.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
ignoreUnannotated → bool?
When true, only fields annotated with JsonKey will have code generated.
finalinherited
includeIfNull → bool?
Whether the generator should include fields with null values in the serialized output.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited
withDefaults() → JsonSerializable
Returns a new JsonSerializable instance with fields equal to the corresponding values in this, if not null.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited