MockBackend

ClassStability: Experimental

Class Overview

class MockBackend {
constructor()

connections : any
connectionsArray : MockConnection[]
pendingConnections : any
verifyNoPendingRequests()
resolveAllConnections()
createConnection(req: Request) : MockConnection

}

Class Description

A mock backend for testing the Http service.

This class can be injected in tests, and should be used to override providers to other backends, such as XHRBackend.

Example

  1. import {BaseRequestOptions, Http} from '@angular/http';
  2. import {MockBackend} from '@angular/http/testing';
  3. it('should get some data', inject([AsyncTestCompleter], (async) => {
  4.   var connection;
  5.   var injector = Injector.resolveAndCreate([
  6.     MockBackend,
  7.     {provide: Http, useFactory: (backend, options) => {
  8.       return new Http(backend, options);
  9.     }, deps: [MockBackend, BaseRequestOptions]}]);
  10.   var http = injector.get(Http);
  11.   var backend = injector.get(MockBackend);
  12.   //Assign any newly-created connection to local variable
  13.   backend.connections.subscribe(c => connection = c);
  14.   http.request('data.json').subscribe((res) => {
  15.     expect(res.text()).toBe('awesome');
  16.     async.done();
  17.   });
  18.   connection.mockRespond(new Response('awesome'));
  19. }));

This method only exists in the mock implementation, not in real Backends.

Class Export

export class MockBackend

Annotations

@Injectable()

Constructor

constructor()

Class Details

connections : any

EventEmitter of MockConnection instances that have been created by this backend. Can be subscribed to in order to respond to connections.

  1. import {Http, BaseRequestOptions, Response} from '@angular/http';
  2. import {MockBackend} from '@angular/http/testing';
  3. import {Injector, provide} from '@angular/core';
  5. it('should get a response', () => {
  6.   var connection; //this will be set when a new connection is emitted from the backend.
  7.   var text; //this will be set from mock response
  8.   var injector = Injector.resolveAndCreate([
  9.     MockBackend,
  10.     {provide: Http, useFactory: (backend, options) => {
  11.       return new Http(backend, options);
  12.     }, deps: [MockBackend, BaseRequestOptions]}]);
  13.   var backend = injector.get(MockBackend);
  14.   var http = injector.get(Http);
  15.   backend.connections.subscribe(c => connection = c);
  16.   http.request('something.json').subscribe(res => {
  17.     text = res.text();
  18.   });
  19.   connection.mockRespond(new Response({body: 'Something'}));
  20.   expect(text).toBe('Something');
  21. });

This property only exists in the mock implementation, not in real Backends.

connectionsArray : MockConnection[]

An array representation of connections. This array will be updated with each connection that is created by this backend.

This property only exists in the mock implementation, not in real Backends.

pendingConnections : any

EventEmitter of MockConnection instances that haven't yet been resolved (i.e. with a readyState less than 4). Used internally to verify that no connections are pending via the verifyNoPendingRequests method.

This property only exists in the mock implementation, not in real Backends.

verifyNoPendingRequests()

Checks all connections, and raises an exception if any connection has not received a response.

This method only exists in the mock implementation, not in real Backends.

resolveAllConnections()

Can be used in conjunction with verifyNoPendingRequests to resolve any not-yet-resolve connections, if it's expected that there are connections that have not yet received a response.

This method only exists in the mock implementation, not in real Backends.

createConnection(req: Request) : MockConnection

Creates a new MockConnection. This is equivalent to calling new MockConnection(), except that it also will emit the new Connection to the connections emitter of this MockBackend instance. This method will usually only be used by tests against the framework itself, not by end-users.

exported from @angular/http/testing defined in @angular/http/testing/mock_backend.ts (line 112)