MapConversionX<K, V> extension

Type conversion helpers for non-nullable Map instances.

Provides key-based value extraction with automatic type conversion. Each method looks up the value for key (with optional fallback to alternativeKeys) and converts it to the target type.

Example

final json = {'name': 'Alice', 'age': '25', 'active': 'true'};
final name = json.getString('name');      // 'Alice'
final age = json.getInt('age');           // 25
final active = json.getBool('active');    // true

Alternative Keys

When APIs vary in naming conventions, use alternativeKeys for resilience:

final id = json.getInt('id', alternativeKeys: ['ID', '_id', 'userId']);

Nested Navigation

For complex structures, use innerKey and innerListIndex:

final city = json.getString('address', innerKey: 'city');

See also: NullableMapConversionX for nullable-safe tryGetX variants.

on

• Map<K, V>

Properties

keysList → List<K>

Available on Map<K, V>, provided by the MapConversionX extension

Returns a list containing all the keys in the map.

no setter

keysSet → Set<K>

Available on Map<K, V>, provided by the MapConversionX extension

Returns a set containing all the keys in the map.

no setter

valuesList → List<V>

Available on Map<K, V>, provided by the MapConversionX extension

Returns a list containing all the values in the map.

no setter

valuesSet → Set<V>

Available on Map<K, V>, provided by the MapConversionX extension

Returns a set containing all the values in the map.

no setter

Methods

getBigInt(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, BigInt? defaultValue, ElementConverter<BigInt>? converter}) → BigInt

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to BigInt.

getBool(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, bool? defaultValue, ElementConverter<bool>? converter}) → bool

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to bool.

getDateTime(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, String? format, String? locale, bool autoDetectFormat = false, bool useCurrentLocale = false, bool utc = false, DateTime? defaultValue, ElementConverter<DateTime>? converter}) → DateTime

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to DateTime.

getDouble(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, double? defaultValue, String? format, String? locale, ElementConverter<double>? converter}) → double

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to double.

getEnum<T extends Enum>(K key, {required T parser(dynamic), List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, T? defaultValue, Map<String, dynamic>? debugInfo}) → T

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to an enum using parser.

getInt(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, int? defaultValue, String? format, String? locale, ElementConverter<int>? converter}) → int

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to int.

getList<T>(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, List<T>? defaultValue, ElementConverter<T>? elementConverter}) → List<T>

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to a List of T.

getMap<K2, V2>(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, Map<K2, V2>? defaultValue, ElementConverter<K2>? keyConverter, ElementConverter<V2>? valueConverter}) → Map<K2, V2>

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to a Map of K2 to V2.

getNum(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, num? defaultValue, String? format, String? locale, ElementConverter<num>? converter}) → num

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to num.

getSet<T>(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, Set<T>? defaultValue, ElementConverter<T>? elementConverter}) → Set<T>

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to a Set of T.

getString(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, String? defaultValue, ElementConverter<String>? converter}) → String

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to String.

getUri(K key, {List<K>? alternativeKeys, dynamic innerKey, int? innerListIndex, Uri? defaultValue, ElementConverter<Uri>? converter}) → Uri

Available on Map<K, V>, provided by the MapConversionX extension

Converts the value at key (or alternativeKeys) to Uri.

parse<T, K2, V2>(K key, T converter(Map<K2, V2> json)) → T

Available on Map<K, V>, provided by the MapConversionX extension

Parses the nested map at key using the provided converter.

tryParse<T, K2, V2>(K key, T converter(Map<K2, V2> json)) → T?

Available on Map<K, V>, provided by the MapConversionX extension

Tries to parse the nested map at key using the provided converter.