JsonSerializable class - json_annotation library

Constructors

JsonSerializable({@Deprecated('Has no effect') bool? nullable, bool? anyMap, bool? checked, String? constructor, bool? createFieldMap, bool? createJsonKeys, bool? createFactory, bool? createToJson, bool? disallowUnrecognizedKeys, bool? explicitToJson, FieldRename? fieldRename, bool? ignoreUnannotated, bool? includeIfNull, List<JsonConverter>? converters, bool? genericArgumentFactories, bool? createPerFieldToJson}): Creates a new JsonSerializable instance.
const
JsonSerializable.fromJson(Map<String, dynamic> json): factory

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.
final
checked → bool?: If true, generated fromJson functions include extra checks to validate proper deserialization of types.
final
constructor → String?: Specifies a named constructor to target when creating the fromJson function.
final
converters → List<JsonConverter>?: A list of JsonConverter to apply to this class.
final
createFactory → bool?: If true (the default), a private, static _$ExampleFromJson method is created in the generated part file.
final
createFieldMap → bool?: If true (defaults to false), a private, static _$ExampleJsonMeta constant is created in the generated part file.
final
createJsonKeys → bool?: If true (defaults to false), a private class _$ExampleJsonKeys class is created in the generated part file.
final
createPerFieldToJson → bool?: If true (defaults to false), a private, static _$ExamplePerFieldToJson abstract class will be generated in the 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 generated FromJson function will ignore unrecognized keys in the provided JSON Map.
final
explicitToJson → bool?: If true, generated toJson methods will explicitly call toJson 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 for fromJson and/or toJson to support serializing values of those types.
final
hashCode → int: The hash code for this object.
no setterinherited
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
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>
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.

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.