https://github.com/redsolver/getbykey

A simple dart extension to get an element in a list by it's key or id.
https://github.com/redsolver/getbykey

Last synced: about 2 months ago
JSON representation

A simple dart extension to get an element in a list by it's key or id.

• Host: GitHub
• URL: https://github.com/redsolver/getbykey
• Owner: redsolver
• License: mit
• Created: 2020-06-12T22:30:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-12T22:37:46.000Z (almost 5 years ago)
• Last Synced: 2025-01-26T11:11:12.790Z (3 months ago)
• Language: Dart
• Size: 5.86 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Get by Key

[![pub package](https://img.shields.io/pub/v/getbykey)](https://pub.dartlang.org/packages/getbykey)

A simple extension to get an element in a list by it's key or id.

## Why

This package replaces

`users.firstWhere((user) => user.id == myUuid, orElse: () => null)`

with

`users.getByKey(myUuid)`

in your code.

## Usage

To use this plugin, add `getbykey` as a [dependency in your pubspec.yaml file](https://flutter.dev/platform-plugins/).

Then add `import 'package:getbykey/getbykey.dart';` to your file to use the extension method.

Also you need to add a `$key` getter to the classes you wish to use in a list with this extension.

### Example

``` dart

import 'package:getbykey/getbykey.dart';

class User {

  String id;

  String name;

  User({this.id, this.name});

  String get $key => id; // Add the `$key` getter to your class. In this example class the `id` is the key

  @override

  String toString() => 'User{name: $name}';

}

var users = [

  User(

    id: '4b614020-1f3a-4f44-9435-5f834f8f4f90',

    name: 'Alice',

  ),

  User(

    id: 'eb40e648-d88f-45f3-bac0-26c8c392f4d9',

    name: 'Bob',

  ),

];

void main() {

  var user1 = users.getByKey('eb40e648-d88f-45f3-bac0-26c8c392f4d9');

  print(user1); // => User{name: Bob}

  var user2 = users.getByKey('this-key-does-not-exist');

  print(user2); // => null

  var user3 = users.getByKey('4b614020-1f3a-4f44-9435-5f834f8f4f90');

  print(user3); // => User{name: Alice}

}

```