enum_assist_annotation library

Classes

EnumAssist: Annotation to assist enums with generating code.
EnumValue: Annotation to assist in generating code for enum values.
Extension<T extends Object?>: IMPORTANT: All properties (other than value) need to be defined within the super constructor!
JsonConverter<T, S>: Implement this class to provide custom converters for a specific Type.
JsonEnum: Allows configuration of how enum elements are treated as JSON.
JsonKey: An annotation used to specify how a field is serialized.
JsonLiteral: An annotation used to generate a private field containing the contents of a JSON file.
JsonSerializable: An annotation used to specify a class to generate code for.
JsonValue: An annotation used to specify how a enum value is serialized.
MapExtension<T extends Object?>: {@macro enum_assist_annotation.extension}
MaybeExtension<T extends Object?>: {@macro enum_assist_annotation.extension}
MethodTypeConv: Serializes MethodType to and from json
SerializedFormatConv: Serializes SerializedFormat to and from json

FieldRename: Values for the automatic field renaming behavior for JsonSerializable.
MethodType: Specifies how the generated method will be created
SerializedFormat: The serialized format of the enum's fields

MethodTypeX on MethodType: Extensions for the enum MethodType
SerializedFormatX on SerializedFormat: Extensions for the enum SerializedFormat

$checkedConvert<T>(Map map, String key, T castFunc(dynamic), {Object? readValue(Map, String)?}) → T: Helper function used in generated code when JsonSerializableGenerator.checked is true.
$checkedCreate<T>(String className, Map map, T constructor(S <S>(String, S (Object?), {Object? readValue(Map, String)?})), {Map<String, String> fieldKeyMap = const {}}) → T: Helper function used in generated code when JsonSerializableGenerator.checked is true.
$checkedNew<T>(String className, Map map, T constructor(), {Map<String, String>? fieldKeyMap}) → T: Helper function used in generated code when JsonSerializableGenerator.checked is true.
$checkKeys(Map map, {List<String>? allowedKeys, List<String>? requiredKeys, List<String>? disallowNullValues}) → void: Helper function used in generated fromJson code when JsonSerializable.disallowUnrecognizedKeys is true for an annotated type or JsonKey.required is true for any annotated fields.
$enumDecode<K extends Enum, V>(Map<K, V> enumValues, Object? source, {K? unknownValue}) → K: Returns the key associated with value source from enumValues, if one exists.
$enumDecodeNullable<K extends Enum, V>(Map<K, V> enumValues, Object? source, {Enum? unknownValue}) → K?: Returns the key associated with value source from enumValues, if one exists.

BadKeyException: A base class for exceptions thrown when decoding JSON.
CheckedFromJsonException: Exception thrown if there is a runtime exception in fromJson code generated when JsonSerializableGenerator.checked is true
DisallowedNullValueException: Exception thrown if there are keys with disallowed null values in a JSON map that was provided during deserialization.
MissingRequiredKeysException: Exception thrown if there are missing required keys in a JSON map that was provided during deserialization.
UnrecognizedKeysException: Exception thrown if there are unrecognized keys in a JSON map that was provided during deserialization.