dirty_check 0.1.0

  • README.md
  • Installing
  • Versions
  • 45

dirty_check

Observe and be notified when a value changes.

Warning: This is not an official Google or Dart project.

Installation

dependencies:
  dirty_check: ^0.1.0

Usage

This library uses Zones in order to be notified when the VM event loop ends. As such you'll need to run some or all of your code inside of a specific function, runChecked, in order to receive updates:

import 'package:dirty_check/dirty_check.dart';

main() {
  runChecked(() => startYourApp());
}

You can then use the observe top-level function to receive a Stream which updates when the observed method or closure changes in value. For example to be notified when Person#name changes:

set person(Person person) {
  observe(() => person.name).listen((newName) {
    print('The user renamed themselves $newName.');
  });
}

Limitations

In order to avoid performance or code-bloat on some platforms, this library does not use dart:mirrors, which means it does not have knowledge of class structure. As such it may not be practical to use this library to arbitrarily observe many properties on an object.

Users are encouraged to explore alternative APIs/code generation :)

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  dirty_check: "^0.1.0"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:dirty_check/dirty_check.dart';
  
Version Uploaded Documentation Archive
0.1.0 Jun 8, 2017 Go to the documentation of dirty_check 0.1.0 Download dirty_check 0.1.0 archive

Analysis

We analyzed this package on Jun 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
77 / 100
Overall score:
Weighted score of the above. [more]
45
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:dirty_check/dirty_check.dart.

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • Package is getting outdated.

    The package was released 53 weeks ago.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use dirty_check.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.22.0 <2.0.0
async_track ^0.2.0 0.2.0
Transitive dependencies
meta 1.1.5
path 1.6.1
stack_trace 1.9.2
Dev dependencies
test ^0.12.20