angular-node-updated

2.0.0 • Public • Published

angular

AngularJS provided as a CommonJS module. Compiled with jsdom when running in Node. Useful for client-side apps built with Browserify and for testing AngularJS code in Node without depending on a browser.

Versioning

The version number of this module reflects the version of AngularJS it provides.

Why

For client-side apps using Browserify, this module provides a way for them to use AngularJS without shimming.

Having a version of AngularJS that works outside the browser could also be convenient for many reasons. The primary motivation was around testability and modularity of AngularJS related projects. For developers utilizing the CommonJS standard and Browserify to build AngularJS projects and ecosystems, the hope is that this module will greatly simplify their workflow.

As egghead.io has shown, testing simple views and directives is a great way to ensure the pieces of your app are working as intended. Unfortunately, testing this way usually requires running your code in a real browser via something like Karma, because AngularJS assumes window and document are both available. Additionally, AngularJS (via angular-mocks.js) only exposes the inject method shown in the egghead.io videos if window.jasmine is defined.

This module allows you to test AngularJS views and directives using any testing framework and runner you like, from Mocha to Nodeunit to tape.

This module also aims to make it much easier to create AngularJS directives, modules, and other components that can be independently published to and versioned on npm and/or their own repositories.

Examples

The inject method referenced above is really just a shortcut to $injector.invoke, but $injector is only available from within AngularJS. Fortunately, there are two ways to get a reference to Angular's injector from outside of AngularJS code.

// this will return a fresh instance of injector each time it's called
// if your code is not running in a browser you must use this method
var injector = angular.injector(['ng']);

// provided only as an FYI, the following method WILL NOT WORK outside a web browser
// this will return the injector singleton for the application in which <element> is defined.
// for code that runs in a browser you could just use document if ng-app is defined on <html>
// otherwise you can use any element that is a descendent of the tag your app is defined/bootstrapped on
var injector = angular.element(<element>).injector();

Testing view compilation

var angular = require('angular'),
    inject = angular.injector(['ng']).invoke,
    num;

inject(function ($rootScope, $compile) {
    var el = angular.element('<div>{{ 2 + 2 }}</div>');
    el = $compile(el)($rootScope);
    $rootScope.$digest();
    num = +el.html();
});

// num === 4

Testing event handling

var angular = require('angular'),
    inject = angular.injector(['ng']).invoke,
    answer;

inject(function ($rootScope) {
    $rootScope.$on('foo', function (e, val) {
        answer = val;
    });
    $rootScope.$broadcast('foo', 'bar')
});

// answer === 'bar'

How to build (reminder for myself)

Update package.json to the desired version, save but don't commit, then run node bin/build.js. Then git push and npm publish.

Package Sidebar

Install

npm i angular-node-updated

Weekly Downloads

2

Version

2.0.0

License

ISC

Last publish

Collaborators

  • jstacoder