box 0.0.14

  • README.md
  • Installing
  • Versions
  • 49

Dart Box

Build Status

A fluent Dart persistence API inspired by SQL. This library is still in an early phase of development. Currently Box has two implementations.

  • Box: a very simple implementation that runs completely in-memory.
  • FileBox: an in-memory implementation that persists data to a simple JSON file.

Support for various SQL and NoSQL databases is on the roadmap.

Example:

Box box = new Box.file('.box/test');
Stream<User> users = box.selectFrom(User)
                                 .where('name').like('C%')
                                 .orderBy('name').ascending()
                                 .list();
users.listen((user) => print(user.name)));

Use this package as a library

1. Depend on it

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


dependencies:
  box: "^0.0.14"

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:box/box.dart';
  
Version Uploaded Documentation Archive
0.0.14 Mar 27, 2016 Go to the documentation of box 0.0.14 Download box 0.0.14 archive
0.0.13 Dec 1, 2015 Go to the documentation of box 0.0.13 Download box 0.0.13 archive
0.0.12 Nov 26, 2015 Go to the documentation of box 0.0.12 Download box 0.0.12 archive
0.0.11 Nov 25, 2015 Go to the documentation of box 0.0.11 Download box 0.0.11 archive
0.0.9 Nov 25, 2015 Go to the documentation of box 0.0.9 Download box 0.0.9 archive
0.0.7 Nov 24, 2015 Go to the documentation of box 0.0.7 Download box 0.0.7 archive
0.0.6 Nov 24, 2015 Go to the documentation of box 0.0.6 Download box 0.0.6 archive
0.0.5 Apr 21, 2015 Go to the documentation of box 0.0.5 Download box 0.0.5 archive
0.0.4 Apr 21, 2015 Go to the documentation of box 0.0.4 Download box 0.0.4 archive
0.0.3 Feb 11, 2015 Go to the documentation of box 0.0.3 Download box 0.0.3 archive

All 12 versions...

Analysis

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

  • Dart: 2.0.0-dev.54.0
  • pana: 0.11.1

Scores

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

Platforms

Detected platforms: Flutter, other

Primary library: package:box/box.dart with components: io.

Suggestions

  • Maintain CHANGELOG.md.

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

  • 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.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 11 hints.

    Strong-mode analysis of lib/box.dart gave the following hint:

    line: 7 col: 1
    'dart.pkg.collection.equality' is deprecated and shouldn't be used.

    Run dartfmt to format lib/src/core.dart.

    Similar analysis of the following files failed:

    • lib/src/file.dart (hint)
  • 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 box.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.10.0
collection >=1.0.0 <2.0.0 1.14.9
exportable >=0.1.0 <0.2.0 0.1.0
io >=0.1.0-git <0.2.0-git 0.1.0-git 0.3.2+1
reflective >=0.0.0 <0.1.0 0.0.29
Transitive dependencies
charcode 1.1.1
path 1.5.1
source_span 1.4.0
string_scanner 1.0.2
yaml 2.1.13
Dev dependencies
test any