Skip to content

Commit 4bb427a

Browse files
committed
API parameters are optional.
1 parent 901b97d commit 4bb427a

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,41 +92,41 @@ declare module scjs {
9292
* API GET request.
9393
*
9494
* @param {string} endpoint - Endpoint path
95-
* @param {Object} data - Parameters
95+
* @param {Object} data - (optional) Parameters
9696
* @return {Promise}
9797
* @api public
9898
*/
99-
get(endpoint: string, data: any): Promise<any>;
99+
get(endpoint: string, data?: any): Promise<any>;
100100

101101
/**
102102
* API POST request.
103103
*
104104
* @param {string} endpoint - Endpoint path
105-
* @param {Object} data - Parameters
105+
* @param {Object} data - (optional) Parameters
106106
* @return {Promise}
107107
* @api public
108108
*/
109-
post(endpoint: string, data: any): Promise<any>;
109+
post(endpoint: string, data?: any): Promise<any>;
110110

111111
/**
112112
* API PUT request.
113113
*
114114
* @param {string} endpoint - Endpoint path
115-
* @param {Object} data - Parameters
115+
* @param {Object} data - (optional) Parameters
116116
* @return {Promise}
117117
* @api public
118118
*/
119-
put(endpoint: string, data: any): Promise<any>;
119+
put(endpoint: string, data?: any): Promise<any>;
120120

121121
/**
122122
* API DELETE request.
123123
*
124124
* @param {string} endpoint - Endpoint path
125-
* @param {Object} data - Parameters
125+
* @param {Object} data - (optional) Parameters
126126
* @return {Promise}
127127
* @api public
128128
*/
129-
delete(endpoint: string, data: any): Promise<any>;
129+
delete(endpoint: string, data?: any): Promise<any>;
130130

131131
/**
132132
* Cached login response object.

index.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ function ConManager(baseurl, token_name) {
467467
* API GET request.
468468
*
469469
* @param {string} endpoint - Endpoint path
470-
* @param {Object} data - Parameters
470+
* @param {Object} data - (optional) Parameters
471471
* @return {Promise}
472472
* @api public
473473
*/
@@ -477,7 +477,7 @@ function ConManager(baseurl, token_name) {
477477
* API POST request.
478478
*
479479
* @param {string} endpoint - Endpoint path
480-
* @param {Object} data - Parameters
480+
* @param {Object} data - (optional) Parameters
481481
* @return {Promise}
482482
* @api public
483483
*/
@@ -487,7 +487,7 @@ function ConManager(baseurl, token_name) {
487487
* API PUT request.
488488
*
489489
* @param {string} endpoint - Endpoint path
490-
* @param {Object} data - Parameters
490+
* @param {Object} data - (optional) Parameters
491491
* @return {Promise}
492492
* @api public
493493
*/
@@ -497,7 +497,7 @@ function ConManager(baseurl, token_name) {
497497
* API DELETE request.
498498
*
499499
* @param {string} endpoint - Endpoint path
500-
* @param {Object} data - Parameters
500+
* @param {Object} data - (optional) Parameters
501501
* @return {Promise}
502502
* @api public
503503
*/

0 commit comments

Comments
 (0)