box 0.1.1

  • README.md
  • Installing
  • Versions
  • 40

Dart Box

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 FileBox('.box/test');
List<User> users = await box.selectFrom<User>()
                            .where('name').like('C%')
                            .orderBy('name').ascending()
                            .list();
users.forEach((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.1.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub 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.1.1 Dec 5, 2018 Go to the documentation of box 0.1.1 Download box 0.1.1 archive
0.1.0 Dec 5, 2018 Go to the documentation of box 0.1.0 Download box 0.1.0 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

All 14 versions...

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

We analyzed this package on Jan 15, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.10

Platforms

Detected platforms: other

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

Health issues and suggestions

Document public APIs. (-0.43 points)

51 out of 52 API elements (library, class, field or method) have no adequate dartdoc content. Good documentation improves code readability and discoverability through search.

Format lib/core.dart.

Run dartfmt to format lib/core.dart.

Format lib/file.dart.

Run dartfmt to format lib/file.dart.

Format lib/memory.dart.

Run dartfmt to format lib/memory.dart.

Maintenance issues and suggestions

Maintain CHANGELOG.md. (-20 points)

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

The description is too short. (-20 points)

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

Maintain an example. (-10 points)

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 >=2.0.0 <3.0.0
collection ^1.14.11 1.14.11
io ^0.3.3 0.3.3
reflective ^0.1.1 0.1.1
Transitive dependencies
charcode 1.1.2
meta 1.1.7
path 1.6.2
source_span 1.5.1
string_scanner 1.0.4
term_glyph 1.1.0
Dev dependencies
test any