angel_client 2.0.1

  • Example
  • Installing
  • Versions
  • 81


Pub build status

Client library for the Angel framework. This library provides virtually the same API as an Angel server. The client can run in the browser, in Flutter, or on the command-line. In addition, the client supports angel_auth authentication.


// Choose one or the other, depending on platform
import 'package:angel_client/io.dart';
import 'package:angel_client/browser.dart';
import 'package:angel_client/flutter.dart';

main() async {
  Angel app = new Rest("http://localhost:3000");

You can call service to receive an instance of Service, which acts as a client to a service on the server at the given path (say that five times fast!).

foo() async {
  Service Todos = app.service("todos");
  List<Map> todos = await Todos.index();


The CLI client also supports reflection via json_god. There is no need to work with Maps; you can use the same class on the client and the server.

class Todo extends Model {
  String text;

  Todo({String this.text});

bar() async {
  // By the next release, this will just be:
  // app.service<Todo>("todos")
  Service Todos = app.service("todos", type: Todo);
  List<Todo> todos = await Todos.index();


Just like on the server, services support index, read, create, modify, update and remove.


Local auth:

var auth = await app.authenticate(type: 'local', credentials: {username: ..., password: ...});
print(; // User object

Revive an existing jwt:

Future<AngelAuthResult> reviveJwt(String jwt) {
  return app.authenticate(credentials: {'token': jwt});

Via Popup:

app.authenticateViaPopup('/auth/google').listen((jwt) {
  // Do something with the JWT

Resume a session from localStorage (browser only):

// Automatically checks for JSON-encoded 'token' in localStorage,
// and tries to revive it
await app.authenticate();


await app.logout();

Live Updates

Oftentimes, you will want to update a collection based on updates from a service. Use ServiceList for this case:

build(BuildContext context) async {
  var list = new ServiceList(app.service('api/todos'));
  return new StreamBuilder(
    stream: list.onChange,
    builder: _yourBuildFunction,


  • Change BaseAngelClient constructor to accept dynamic instead of String for `baseUrl.


  • Deprecate basePath in favor of baseUrl.
  • Angel now extends http.Client.
  • Deprecate auth_types.


  • Make Service index always return List<Data>.
  • Add


  • Refactor params to Map<String, dynamic>.


  • Depend on Dart 2.
  • Depend on Angel 2.
  • Remove dart2_constant.


  • Code cleanup + housekeeping, update to dart2_constant, and ensured build works with 2.0.0-dev.64.1.


  • Removed a type annotation in authenticateViaPopup to prevent breaking with DDC.


  • ServiceList now uses Equality from package:collection to compare items.
  • Services will now add service errors to corresponding streams if there is a listener.


  • ServiceList no longer ignores empty index events.


  • Updated ServiceList to also fire on index.


  • Added ServiceList.


import 'dart:async';
import 'package:angel_client/angel_client.dart';

Future doSomething(Angel app) async {
  var userService = app
      .service<String, Map<String, dynamic>>('api/users')
      .map(User.fromMap, User.toMap);

  var users = await userService.index();
  print('Name: ${}');

class User {
  final String name;


  static User fromMap(Map data) => User(name: data['name'] as String);

  static Map<String, String> toMap(User user) => {'name':};

Use this package as a library

1. Depend on it

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

  angel_client: ^2.0.1

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_client/angel_client.dart';
Version Uploaded Documentation Archive
2.0.1 Jan 6, 2019 Go to the documentation of angel_client 2.0.1 Download angel_client 2.0.1 archive
2.0.0 Jan 6, 2019 Go to the documentation of angel_client 2.0.0 Download angel_client 2.0.0 archive
1.2.0+1 Dec 27, 2017 Go to the documentation of angel_client 1.2.0+1 Download angel_client 1.2.0+1 archive
1.2.0 Dec 21, 2017 Go to the documentation of angel_client 1.2.0 Download angel_client 1.2.0 archive
1.1.0+3 Dec 13, 2017 Go to the documentation of angel_client 1.1.0+3 Download angel_client 1.1.0+3 archive
1.1.0+2 Dec 13, 2017 Go to the documentation of angel_client 1.1.0+2 Download angel_client 1.1.0+2 archive
1.1.0+1 Dec 10, 2017 Go to the documentation of angel_client 1.1.0+1 Download angel_client 1.1.0+1 archive
1.1.0 Dec 7, 2017 Go to the documentation of angel_client 1.1.0 Download angel_client 1.1.0 archive
1.0.7 Jun 30, 2017 Go to the documentation of angel_client 1.0.7 Download angel_client 1.0.7 archive
1.0.6 Jun 3, 2017 Go to the documentation of angel_client 1.0.6 Download angel_client 1.0.6 archive

All 44 versions...

Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
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


Detected platforms: Flutter, web, other

No platform restriction found in primary library package:angel_client/angel_client.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
angel_http_exception ^1.0.0 1.0.0+3
collection ^1.0.0 1.14.11
http ^0.12.0 0.12.0+1
json_god >=2.0.0-beta <3.0.0 2.0.0-beta+3
meta ^1.0.0 1.1.7
path ^1.0.0 1.6.2
Transitive dependencies
charcode 1.1.2
dart2_constant 1.0.2+dart2
http_parser 3.1.3
logging 0.11.3+2
source_span 1.5.1
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
angel_framework ^2.0.0-alpha
angel_model ^1.0.0
async ^2.0.0 2.0.8
build_runner ^1.0.0
build_web_compilers ^1.0.0
mock_request ^1.0.0
pedantic ^1.0.0
test ^1.0.0