DocumentationL Custom Mapper

[xErik]

dart_mappable: ^0.9.1

Hi there, writing my own CustomMapper I have a suggestion for the documentation.

Maybe something along the lines below, demonstrating the handling of a slightly more complex situation involving custom objects and not just a String.

The current example shows decode: return (value as String) which may be outdated?

--------------------------------------------------

@CustomMapper()
class ItemRefMapper extends SimpleMapper<ItemRef> {
  ItemRefMapper();
  final String key = 'aSuperJsonKey';

  @override
  ItemRef decode(dynamic value) {
    return ItemRef(value[key]);
  }

  @override
  dynamic encode(ItemRef self) {
    return {key: self.val};
  }
}

class ItemRef {
  String val;
  ItemRef(this.val);

  @override
  String toString() {
    return val;
  }
}

@MappableClass(discriminatorKey: 'type')
abstract class Data {
  ItemRef itemRef;
  Data(this.itemRef);
}

@MappableClass()
class DataImpl extends Data {
  DataImpl(ItemRef itemRef) : super(itemRef);
}

[schultek]

Thanks for the feedback.

Maybe to both keep it simple and have a meaningful example, I could show a custom mapper for some core dart class, like Uri or BigInt?

[xErik]

Sure! Showing that a HashMap may be returned in decode would be helpful. I was not so sure what to expect and how to make it work in the beginning.

Thanks!