laravel_echo 0.0.2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new52

Laravel Echo for Flutter #

Basically, this package is port of official Laravel Echo javascript library. It helps subscribe to channels and listen for events broadcast from your Laravel app.

Three connectors available:

  • [ ] Pusher
  • [x] Socket.io
  • [x] Null

Getting started #

For now, only socket.io connector implemented. You need to install socket_io_client for your Flutter app.

In your pubspec.yaml file:

dependencies:
  ...
  socket_io_client: ^0.9.1
  laravel_echo:

Usage: #

IO.Socket socket = IO.io('http://localhost:6001', <String, dynamic>{'transports': ['websocket']});

Echo echo = new Echo({
  'broadcaster': 'socket.io',
  'client': socket,
});

echo.channel('test').listen('TestEvent', (e) {
  print(e);
});

socket.on('connect', (_) => print('connect'));
socket.on('disconnect', (_) => print('disconnect'));

Package by Kakajan SH

[0.0.1] - TODO: Add release date.

  • TODO: Describe initial release.

Use this package as a library

1. Depend on it

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


dependencies:
  laravel_echo: ^0.0.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support 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:laravel_echo/laravel_echo.dart';
  
Version Uploaded Documentation Archive
0.0.2 Feb 9, 2019 Go to the documentation of laravel_echo 0.0.2 Download laravel_echo 0.0.2 archive
0.0.1 Feb 9, 2019 Go to the documentation of laravel_echo 0.0.1 Download laravel_echo 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
20
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
52
Learn more about scoring.

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

  • Dart: 2.1.0
  • pana: 0.12.13+1
  • Flutter: 1.2.1

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/src/channel/channel.dart.

Run flutter format to format lib/src/channel/channel.dart.

Format lib/src/channel/presence-channel.dart.

Run flutter format to format lib/src/channel/presence-channel.dart.

Format lib/src/channel/socketio-channel.dart.

Run flutter format to format lib/src/channel/socketio-channel.dart.

Fix additional 6 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/src/channel/socketio-presence-channel.dart (Run flutter format to format lib/src/channel/socketio-presence-channel.dart.)
  • lib/src/channel/socketio-private-channel.dart (Run flutter format to format lib/src/channel/socketio-private-channel.dart.)
  • lib/src/connector/connector.dart (Run flutter format to format lib/src/connector/connector.dart.)
  • lib/src/connector/null-connector.dart (Run flutter format to format lib/src/connector/null-connector.dart.)
  • lib/src/connector/socketio-connector.dart (Run flutter format to format lib/src/connector/socketio-connector.dart.)
  • lib/src/util/event-formatter.dart (Run flutter format to format lib/src/util/event-formatter.dart.)

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and laravel_echo.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test