Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

laravel-echo

laravel783.3kMIT2.1.4TypeScript support: included

Laravel Echo library for beautiful Pusher and Socket.IO integration

laravel, pusher, ably

readme

Logo Laravel Echo

Build Status Total Downloads Latest Stable Version License

Introduction

In many modern web applications, WebSockets are used to implement realtime, live-updating user interfaces. When some data is updated on the server, a message is typically sent over a WebSocket connection to be handled by the client. This provides a more robust, efficient alternative to continually polling your application for changes.

To assist you in building these types of applications, Laravel makes it easy to "broadcast" your events over a WebSocket connection. Broadcasting your Laravel events allows you to share the same event names between your server-side code and your client-side JavaScript application.

Laravel Echo is a JavaScript library that makes it painless to subscribe to channels and listen for events broadcast by Laravel. You may install Echo via the NPM package manager.

Official Documentation

Documentation for Echo can be found on the Laravel website.

Contributing

Thank you for considering contributing to Echo! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Laravel Echo is open-sourced software licensed under the MIT license.

changelog

Release Notes

Unreleased

v1.17.1 - 2024-11-26

v1.17.0 - 2024-11-12

v1.16.1 - 2024-04-09

v1.16.0 - 2024-02-20

v1.15.3 - 2023-08-29

v1.15.2 - 2023-07-11

v1.15.1 - 2023-04-26

v1.15.0 - 2023-01-17

Added

v1.14.2 - 2022-11-22

Fixed

v1.14.1 - 2022-10-25

Fixed

v1.14.0 - 2022-08-30

Added

v1.13.1 - 2022-08-02

Changed

v1.13.0 - 2022-07-26

Added

v1.12.1 - 2022-07-13

Fixed

v1.12.0 - 2022-06-21

Added

v1.11.7 - 2022-04-21

No significant changes.

v1.11.6 - 2022-04-21

No significant changes.

v1.11.5 - 2022-04-12

Changed

v1.11.4 - 2022-03-15

Changed

v1.11.3 (2021-10-26)

Fixed

  • Fix types in connector.ts (#327)

v1.11.2 (2021-08-31)

Changed

  • Package build

v1.11.1 (2021-08-03)

Changed

  • Extend presence channel by channel class (#318)

v1.11.0 (2021-06-17)

Added

  • Add listenToAll and stopListeningToAll (#315)

v1.10.0 (2020-12-19)

Added

  • Add optional callback argument to stopListening() (#292)

v1.9.0 (2020-10-13)

Added

  • Register subscription succeeded callbacks (#288)

v1.8.1 (2020-07-31)

Added

  • Implement error handling with support for Pusher (#284)

v1.8.0 (2020-05-16)

Fixed

  • IE11 fix for dist/echo.js not being transpiled to ES5 (#270)

v1.7.0 (2020-04-03)

Added

  • Add pusher private-encrypted (#264)

v1.6.1 (2019-10-01)

Fixed

  • Change check for 'querySelector' method for browser compatibility (#253)

v1.6.0 (2019-09-24)

Added

  • Add stopWhisper method to channel (#243)
  • Add option this.options.withoutInterceptors (#248)
  • Add support for custom connectors (#247)

Fixed

  • Check for querySelector (#251)

v1.5.4 (2019-06-14)

Fixed

  • Ensure passed param wins over global (#235)

v1.5.3 (2019-02-14)

Fixed

  • Add reference to TS declaration file (#222)
  • Add missing method to Echo instance (fd3b65b)

v1.5.2 (2018-12-12)

Added

  • Add iife output to dist (#214)
  • Add leaveOne method to connectors (#216, 9809405)

v1.5.1 (2018-12-05)

Added

  • Add commonjs output to distribution (#212)

v1.5.0 (2018-12-01)

Changed

  • General maintenance, code styling, and add stopListening() for socket.io (#210)