angular-websocket

v2.0.1

An Angular WebSocket service for connecting client applications to servers. For more information about how to use this package see README

Latest version published 8 years ago

License: MIT

NPM

GitHub

Package Health Score

48 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.1	\|	08/2016	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	04/2016		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.5	\|	12/2013		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (3,765)

GitHub Stars: 1.22K
Forks: 195
Contributors: 20

Direct Usage Popularity

The npm package angular-websocket receives a total of 3,765 downloads a week. As such, we scored angular-websocket popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package angular-websocket, we found that it has been starred 1,216 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the angular-websocket repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like angular-websocket is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 57
Open PR: 7
Last Release: 8 years ago
Last Commit: 7 years ago

Further analysis of the maintenance status of angular-websocket based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for angular-websocket is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 11 years
Dependencies: 2 Direct
Versions: 22
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 2
TS Typings: Yes

angular-websocket has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Angular Websocket

Status: Looking for feedback about new API changes

An AngularJS 1.x WebSocket service for connecting client applications to servers.

How do I add this to my project?

You can download angular-websocket by:

(prefered) Using bower and running bower install angular-websocket --save
Using npm and running npm install angular-websocket --save
Downloading it manually by clicking here to download development unminified version
CDN for development https://rawgit.com/gdi2290/angular-websocket/v1.0.9/angular-websocket.js
CDN for production https://cdn.rawgit.com/gdi2290/angular-websocket/v1.0.9/angular-websocket.min.js

Usage

  
  
  <section>
    <ul>
      <li> {{ data }} </li>
    </ul>
  </section>

API

Factory: `$websocket` (in module `ngWebSocket`)

returns instance of $Websocket

Methods

name	arguments	description
$websocket constructor	url:String	Creates and opens a WebSocket instance. `var ws = $websocket('ws://foo');`
send	data:String,Object returns	Adds data to a queue, and attempts to send if socket is ready. Accepts string or object, and will stringify objects before sending to socket.
onMessage	callback:Function options{filter:String,RegExp, autoApply:Boolean=true}	Register a callback to be fired on every message received from the websocket, or optionally just when the message's `data` property matches the filter provided in the options object. Each message handled will safely call `$rootScope.$digest()` unless `autoApply` is set to `false in the options. Callback gets called with a MessageEvent object.
onOpen	callback:Function	Function to be executed each time a socket connection is opened for this instance.
onClose	callback:Function	Function to be executed each time a socket connection is closed for this instance.
onError	callback:Function	Function to be executed each time a socket connection has an Error for this instance.
close	force:Boolean:optional	Close the underlying socket, as long as no data is still being sent from the client. Optionally force close, even if data is still being sent, by passing `true` as the `force` parameter. To check if data is being sent, read the value of `socket.bufferedAmount`.

Properties

name	type	description
socket	window.WebSocket	WebSocket instance.
sendQueue	Array	Queue of `send` calls to be made on socket when socket is able to receive data. List is populated by calls to the `send` method, but this array can be spliced if data needs to be manually removed before it's been sent to a socket. Data is removed from the array after it's been sent to the socket.
onOpenCallbacks	Array	List of callbacks to be executed when the socket is opened, initially or on re-connection after broken connection. Callbacks should be added to this list through the `onOpen` method.
onMessageCallbacks	Array	List of callbacks to be executed when a message is received from the socket. Callbacks should be added via the `onMessage` method.
onErrorCallbacks	Array	List of callbacks to be executed when an error is received from the socket. Callbacks should be added via the `onError` method.
onCloseCallbacks	Array	List of callbacks to be executed when the socket is closed. Callbacks should be added via the `onClose` method.
readyState	Number:readonly	Returns either the readyState value from the underlying WebSocket instance, or a proprietary value representing the internal state of the lib, e.g. if the lib is in a state of re-connecting.
initialTimeout	Number	The initial timeout, should be set at the outer limits of expected response time for the service. For example, if your service responds in 1ms on average but in 10ms for 99% of requests, then set to 10ms.
maxTimeout	Number	Should be as low as possible to keep your customers happy, but high enough that the system can definitely handle requests from all clients at that sustained rate.

