angel_file_service 1.1.0+2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 81

file_service

Angel service that persists data to a file on disk, stored as a JSON list. It uses a simple mutex to prevent race conditions, and caches contents in memory until changes are made.

The file will be created on read/write, if it does not already exist.

This package is useful in development, as it prevents you from having to install an external database to run your server.

When running a multi-threaded server, there is no guarantee that file operations will be mutually excluded. Thus, try to only use this one a single-threaded server if possible, or one with very low load.

While not necessarily slow, this package makes no promises about performance.

Usage

configureServer(Angel app) async {
  // Just like a normal service
  app.use(
    '/api/todos',
    new JsonFileService(
      const LocalFileSystem().file('todos_db.json')
    ),
  );
}

1.1.0+2

  • create now uses the underlying store, instead of manually patching

1.1.0+1

  • Analyzer nitpick for pana

1.1.0

  • Updated to framework v1.1.x
  • Use package:file
  • Allow a custom store

1. Depend on it

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


dependencies:
  angel_file_service: "^1.1.0+2"

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:angel_file_service/angel_file_service.dart';
        
Version Uploaded Documentation Archive
1.1.0+2 Dec 22, 2017 Go to the documentation of angel_file_service 1.1.0+2 Download angel_file_service 1.1.0+2 archive
1.1.0+1 Dec 21, 2017 Go to the documentation of angel_file_service 1.1.0+1 Download angel_file_service 1.1.0+1 archive
1.1.0 Dec 21, 2017 Go to the documentation of angel_file_service 1.1.0 Download angel_file_service 1.1.0 archive
1.0.0 Jun 13, 2017 Go to the documentation of angel_file_service 1.0.0 Download angel_file_service 1.0.0 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

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

Platforms

Detected platforms: other

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

Suggestions

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

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

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0
angel_framework ^1.1.0-alpha 1.1.0+3
file ^2.0.0 2.3.5
pool ^1.0.0 1.3.4
Transitive dependencies
angel_http_exception 1.0.0
angel_model 1.0.0
angel_route 2.0.5
async 2.0.3
body_parser 1.0.3
charcode 1.1.1
collection 1.14.5
combinator 1.0.0-beta+7
container 0.1.2
http_server 0.9.7
intl 0.15.2
json_god 2.0.0-beta+1
logging 0.11.3+1
matcher 0.12.1+4
merge_map 1.0.0
meta 1.1.2
mime 0.9.6
path 1.5.1
quiver_hashcode 1.0.0
random_string 0.0.1
source_span 1.4.0
stack_trace 1.9.1
string_scanner 1.0.2
tuple 1.0.1