diff --git a/CHANGELOG.md b/CHANGELOG.md index 4962c27d..19e41900 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +4.8.0 - June 1, 2018 + +* chore: add tests (Hovhannes Babayan) +* refactor: remove unneeded checks (Hovhannes Babayan) +* chore: update comment (Hovhannes Babayan) +* feat: make `isAtomic` parameter for `batch()` method optional (Hovhannes Babayan) +* chore: remove comment (Hovhannes Babayan) +* feat: add `batch()` method (Hovhannes Babayan) + 4.7.0 - May 31, 2018 * chore: fix test (Hovhannes Babayan) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 6053f310..635384b9 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"\"Api\"","url":"modules/_api_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"IHttpOptions","url":"interfaces/_api_.ihttpoptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":2,"kind":1024,"name":"path","url":"interfaces/_api_.ihttpoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":3,"kind":1024,"name":"method","url":"interfaces/_api_.ihttpoptions.html#method","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":4,"kind":1024,"name":"url","url":"interfaces/_api_.ihttpoptions.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":5,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.ihttpoptions.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":6,"kind":1024,"name":"headers","url":"interfaces/_api_.ihttpoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":7,"kind":65536,"name":"__type","url":"interfaces/_api_.ihttpoptions.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers"},{"id":8,"kind":32,"name":"sessionID","url":"interfaces/_api_.ihttpoptions.html#headers.__type.sessionid","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":9,"kind":32,"name":"X-XSRF-TOKEN","url":"interfaces/_api_.ihttpoptions.html#headers.__type.x_xsrf_token","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":10,"kind":32,"name":"apiKey","url":"interfaces/_api_.ihttpoptions.html#headers.__type.apikey","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":11,"kind":256,"name":"IApiConfig","url":"interfaces/_api_.iapiconfig.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":12,"kind":1024,"name":"url","url":"interfaces/_api_.iapiconfig.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":13,"kind":1024,"name":"version","url":"interfaces/_api_.iapiconfig.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":14,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.iapiconfig.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":15,"kind":1024,"name":"apiKey","url":"interfaces/_api_.iapiconfig.html#apikey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":16,"kind":1024,"name":"headers","url":"interfaces/_api_.iapiconfig.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":17,"kind":65536,"name":"__type","url":"interfaces/_api_.iapiconfig.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IApiConfig.headers"},{"id":18,"kind":128,"name":"Api","url":"classes/_api_.api.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"Api\""},{"id":19,"kind":2097152,"name":"Methods","url":"classes/_api_.api.html#methods","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"\"Api\".Api"},{"id":20,"kind":32,"name":"GET","url":"classes/_api_.api.html#methods.get-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":21,"kind":32,"name":"PUT","url":"classes/_api_.api.html#methods.put","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":22,"kind":32,"name":"DELETE","url":"classes/_api_.api.html#methods.delete","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":23,"kind":32,"name":"POST","url":"classes/_api_.api.html#methods.post","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":24,"kind":1024,"name":"_httpOptions","url":"classes/_api_.api.html#_httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":25,"kind":1024,"name":"serverAcceptsJSON","url":"classes/_api_.api.html#serveracceptsjson","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":26,"kind":512,"name":"constructor","url":"classes/_api_.api.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":27,"kind":2048,"name":"getApiKey","url":"classes/_api_.api.html#getapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":28,"kind":2048,"name":"copy","url":"classes/_api_.api.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":29,"kind":2048,"name":"count","url":"classes/_api_.api.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":30,"kind":2048,"name":"clearApiKey","url":"classes/_api_.api.html#clearapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":31,"kind":2048,"name":"create","url":"classes/_api_.api.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":32,"kind":2048,"name":"edit","url":"classes/_api_.api.html#edit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":33,"kind":2048,"name":"editMultiple","url":"classes/_api_.api.html#editmultiple","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":34,"kind":2048,"name":"execute","url":"classes/_api_.api.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":35,"kind":2048,"name":"get","url":"classes/_api_.api.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":36,"kind":2048,"name":"login","url":"classes/_api_.api.html#login","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":37,"kind":2048,"name":"logout","url":"classes/_api_.api.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":38,"kind":2048,"name":"metadata","url":"classes/_api_.api.html#metadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":39,"kind":2048,"name":"namedQuery","url":"classes/_api_.api.html#namedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":40,"kind":2048,"name":"remove","url":"classes/_api_.api.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":41,"kind":2048,"name":"report","url":"classes/_api_.api.html#report","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":42,"kind":2048,"name":"request","url":"classes/_api_.api.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":43,"kind":2048,"name":"search","url":"classes/_api_.api.html#search","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":44,"kind":2048,"name":"setApiKey","url":"classes/_api_.api.html#setapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":45,"kind":2048,"name":"setSessionID","url":"classes/_api_.api.html#setsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":46,"kind":2048,"name":"setXSRFToken","url":"classes/_api_.api.html#setxsrftoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":47,"kind":2048,"name":"uploadFromStream","url":"classes/_api_.api.html#uploadfromstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":48,"kind":2048,"name":"uploadFileContent","url":"classes/_api_.api.html#uploadfilecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":49,"kind":4194304,"name":"TFields","url":"modules/_api_.html#tfields","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":50,"kind":32,"name":"GlobalScope","url":"modules/_api_.html#globalscope","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":51,"kind":64,"name":"queryStringify","url":"modules/_api_.html#querystringify","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":52,"kind":4194304,"name":"TSuccessHandler","url":"modules/_api_.html#tsuccesshandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"Api\""},{"id":53,"kind":65536,"name":"__type","url":"modules/_api_.html#tsuccesshandler.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TSuccessHandler"},{"id":54,"kind":4194304,"name":"TFailureHandler","url":"modules/_api_.html#tfailurehandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":55,"kind":65536,"name":"__type","url":"modules/_api_.html#tfailurehandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TFailureHandler"},{"id":56,"kind":2097152,"name":"ResponseHandler","url":"modules/_api_.html#responsehandler","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"Api\""},{"id":57,"kind":64,"name":"success","url":"modules/_api_.html#responsehandler.success","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":58,"kind":64,"name":"failure","url":"modules/_api_.html#responsehandler.failure","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":59,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-external-module"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"\"Api\"","url":"modules/_api_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"IHttpOptions","url":"interfaces/_api_.ihttpoptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":2,"kind":1024,"name":"path","url":"interfaces/_api_.ihttpoptions.html#path","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":3,"kind":1024,"name":"method","url":"interfaces/_api_.ihttpoptions.html#method","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":4,"kind":1024,"name":"url","url":"interfaces/_api_.ihttpoptions.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":5,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.ihttpoptions.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":6,"kind":1024,"name":"headers","url":"interfaces/_api_.ihttpoptions.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IHttpOptions"},{"id":7,"kind":65536,"name":"__type","url":"interfaces/_api_.ihttpoptions.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers"},{"id":8,"kind":32,"name":"sessionID","url":"interfaces/_api_.ihttpoptions.html#headers.__type.sessionid","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":9,"kind":32,"name":"X-XSRF-TOKEN","url":"interfaces/_api_.ihttpoptions.html#headers.__type.x_xsrf_token","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":10,"kind":32,"name":"apiKey","url":"interfaces/_api_.ihttpoptions.html#headers.__type.apikey","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"\"Api\".IHttpOptions.headers.__type"},{"id":11,"kind":256,"name":"IApiConfig","url":"interfaces/_api_.iapiconfig.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":12,"kind":1024,"name":"url","url":"interfaces/_api_.iapiconfig.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":13,"kind":1024,"name":"version","url":"interfaces/_api_.iapiconfig.html#version","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":14,"kind":1024,"name":"alwaysUseGet","url":"interfaces/_api_.iapiconfig.html#alwaysuseget","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":15,"kind":1024,"name":"apiKey","url":"interfaces/_api_.iapiconfig.html#apikey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":16,"kind":1024,"name":"headers","url":"interfaces/_api_.iapiconfig.html#headers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IApiConfig"},{"id":17,"kind":65536,"name":"__type","url":"interfaces/_api_.iapiconfig.html#headers.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IApiConfig.headers"},{"id":18,"kind":128,"name":"Api","url":"classes/_api_.api.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"Api\""},{"id":19,"kind":2097152,"name":"Methods","url":"classes/_api_.api.html#methods","classes":"tsd-kind-object-literal tsd-parent-kind-class tsd-is-static","parent":"\"Api\".Api"},{"id":20,"kind":32,"name":"GET","url":"classes/_api_.api.html#methods.get-1","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":21,"kind":32,"name":"PUT","url":"classes/_api_.api.html#methods.put","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":22,"kind":32,"name":"DELETE","url":"classes/_api_.api.html#methods.delete","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":23,"kind":32,"name":"POST","url":"classes/_api_.api.html#methods.post","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"Api\".Api.Methods"},{"id":24,"kind":1024,"name":"_httpOptions","url":"classes/_api_.api.html#_httpoptions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":25,"kind":1024,"name":"serverAcceptsJSON","url":"classes/_api_.api.html#serveracceptsjson","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":26,"kind":1024,"name":"_uriGenerationMode","url":"classes/_api_.api.html#_urigenerationmode","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":27,"kind":512,"name":"constructor","url":"classes/_api_.api.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":28,"kind":2048,"name":"getApiKey","url":"classes/_api_.api.html#getapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":29,"kind":2048,"name":"copy","url":"classes/_api_.api.html#copy","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":30,"kind":2048,"name":"count","url":"classes/_api_.api.html#count","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":31,"kind":2048,"name":"clearApiKey","url":"classes/_api_.api.html#clearapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":32,"kind":2048,"name":"create","url":"classes/_api_.api.html#create","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":33,"kind":2048,"name":"edit","url":"classes/_api_.api.html#edit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":34,"kind":2048,"name":"editMultiple","url":"classes/_api_.api.html#editmultiple","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":35,"kind":2048,"name":"execute","url":"classes/_api_.api.html#execute","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":36,"kind":2048,"name":"get","url":"classes/_api_.api.html#get","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":37,"kind":2048,"name":"login","url":"classes/_api_.api.html#login","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":38,"kind":2048,"name":"logout","url":"classes/_api_.api.html#logout","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":39,"kind":2048,"name":"metadata","url":"classes/_api_.api.html#metadata","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":40,"kind":2048,"name":"namedQuery","url":"classes/_api_.api.html#namedquery","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":41,"kind":2048,"name":"remove","url":"classes/_api_.api.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":42,"kind":2048,"name":"report","url":"classes/_api_.api.html#report","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":43,"kind":2048,"name":"request","url":"classes/_api_.api.html#request","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":44,"kind":2048,"name":"search","url":"classes/_api_.api.html#search","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":45,"kind":2048,"name":"batch","url":"classes/_api_.api.html#batch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":46,"kind":2048,"name":"setApiKey","url":"classes/_api_.api.html#setapikey","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":47,"kind":2048,"name":"setSessionID","url":"classes/_api_.api.html#setsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":48,"kind":2048,"name":"setXSRFToken","url":"classes/_api_.api.html#setxsrftoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":49,"kind":2048,"name":"uploadFromStream","url":"classes/_api_.api.html#uploadfromstream","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":50,"kind":2048,"name":"uploadFileContent","url":"classes/_api_.api.html#uploadfilecontent","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"Api\".Api"},{"id":51,"kind":256,"name":"IBatchApi","url":"interfaces/_api_.ibatchapi.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"Api\""},{"id":52,"kind":1024,"name":"copy","url":"interfaces/_api_.ibatchapi.html#copy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":53,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#copy.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.copy"},{"id":54,"kind":1024,"name":"count","url":"interfaces/_api_.ibatchapi.html#count","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":55,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#count.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.count"},{"id":56,"kind":1024,"name":"create","url":"interfaces/_api_.ibatchapi.html#create","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":57,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#create.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.create"},{"id":58,"kind":1024,"name":"edit","url":"interfaces/_api_.ibatchapi.html#edit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":59,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#edit.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.edit"},{"id":60,"kind":1024,"name":"editMultiple","url":"interfaces/_api_.ibatchapi.html#editmultiple","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":61,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#editmultiple.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.editMultiple"},{"id":62,"kind":1024,"name":"execute","url":"interfaces/_api_.ibatchapi.html#execute","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":63,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#execute.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.execute"},{"id":64,"kind":1024,"name":"get","url":"interfaces/_api_.ibatchapi.html#get","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":65,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#get.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.get"},{"id":66,"kind":1024,"name":"metadata","url":"interfaces/_api_.ibatchapi.html#metadata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":67,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#metadata.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.metadata"},{"id":68,"kind":1024,"name":"namedQuery","url":"interfaces/_api_.ibatchapi.html#namedquery","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":69,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#namedquery.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.namedQuery"},{"id":70,"kind":1024,"name":"remove","url":"interfaces/_api_.ibatchapi.html#remove","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":71,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#remove.__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.remove"},{"id":72,"kind":1024,"name":"report","url":"interfaces/_api_.ibatchapi.html#report","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":73,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#report.__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.report"},{"id":74,"kind":1024,"name":"request","url":"interfaces/_api_.ibatchapi.html#request","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":75,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#request.__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.request"},{"id":76,"kind":1024,"name":"search","url":"interfaces/_api_.ibatchapi.html#search","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"Api\".IBatchApi"},{"id":77,"kind":65536,"name":"__type","url":"interfaces/_api_.ibatchapi.html#search.__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"Api\".IBatchApi.search"},{"id":78,"kind":4194304,"name":"TFields","url":"modules/_api_.html#tfields","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":79,"kind":32,"name":"GlobalScope","url":"modules/_api_.html#globalscope","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":80,"kind":64,"name":"queryStringify","url":"modules/_api_.html#querystringify","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":81,"kind":64,"name":"batchApiFactory","url":"modules/_api_.html#batchapifactory","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"Api\""},{"id":82,"kind":4194304,"name":"TSuccessHandler","url":"modules/_api_.html#tsuccesshandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"Api\""},{"id":83,"kind":65536,"name":"__type","url":"modules/_api_.html#tsuccesshandler.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TSuccessHandler"},{"id":84,"kind":4194304,"name":"TFailureHandler","url":"modules/_api_.html#tfailurehandler","classes":"tsd-kind-type-alias tsd-parent-kind-external-module","parent":"\"Api\""},{"id":85,"kind":65536,"name":"__type","url":"modules/_api_.html#tfailurehandler.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"Api\".TFailureHandler"},{"id":86,"kind":2097152,"name":"ResponseHandler","url":"modules/_api_.html#responsehandler","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"Api\""},{"id":87,"kind":64,"name":"success","url":"modules/_api_.html#responsehandler.success","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":88,"kind":64,"name":"failure","url":"modules/_api_.html#responsehandler.failure","classes":"tsd-kind-function tsd-parent-kind-object-literal","parent":"\"Api\".ResponseHandler"},{"id":89,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-external-module"}]}; \ No newline at end of file diff --git a/docs/classes/_api_.api.html b/docs/classes/_api_.api.html index 9c2a74ca..2bdd0c95 100644 --- a/docs/classes/_api_.api.html +++ b/docs/classes/_api_.api.html @@ -103,12 +103,14 @@
A function which will be invoked with api instance.
+ This instance is special, as all methods there return a url string instead of making a backend call.
+ uriCollector
should return an array of uris to be executed in batch.
+ So, for example, one may return [batchApi.metadata(), batchApi.count(...)]
from uriCollector
.
+ That will mean call metadata() method
and then call count() method
.
Pass true if you want all operations to happen in the same transaction. + There is a limitation, however. Atomic batch operations can only return success or error.
+X-XSRF-TOKEN to set
+Generated using TypeDoc
+
Performs batch call to the API.
++- memberof
+
+
+Api
+