CancelablePromise

This type is returned from the send() instance method of $websocket, inherits from $q.defer().promise.

Methods

name	arguments	description
cancel		Alias to `deferred.reject()`, allows preventing an unsent message from being sent to socket for any arbitrary reason.
then	resolve:Function, reject:Function	Resolves when message has been passed to socket, presuming the socket has a `readyState` of 1. Rejects if the socket is hopelessly disconnected now or in the future (i.e. the library is no longer attempting to reconnect). All messages are immediately rejected when the library has determined that re-establishing a connection is unlikely.

Service: `$websocketBackend` (in module `ngWebSocketMock`)

Similar to httpBackend mock in AngularJS's ngMock module. You can use ngWebSocketMock to mock a websocket server in order to test your applications:

    var $websocketBackend;

    beforeEach(angular.mock.module('ngWebSocket', 'ngWebSocketMock');

    beforeEach(inject(function (_$websocketBackend_) {
      $websocketBackend = _$websocketBackend_;

      $websocketBackend.mock();
      $websocketBackend.expectConnect('ws://localhost:8080/api');
      $websocketBackend.expectSend({data: JSON.stringify({test: true})});
    }));

Methods

name	arguments	description
flush		Executes all pending requests
expectConnect	url:String	Specify the url of an expected WebSocket connection
expectClose		Expect "close" to be called on the WebSocket
expectSend	msg:String	Expectation of send to be called, with required message
verifyNoOutstandingExpectation		Makes sure all expectations have been satisfied, should be called in afterEach
verifyNoOutstandingRequest		Makes sure no requests are pending, should be called in afterEach

Frequently asked questions

Q.: What if the browser doesn't support WebSockets?
A.: This module will not help; it does not have a fallback story for browsers that do not support WebSockets. Please check your browser target support here and to include fallback support.

Development

$ npm install
$ bower install

Changelog

Unit Tests

$ npm test Run karma in Chrome, Firefox, and Safari

Manual Tests

In the project root directory open index.html in the example folder or browserify example

Distribute

$ npm run dist Builds files with uglifyjs

Support, Questions, or Feedback

> Contact us anytime for anything about this repo or Angular 2

TODO

Allow JSON if object is sent
Allow more control over $digest cycle per WebSocket instance
Add Angular interceptors
Add .on(event)
Include more examples of patterns for realtime Angular apps
Allow for optional configuration object in $websocket constructor
Add W3C Websocket support
Add socket.io support
Add SockJS support
Add Faye support
Add PubNub support

enjoy — AngularClass

##AngularClass > Learn AngularJS, Angular 2, and Modern Web Development form the best. > Looking for corporate Angular training, want to host us, or Angular consulting? patrick@angularclass.com

License

MIT

angular-websocket dependencies

angular ws

FAQs

What is angular-websocket?

An Angular WebSocket service for connecting client applications to servers. Visit Snyk Advisor to see a full health score report for angular-websocket, including popularity, security, maintenance & community analysis.

Is angular-websocket popular?

The npm package angular-websocket receives a total of 3,765 weekly downloads. As such, angular-websocket popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is angular-websocket well maintained?

We found indications that angular-websocket is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is angular-websocket safe to use?

While scanning the latest version of angular-websocket, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 7 November-2024, at 14:15 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3,765)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Angular Websocket

Status: Looking for feedback about new API changes

How do I add this to my project?

Usage

API

Factory: $websocket (in module ngWebSocket)

Methods

Properties

CancelablePromise

Methods

Service: $websocketBackend (in module ngWebSocketMock)

Methods

Frequently asked questions

Development

Changelog

Unit Tests

Manual Tests

Distribute

Support, Questions, or Feedback

TODO

License

angular-websocket dependencies

angular-websocket development dependencies

FAQs

What is angular-websocket?

Is angular-websocket popular?

Is angular-websocket well maintained?

Is angular-websocket safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Factory: `$websocket` (in module `ngWebSocket`)

Service: `$websocketBackend` (in module `ngWebSocketMock`)