platform/packages/orm/angel_orm_service/README.md
Tobe O 6db839928b Add 'packages/orm/' from commit 'ceb58a25b58eeabeeab5a0bb6257f144e150dc24'
git-subtree-dir: packages/orm
git-subtree-mainline: edfd785dfe
git-subtree-split: ceb58a25b5
2020-02-15 18:22:15 -05:00

1,004 B

angel_orm_service

Pub build status

Service implementation that wraps over Angel ORM Query classes.

Installation

In your pubspec.yaml:

dependencies:
    angel_orm_service: ^1.0.0

Usage

Brief snippet (check example/main.dart for setup, etc.):

// Create an ORM-backed service.
  var todoService = OrmService<int, Todo, TodoQuery>(
      executor, () => TodoQuery(),
      readData: (req, res) => todoSerializer.decode(req.bodyAsMap));

  // Because we provided `readData`, the todoService can face the Web.
  // **IMPORTANT: Providing the type arguments is an ABSOLUTE MUST, if your
  // model has `int` ID's (this is the case when using `angel_orm_generator` and `Model`).
  // **
  app.use<int, Todo, OrmService<int, Todo, TodoQuery>>(
      '/api/todos', todoService);