angel_file_service 2.0.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 66

file_service

Pub build status

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')
    ),
  );
}

2.0.0

  • Dart/Angel 2 update.
  • Remove package:dart2_constant
  • Update package:file to ^5.0.0.

1.1.2

  • Added tests, because tests.

1.1.1

  • Dart 2 fixes.

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

example/main.dart

import 'package:angel_file_service/angel_file_service.dart';
import 'package:angel_framework/angel_framework.dart';
import 'package:file/local.dart';

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

Use this package as a library

1. Depend on it

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


dependencies:
  angel_file_service: ^2.0.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:angel_file_service/angel_file_service.dart';
  
Version Uploaded Documentation Archive
2.0.0 Oct 19, 2018 Go to the documentation of angel_file_service 2.0.0 Download angel_file_service 2.0.0 archive
1.1.2 Jul 12, 2018 Go to the documentation of angel_file_service 1.1.2 Download angel_file_service 1.1.2 archive
1.1.1 Jul 12, 2018 Go to the documentation of angel_file_service 1.1.1 Download angel_file_service 1.1.1 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
Popularity:
Describes how popular the package is relative to other packages. [more]
39
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
66
Learn more about scoring.

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

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, other

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

Maintenance suggestions

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.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
angel_framework ^2.0.0-alpha 2.0.0-alpha.14
file ^5.0.0 5.0.6
pool ^1.0.0 1.3.6
Transitive dependencies
angel_container 1.0.0
angel_http_exception 1.0.0+3
angel_model 1.0.0+1
angel_route 3.0.0
async 2.0.8
body_parser 1.1.1
charcode 1.1.2
code_buffer 1.0.1
collection 1.14.11
combinator 1.0.0+3
convert 2.0.2
crypto 2.0.6
dart2_constant 1.0.2+dart2
http2 0.1.9
http_parser 3.1.3
http_server 0.9.8+1
intl 0.15.7
logging 0.11.3+2
matcher 0.12.4
merge_map 1.0.1
meta 1.1.6
mime 0.9.6+2
mock_request 1.0.4
path 1.6.2
quiver 2.0.1
source_span 1.4.1
stack_trace 1.9.3
string_scanner 1.0.4
tuple 1.0.2
typed_data 1.1.6
uuid 1.0.3
Dev dependencies
test ^1.0.0