Giter VIP home page Giter VIP logo

ngx-laravel-echo's Introduction

Angular Laravel Echo

This package is a simple service to allow easy integration of Laravel Echo into angular. The service tries to follow the general functionality of Laravel Echo as closely as possible. The most important difference is the use of Observable streams instead of callbacks for events/notifications, this simplifies integration into Angular a lot and (more importantly) makes sure only one listener per subscribed event/notification has to be created.

One important note is that (since Laravel Echo itself does not supply a way to stop listening for events) you must make sure to call leave for any channel that is no longer required, not just unsubscribe the event subscriptions (otherwise a memory leak will occur).

Versions

With the release of Angular 6.0, breaking changes were introduced in the form of the updated dependency on RxJS 6 so consult the following chart for what version of the package to use based on your version of Angular.

Angular Version Package Version
>= 6.0 1.0.25

Documentation

Add this to your app.module

import {EchoConfig, NgxLaravelEchoModule} from 'ngx-laravel-echo';

export const echoConfig: EchoConfig = {
    userModel: 'users',
    notificationNamespace: 'App\\Notifications',
    options: {
        broadcaster: 'pusher',
        key: '124',
        wsHost: 'api.test',
        authEndpoint: 'http://api.test/broadcasting/auth',
        host: 'api.test',
        wsPort: 6001,
        disableStats: true,
        namespace: ''
    }
};

imports: [
  NgxLaravelEchoModule.forRoot(echoConfig),
]

Contributors

ngx-laravel-echo's People

Contributors

maxiz22 avatar mmschuler avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.