Skip to content

Commit 6d173ae

Browse files
Yahkobpkozlowski-opensource
Yahkob
authored and
pkozlowski-opensource
committed
docs($httpBackend): enhance readability
Closes angular#10852
1 parent d0ceeaa commit 6d173ae

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

‎src/ngMock/angular-mocks.js

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,8 +1227,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
12271227
* Creates a new backend definition.
12281228
*
12291229
* @param {string} method HTTP method.
1230-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1231-
* and returns true if the url match the current definition.
1230+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1231+
* and returns true if the url matches the current definition.
12321232
* @param {(string|RegExp|function(string))=} data HTTP request body or function that receives
12331233
* data string and returns true if the data is as expected.
12341234
* @param {(Object|function(Object))=} headers HTTP headers or function that receives http header
@@ -1273,8 +1273,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
12731273
* @description
12741274
* Creates a new backend definition for GET requests. For more info see `when()`.
12751275
*
1276-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1277-
* and returns true if the url match the current definition.
1276+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1277+
* and returns true if the url matches the current definition.
12781278
* @param {(Object|function(Object))=} headers HTTP headers.
12791279
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
12801280
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1287,8 +1287,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
12871287
* @description
12881288
* Creates a new backend definition for HEAD requests. For more info see `when()`.
12891289
*
1290-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1291-
* and returns true if the url match the current definition.
1290+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1291+
* and returns true if the url matches the current definition.
12921292
* @param {(Object|function(Object))=} headers HTTP headers.
12931293
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
12941294
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1301,8 +1301,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
13011301
* @description
13021302
* Creates a new backend definition for DELETE requests. For more info see `when()`.
13031303
*
1304-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1305-
* and returns true if the url match the current definition.
1304+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1305+
* and returns true if the url matches the current definition.
13061306
* @param {(Object|function(Object))=} headers HTTP headers.
13071307
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
13081308
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1315,8 +1315,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
13151315
* @description
13161316
* Creates a new backend definition for POST requests. For more info see `when()`.
13171317
*
1318-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1319-
* and returns true if the url match the current definition.
1318+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1319+
* and returns true if the url matches the current definition.
13201320
* @param {(string|RegExp|function(string))=} data HTTP request body or function that receives
13211321
* data string and returns true if the data is as expected.
13221322
* @param {(Object|function(Object))=} headers HTTP headers.
@@ -1331,8 +1331,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
13311331
* @description
13321332
* Creates a new backend definition for PUT requests. For more info see `when()`.
13331333
*
1334-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1335-
* and returns true if the url match the current definition.
1334+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1335+
* and returns true if the url matches the current definition.
13361336
* @param {(string|RegExp|function(string))=} data HTTP request body or function that receives
13371337
* data string and returns true if the data is as expected.
13381338
* @param {(Object|function(Object))=} headers HTTP headers.
@@ -1347,8 +1347,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
13471347
* @description
13481348
* Creates a new backend definition for JSONP requests. For more info see `when()`.
13491349
*
1350-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1351-
* and returns true if the url match the current definition.
1350+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1351+
* and returns true if the url matches the current definition.
13521352
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
13531353
* request is handled. You can save this object for later use and invoke `respond` again in
13541354
* order to change how a matched request is handled.
@@ -1363,8 +1363,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
13631363
* Creates a new request expectation.
13641364
*
13651365
* @param {string} method HTTP method.
1366-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1367-
* and returns true if the url match the current definition.
1366+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1367+
* and returns true if the url matches the current definition.
13681368
* @param {(string|RegExp|function(string)|Object)=} data HTTP request body or function that
13691369
* receives data string and returns true if the data is as expected, or Object if request body
13701370
* is in JSON format.
@@ -1402,8 +1402,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14021402
* @description
14031403
* Creates a new request expectation for GET requests. For more info see `expect()`.
14041404
*
1405-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1406-
* and returns true if the url match the current definition.
1405+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1406+
* and returns true if the url matches the current definition.
14071407
* @param {Object=} headers HTTP headers.
14081408
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
14091409
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1416,8 +1416,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14161416
* @description
14171417
* Creates a new request expectation for HEAD requests. For more info see `expect()`.
14181418
*
1419-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1420-
* and returns true if the url match the current definition.
1419+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1420+
* and returns true if the url matches the current definition.
14211421
* @param {Object=} headers HTTP headers.
14221422
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
14231423
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1430,8 +1430,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14301430
* @description
14311431
* Creates a new request expectation for DELETE requests. For more info see `expect()`.
14321432
*
1433-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1434-
* and returns true if the url match the current definition.
1433+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1434+
* and returns true if the url matches the current definition.
14351435
* @param {Object=} headers HTTP headers.
14361436
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
14371437
* request is handled. You can save this object for later use and invoke `respond` again in
@@ -1444,8 +1444,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14441444
* @description
14451445
* Creates a new request expectation for POST requests. For more info see `expect()`.
14461446
*
1447-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1448-
* and returns true if the url match the current definition.
1447+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1448+
* and returns true if the url matches the current definition.
14491449
* @param {(string|RegExp|function(string)|Object)=} data HTTP request body or function that
14501450
* receives data string and returns true if the data is as expected, or Object if request body
14511451
* is in JSON format.
@@ -1461,8 +1461,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14611461
* @description
14621462
* Creates a new request expectation for PUT requests. For more info see `expect()`.
14631463
*
1464-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1465-
* and returns true if the url match the current definition.
1464+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1465+
* and returns true if the url matches the current definition.
14661466
* @param {(string|RegExp|function(string)|Object)=} data HTTP request body or function that
14671467
* receives data string and returns true if the data is as expected, or Object if request body
14681468
* is in JSON format.
@@ -1478,8 +1478,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14781478
* @description
14791479
* Creates a new request expectation for PATCH requests. For more info see `expect()`.
14801480
*
1481-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1482-
* and returns true if the url match the current definition.
1481+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1482+
* and returns true if the url matches the current definition.
14831483
* @param {(string|RegExp|function(string)|Object)=} data HTTP request body or function that
14841484
* receives data string and returns true if the data is as expected, or Object if request body
14851485
* is in JSON format.
@@ -1495,8 +1495,8 @@ function createHttpBackendMock($rootScope, $timeout, $delegate, $browser) {
14951495
* @description
14961496
* Creates a new request expectation for JSONP requests. For more info see `expect()`.
14971497
*
1498-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1499-
* and returns true if the url match the current definition.
1498+
* @param {string|RegExp|function(string)} url HTTP url or function that receives an url
1499+
* and returns true if the url matches the current definition.
15001500
* @returns {requestHandler} Returns an object with `respond` method that controls how a matched
15011501
* request is handled. You can save this object for later use and invoke `respond` again in
15021502
* order to change how a matched request is handled.
@@ -1906,8 +1906,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19061906
* Creates a new backend definition.
19071907
*
19081908
* @param {string} method HTTP method.
1909-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1910-
* and returns true if the url match the current definition.
1909+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1910+
* and returns true if the url matches the current definition.
19111911
* @param {(string|RegExp)=} data HTTP request body.
19121912
* @param {(Object|function(Object))=} headers HTTP headers or function that receives http header
19131913
* object and returns true if the headers match the current definition.
@@ -1934,8 +1934,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19341934
* @description
19351935
* Creates a new backend definition for GET requests. For more info see `when()`.
19361936
*
1937-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1938-
* and returns true if the url match the current definition.
1937+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1938+
* and returns true if the url matches the current definition.
19391939
* @param {(Object|function(Object))=} headers HTTP headers.
19401940
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
19411941
* control how a matched request is handled. You can save this object for later use and invoke
@@ -1949,8 +1949,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19491949
* @description
19501950
* Creates a new backend definition for HEAD requests. For more info see `when()`.
19511951
*
1952-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1953-
* and returns true if the url match the current definition.
1952+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1953+
* and returns true if the url matches the current definition.
19541954
* @param {(Object|function(Object))=} headers HTTP headers.
19551955
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
19561956
* control how a matched request is handled. You can save this object for later use and invoke
@@ -1964,8 +1964,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19641964
* @description
19651965
* Creates a new backend definition for DELETE requests. For more info see `when()`.
19661966
*
1967-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1968-
* and returns true if the url match the current definition.
1967+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1968+
* and returns true if the url matches the current definition.
19691969
* @param {(Object|function(Object))=} headers HTTP headers.
19701970
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
19711971
* control how a matched request is handled. You can save this object for later use and invoke
@@ -1979,8 +1979,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19791979
* @description
19801980
* Creates a new backend definition for POST requests. For more info see `when()`.
19811981
*
1982-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1983-
* and returns true if the url match the current definition.
1982+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1983+
* and returns true if the url matches the current definition.
19841984
* @param {(string|RegExp)=} data HTTP request body.
19851985
* @param {(Object|function(Object))=} headers HTTP headers.
19861986
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
@@ -1995,8 +1995,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
19951995
* @description
19961996
* Creates a new backend definition for PUT requests. For more info see `when()`.
19971997
*
1998-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
1999-
* and returns true if the url match the current definition.
1998+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
1999+
* and returns true if the url matches the current definition.
20002000
* @param {(string|RegExp)=} data HTTP request body.
20012001
* @param {(Object|function(Object))=} headers HTTP headers.
20022002
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
@@ -2011,8 +2011,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
20112011
* @description
20122012
* Creates a new backend definition for PATCH requests. For more info see `when()`.
20132013
*
2014-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
2015-
* and returns true if the url match the current definition.
2014+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
2015+
* and returns true if the url matches the current definition.
20162016
* @param {(string|RegExp)=} data HTTP request body.
20172017
* @param {(Object|function(Object))=} headers HTTP headers.
20182018
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
@@ -2027,8 +2027,8 @@ angular.module('ngMockE2E', ['ng']).config(['$provide', function($provide) {
20272027
* @description
20282028
* Creates a new backend definition for JSONP requests. For more info see `when()`.
20292029
*
2030-
* @param {string|RegExp|function(string)} url HTTP url or function that receives the url
2031-
* and returns true if the url match the current definition.
2030+
* @param {string|RegExp|function(string)} url HTTP url or function that receives a url
2031+
* and returns true if the url matches the current definition.
20322032
* @returns {requestHandler} Returns an object with `respond` and `passThrough` methods that
20332033
* control how a matched request is handled. You can save this object for later use and invoke
20342034
* `respond` or `passThrough` again in order to change how a matched request is handled.

0 commit comments

Comments
 (0)