JsonSerializable class
An annotation used to specify a class to generate code for.
- Annotations
- @JsonSerializable(checked: true, disallowUnrecognizedKeys: true, fieldRename: FieldRename.snake)
Constructors
- JsonSerializable({bool anyMap, bool checked, bool createFactory, bool createToJson, bool disallowUnrecognizedKeys, bool explicitToJson, FieldRename fieldRename, bool ignoreUnannotated, bool includeIfNull, bool nullable, bool genericArgumentFactories})
-
Creates a new JsonSerializable instance.
const
-
JsonSerializable.fromJson(Map<
String, dynamic> json) -
factory
Properties
- anyMap → bool
-
If
true
,Map
types are not assumed to beMap<String, dynamic>
– which is the default type ofMap
instances return by JSON decode indart:convert
. [...]final - checked → bool
-
If
true
, generatedfromJson
functions include extra checks to validate proper deserialization of types. [...]final - createFactory → bool
-
If
true
(the default), a private, static_$ExampleFromJson
method is created in the generated part file. [...]final - createToJson → bool
-
If
true
(the default), A top-level function is created that you can reference from your class. [...]final - disallowUnrecognizedKeys → bool
-
If
false
(the default), then the generatedFromJson
function will ignore unrecognized keys in the provided JSONMap
. [...]final - explicitToJson → bool
-
If
true
, generatedtoJson
methods will explicitly calltoJson
on nested objects. [...]final - fieldRename → FieldRename
-
Defines the automatic naming strategy when converting class field names
into JSON map keys. [...]
final
- genericArgumentFactories → bool
-
When
true
on classes with type parameters (generic types), extra "helper" parameters will be generated forfromJson
and/ortoJson
to support serializing values of those types. [...]final - hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- ignoreUnannotated → bool
-
When
true
, only fields annotated with JsonKey will have code generated. [...]final - includeIfNull → bool
-
Whether the generator should include fields with
null
values in the serialized output. [...]final - nullable → bool
-
When
true
(the default),null
fields are handled gracefully when encoding to JSON and when decodingnull
and nonexistent values from JSON. [...]final - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
Returns a string representation of this object.
inherited
-
withDefaults(
) → JsonSerializable -
Returns a new JsonSerializable instance with fields equal to the
corresponding values in
this
, if notnull
. [...]
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Constants
- defaults → const JsonSerializable
-
An instance of JsonSerializable with all fields set to their default
values.
const JsonSerializable(anyMap: false, checked: false, createFactory: true, createToJson: true, disallowUnrecognizedKeys: false, explicitToJson: false, fieldRename: FieldRename.none, ignoreUnannotated:…