aurelia-http-client/doc/api.json

A simple, restful, message-based wrapper around XMLHttpRequest.

{"name":"aurelia-http-client","children":[{"id":158,"name":"ErrorHttpResponseMessage","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Represents an error like object response message from an HTTP or JSONP request."},"children":[{"id":161,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Instanciate a new error response message\nErrorHttpResponseMessage instanceof Error is false but with two members 'name' and 'message' we have an error like object"},"signatures":[{"id":162,"name":"new ErrorHttpResponseMessage","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Instanciate a new error response message\nErrorHttpResponseMessage instanceof Error is false but with two members 'name' and 'message' we have an error like object"},"parameters":[{"id":163,"name":"responseMessage","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"response message\n"},"type":{"type":"reference","name":"HttpResponseMessage","id":89}}],"type":{"type":"reference","name":"ErrorHttpResponseMessage","id":158},"overwrites":{"type":"reference","name":"HttpResponseMessage.__constructor","id":103}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":459,"character":18}],"overwrites":{"type":"reference","name":"HttpResponseMessage.__constructor","id":103}},{"id":177,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the content of the response.","tags":[{"tag":"returns","text":"the response content.\n"}]},"sources":[{"fileName":"aurelia-http-client.d.ts","line":292,"character":9}],"type":{"type":"instrinct","name":"any"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.content","id":113}},{"id":176,"name":"headers","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The headers received with the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":277,"character":9}],"type":{"type":"reference","name":"Headers","id":52},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.headers","id":102}},{"id":168,"name":"isSuccess","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The success status of the request based on status code."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":257,"character":11}],"type":{"type":"instrinct","name":"boolean"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.isSuccess","id":94}},{"id":160,"name":"message","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Error like message"},"sources":[{"fileName":"aurelia-http-client.d.ts","line":459,"character":9}],"type":{"type":"instrinct","name":"string"}},{"id":175,"name":"mimeType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The mime type of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":272,"character":10}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.mimeType","id":101}},{"id":159,"name":"name","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Error like name"},"sources":[{"fileName":"aurelia-http-client.d.ts","line":454,"character":6}],"type":{"type":"instrinct","name":"string"}},{"id":164,"name":"requestMessage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The request message that resulted in this response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":237,"character":16}],"type":{"type":"reference","name":"RequestMessage","id":74},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.requestMessage","id":90}},{"id":166,"name":"response","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The raw response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":247,"character":10}],"type":{"type":"instrinct","name":"any"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.response","id":92}},{"id":167,"name":"responseType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The type of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":252,"character":14}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.responseType","id":93}},{"id":170,"name":"reviver","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reviver function to use in transforming the content."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":267,"character":9}],"type":{"type":"reflection","declaration":{"id":171,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":172,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":173,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}},{"id":174,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"instrinct","name":"any"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":267,"character":10}]}},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.reviver","id":96}},{"id":165,"name":"statusCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status code of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":242,"character":12}],"type":{"type":"instrinct","name":"number"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.statusCode","id":91}},{"id":169,"name":"statusText","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status text."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":262,"character":12}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"HttpResponseMessage.statusText","id":95}}],"groups":[{"title":"Constructors","kind":512,"children":[161]},{"title":"Properties","kind":1024,"children":[177,176,168,160,175,159,164,166,167,170,165,169]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":449,"character":45}],"extendedTypes":[{"type":"reference","name":"HttpResponseMessage","id":89}]},{"id":52,"name":"Headers","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Represents http request/response headers."},"children":[{"id":53,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of the headers class."},"signatures":[{"id":54,"name":"new Headers","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of the headers class."},"parameters":[{"id":55,"name":"headers","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"A set of key/values to initialize the headers with.\n"},"type":{"type":"reference","name":"Object"}}],"type":{"type":"reference","name":"Headers","id":52}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":127,"character":30}]},{"id":56,"name":"add","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":57,"name":"add","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds a header."},"parameters":[{"id":58,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header key."},"type":{"type":"instrinct","name":"string"}},{"id":59,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header value.\n"},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":140,"character":5}]},{"id":63,"name":"clear","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":64,"name":"clear","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Clears the headers."},"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":152,"character":7}]},{"id":68,"name":"configureXHR","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":69,"name":"configureXHR","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Configures an XMR object with the headers."},"parameters":[{"id":70,"name":"xhr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The XHRT instance to configure.\n"},"type":{"type":"reference","name":"XHR","id":3}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":165,"character":14}]},{"id":60,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":61,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets a header value.","returns":"The header value.\n"},"parameters":[{"id":62,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header key."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"string"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":147,"character":5}]},{"id":65,"name":"has","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":66,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Determines whether or not the indicated header exists in the collection.","returns":"True if it exists, false otherwise.\n"},"parameters":[{"id":67,"name":"header","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header key to check."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"boolean"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":159,"character":5}]},{"id":71,"name":"parse","kind":2048,"kindString":"Method","flags":{"isStatic":true,"isExported":true},"signatures":[{"id":72,"name":"parse","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"XmlHttpRequest's getAllResponseHeaders() method returns a string of response\nheaders according to the format described here:\nhttp://www.w3.org/TR/XMLHttpRequest/#the-getallresponseheaders-method\nThis method parses that string into a user-friendly key/value pair object.","returns":"A Headers instance containing the parsed headers.\n"},"parameters":[{"id":73,"name":"headerStr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The string from the XHR."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Headers","id":52}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":175,"character":14}]}],"groups":[{"title":"Constructors","kind":512,"children":[53]},{"title":"Methods","kind":2048,"children":[56,63,68,60,65,71]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":127,"character":28}]},{"id":266,"name":"HttpClient","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"The main HTTP client object."},"children":[{"id":269,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of HttpClient."},"signatures":[{"id":270,"name":"new HttpClient","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of HttpClient."},"type":{"type":"reference","name":"HttpClient","id":266}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":677,"character":24}]},{"id":268,"name":"isRequesting","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Indicates whether or not the client is in the process of requesting resources."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":677,"character":14}],"type":{"type":"instrinct","name":"boolean"}},{"id":267,"name":"rejectPromiseWithErrorObject","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Return true if promises are rejected with an error like object. Default false"},"sources":[{"fileName":"aurelia-http-client.d.ts","line":672,"character":30}],"type":{"type":"instrinct","name":"boolean"}},{"id":271,"name":"configure","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":272,"name":"configure","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Configure this HttpClient with default settings to be used by all requests."},"parameters":[{"id":273,"name":"fn","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A function that takes a RequestBuilder as an argument.\n"},"type":{"type":"reflection","declaration":{"id":274,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":275,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":276,"name":"builder","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":688,"character":15}]}}}],"type":{"type":"reference","name":"HttpClient","id":266}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":688,"character":11}]},{"id":277,"name":"createRequest","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":278,"name":"createRequest","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns a new RequestBuilder for this HttpClient instance that can be used to build and send HTTP requests."},"parameters":[{"id":279,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL.\n"},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":694,"character":15}]},{"id":284,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":285,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP DELETE request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":286,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":709,"character":8}]},{"id":287,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":288,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP GET request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":289,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}},{"id":290,"name":"params","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"Object"}},{"id":291,"name":"traditional","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"instrinct","name":"boolean"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":716,"character":5}]},{"id":292,"name":"head","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":293,"name":"head","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP HEAD request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":294,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":723,"character":6}]},{"id":295,"name":"jsonp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":296,"name":"jsonp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a JSONP request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":297,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}},{"id":298,"name":"callbackParameterName","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":730,"character":7}]},{"id":299,"name":"options","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":300,"name":"options","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP OPTIONS request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":301,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":737,"character":9}]},{"id":306,"name":"patch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":307,"name":"patch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP PATCH request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":308,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}},{"id":309,"name":"content","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The request payload."},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":753,"character":7}]},{"id":310,"name":"post","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":311,"name":"post","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP POST request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":312,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}},{"id":313,"name":"content","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The request payload."},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":761,"character":6}]},{"id":302,"name":"put","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":303,"name":"put","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends an HTTP PUT request.","returns":"A cancellable promise object.\n"},"parameters":[{"id":304,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The target URL."},"type":{"type":"instrinct","name":"string"}},{"id":305,"name":"content","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The request payload."},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":745,"character":5}]},{"id":280,"name":"send","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":281,"name":"send","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends a message using the underlying networking stack.","returns":"A cancellable promise object.\n"},"parameters":[{"id":282,"name":"requestMessage","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RequestMessage","id":74}},{"id":283,"name":"transformers","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A collection of transformers to apply to the HTTP request."},"type":{"type":"reference","name":"Array","typeArguments":[{"type":"reference","name":"RequestTransformer","id":47}]}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":702,"character":6}]}],"groups":[{"title":"Constructors","kind":512,"children":[269]},{"title":"Properties","kind":1024,"children":[268,267]},{"title":"Methods","kind":2048,"children":[271,277,284,287,292,295,299,306,310,302,280]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":667,"character":31}]},{"id":138,"name":"HttpRequestMessage","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Represents an HTTP request message."},"children":[{"id":144,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of HttpRequestMessage."},"signatures":[{"id":145,"name":"new HttpRequestMessage","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of HttpRequestMessage."},"parameters":[{"id":146,"name":"method","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The http method."},"type":{"type":"instrinct","name":"string"}},{"id":147,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The url to submit the request to."},"type":{"type":"instrinct","name":"string"}},{"id":148,"name":"content","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The content of the request."},"type":{"type":"instrinct","name":"any"}},{"id":149,"name":"headers","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"shortText":"The headers to send along with the request.\n"},"type":{"type":"reference","name":"Headers","id":52}}],"type":{"type":"reference","name":"HttpRequestMessage","id":138},"overwrites":{"type":"reference","name":"RequestMessage.__constructor","id":81}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":428,"character":47}],"overwrites":{"type":"reference","name":"RequestMessage.__constructor","id":81}},{"id":155,"name":"baseUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The base url that the request url is joined with."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":211,"character":9}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.baseUrl","id":80}},{"id":152,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The content of the request."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":196,"character":9}],"type":{"type":"instrinct","name":"any"},"inheritedFrom":{"type":"reference","name":"RequestMessage.content","id":77}},{"id":153,"name":"headers","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The headers to send along with the request."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":201,"character":9}],"type":{"type":"reference","name":"Headers","id":52},"inheritedFrom":{"type":"reference","name":"RequestMessage.headers","id":78}},{"id":150,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The HTTP method."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":186,"character":8}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.method","id":75}},{"id":139,"name":"replacer","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A replacer function to use in transforming the content."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":428,"character":10}],"type":{"type":"reflection","declaration":{"id":140,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":141,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":142,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}},{"id":143,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"instrinct","name":"any"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":428,"character":11}]}}},{"id":154,"name":"traditional","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Use tradional style for param serialization."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":206,"character":13}],"type":{"type":"instrinct","name":"boolean"},"inheritedFrom":{"type":"reference","name":"RequestMessage.traditional","id":79}},{"id":151,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The url to submit the request to."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":191,"character":5}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.url","id":76}},{"id":156,"name":"buildFullUrl","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":157,"name":"buildFullUrl","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds the url to make the request from.","returns":"The constructed url.\n"},"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.buildFullUrl","id":87}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":226,"character":14}],"inheritedFrom":{"type":"reference","name":"RequestMessage.buildFullUrl","id":87}}],"groups":[{"title":"Constructors","kind":512,"children":[144]},{"title":"Properties","kind":1024,"children":[155,152,153,150,139,154,151]},{"title":"Methods","kind":2048,"children":[156]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":423,"character":39}],"extendedTypes":[{"type":"reference","name":"RequestMessage","id":74}]},{"id":89,"name":"HttpResponseMessage","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Represents a response message from an HTTP or JSONP request."},"children":[{"id":103,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of HttpResponseMessage."},"signatures":[{"id":104,"name":"new HttpResponseMessage","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of HttpResponseMessage."},"parameters":[{"id":105,"name":"requestMessage","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The request message that resulted in this response."},"type":{"type":"reference","name":"RequestMessage","id":74}},{"id":106,"name":"xhr","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The XHR instance that made the request."},"type":{"type":"reference","name":"XHR","id":3}},{"id":107,"name":"responseType","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The type of the response."},"type":{"type":"instrinct","name":"string"}},{"id":108,"name":"reviver","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":109,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":110,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":111,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}},{"id":112,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"instrinct","name":"any"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":286,"character":87}]}}}],"type":{"type":"reference","name":"HttpResponseMessage","id":89}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":277,"character":19}]},{"id":113,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Gets the content of the response.","tags":[{"tag":"returns","text":"the response content.\n"}]},"sources":[{"fileName":"aurelia-http-client.d.ts","line":292,"character":9}],"type":{"type":"instrinct","name":"any"}},{"id":102,"name":"headers","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The headers received with the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":277,"character":9}],"type":{"type":"reference","name":"Headers","id":52}},{"id":94,"name":"isSuccess","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The success status of the request based on status code."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":257,"character":11}],"type":{"type":"instrinct","name":"boolean"}},{"id":101,"name":"mimeType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The mime type of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":272,"character":10}],"type":{"type":"instrinct","name":"string"}},{"id":90,"name":"requestMessage","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The request message that resulted in this response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":237,"character":16}],"type":{"type":"reference","name":"RequestMessage","id":74}},{"id":92,"name":"response","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The raw response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":247,"character":10}],"type":{"type":"instrinct","name":"any"}},{"id":93,"name":"responseType","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The type of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":252,"character":14}],"type":{"type":"instrinct","name":"string"}},{"id":96,"name":"reviver","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"A reviver function to use in transforming the content."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":267,"character":9}],"type":{"type":"reflection","declaration":{"id":97,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":98,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":99,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}},{"id":100,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"instrinct","name":"any"}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":267,"character":10}]}}},{"id":91,"name":"statusCode","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status code of the response."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":242,"character":12}],"type":{"type":"instrinct","name":"number"}},{"id":95,"name":"statusText","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The status text."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":262,"character":12}],"type":{"type":"instrinct","name":"string"}}],"groups":[{"title":"Constructors","kind":512,"children":[103]},{"title":"Properties","kind":1024,"children":[113,102,94,101,90,92,93,96,91,95]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":232,"character":40}],"extendedBy":[{"type":"reference","name":"ErrorHttpResponseMessage","id":158}]},{"id":125,"name":"JSONPRequestMessage","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"Represents an JSONP request message."},"children":[{"id":126,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of JSONPRequestMessage."},"signatures":[{"id":127,"name":"new JSONPRequestMessage","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of JSONPRequestMessage."},"parameters":[{"id":128,"name":"url","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The url to submit the request to."},"type":{"type":"instrinct","name":"string"}},{"id":129,"name":"callbackParameterName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"The name of the callback parameter that the api expects.\n"},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"JSONPRequestMessage","id":125},"overwrites":{"type":"reference","name":"RequestMessage.__constructor","id":81}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":404,"character":65}],"overwrites":{"type":"reference","name":"RequestMessage.__constructor","id":81}},{"id":135,"name":"baseUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The base url that the request url is joined with."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":211,"character":9}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.baseUrl","id":80}},{"id":132,"name":"content","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The content of the request."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":196,"character":9}],"type":{"type":"instrinct","name":"any"},"inheritedFrom":{"type":"reference","name":"RequestMessage.content","id":77}},{"id":133,"name":"headers","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The headers to send along with the request."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":201,"character":9}],"type":{"type":"reference","name":"Headers","id":52},"inheritedFrom":{"type":"reference","name":"RequestMessage.headers","id":78}},{"id":130,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The HTTP method."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":186,"character":8}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.method","id":75}},{"id":134,"name":"traditional","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Use tradional style for param serialization."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":206,"character":13}],"type":{"type":"instrinct","name":"boolean"},"inheritedFrom":{"type":"reference","name":"RequestMessage.traditional","id":79}},{"id":131,"name":"url","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The url to submit the request to."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":191,"character":5}],"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.url","id":76}},{"id":136,"name":"buildFullUrl","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":137,"name":"buildFullUrl","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Builds the url to make the request from.","returns":"The constructed url.\n"},"type":{"type":"instrinct","name":"string"},"inheritedFrom":{"type":"reference","name":"RequestMessage.buildFullUrl","id":87}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":226,"character":14}],"inheritedFrom":{"type":"reference","name":"RequestMessage.buildFullUrl","id":87}}],"groups":[{"title":"Constructors","kind":512,"children":[126]},{"title":"Properties","kind":1024,"children":[135,132,133,130,134,131]},{"title":"Methods","kind":2048,"children":[136]}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":404,"character":40}],"extendedTypes":[{"type":"reference","name":"RequestMessage","id":74}]},{"id":178,"name":"RequestBuilder","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A builder class allowing fluent composition of HTTP requests."},"children":[{"id":180,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of RequestBuilder"},"signatures":[{"id":181,"name":"new RequestBuilder","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of RequestBuilder"},"parameters":[{"id":182,"name":"client","kind":32768,"kindString":"Parameter","flags":{},"comment":{"shortText":"An instance of HttpClient\n"},"type":{"type":"reference","name":"HttpClient","id":266}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":480,"character":21}]},{"id":179,"name":"client","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The HttpClient instance."},"sources":[{"fileName":"aurelia-http-client.d.ts","line":480,"character":8}],"type":{"type":"reference","name":"HttpClient","id":266}},{"id":183,"name":"asDelete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":184,"name":"asDelete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a DELETE request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":492,"character":10}]},{"id":185,"name":"asGet","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":186,"name":"asGet","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a GET request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":498,"character":7}]},{"id":187,"name":"asHead","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":188,"name":"asHead","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a HEAD request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":504,"character":8}]},{"id":197,"name":"asJsonp","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":198,"name":"asJsonp","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a JSONP request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":199,"name":"callbackParameterName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the callback to use."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":535,"character":9}]},{"id":189,"name":"asOptions","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":190,"name":"asOptions","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a OPTIONS request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":510,"character":11}]},{"id":191,"name":"asPatch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":192,"name":"asPatch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a PATCH request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":516,"character":9}]},{"id":193,"name":"asPost","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":194,"name":"asPost","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a POST request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":522,"character":8}]},{"id":195,"name":"asPut","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":196,"name":"asPut","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Makes the request a PUT request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":528,"character":7}]},{"id":264,"name":"send","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":265,"name":"send","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sends the request.","returns":"A cancellable promise object.\n"},"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"HttpResponseMessage","id":89}]}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":661,"character":6}]},{"id":256,"name":"skipContentProcessing","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":257,"name":"skipContentProcessing","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Skips the request content processing transform.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":648,"character":23}]},{"id":206,"name":"withBaseUrl","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":207,"name":"withBaseUrl","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the base url that will be prepended to the url.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":208,"name":"baseUrl","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The base url to use."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":556,"character":13}]},{"id":250,"name":"withCallbackParameterName","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":251,"name":"withCallbackParameterName","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a callback parameter name for JSONP.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":252,"name":"callbackParameterName","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of the callback parameter that the JSONP request requires."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":635,"character":27}]},{"id":203,"name":"withContent","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":204,"name":"withContent","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the request content.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":205,"name":"content","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"any"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":549,"character":13}]},{"id":223,"name":"withCredentials","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":224,"name":"withCredentials","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the withCredentials flag on the request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":225,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The value of the withCredentials flag to set."},"type":{"type":"instrinct","name":"boolean"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":592,"character":17}]},{"id":247,"name":"withDownloadProgressCallback","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":248,"name":"withDownloadProgressCallback","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets an download progress callback.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":249,"name":"downloadProgressCallback","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Function"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":628,"character":30}]},{"id":219,"name":"withHeader","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":220,"name":"withHeader","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets a header on the request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":221,"name":"key","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header key to add."},"type":{"type":"instrinct","name":"string"}},{"id":222,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The header value to add."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":585,"character":12}]},{"id":253,"name":"withInterceptor","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":254,"name":"withInterceptor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds an interceptor to the request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":255,"name":"interceptor","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The interceptor to add."},"type":{"type":"reference","name":"Interceptor","id":30}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":642,"character":17}]},{"id":226,"name":"withLogin","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":227,"name":"withLogin","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the user and password to use in opening the request.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":228,"name":"user","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The username to send."},"type":{"type":"instrinct","name":"string"}},{"id":229,"name":"password","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The password to send."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":600,"character":11}]},{"id":209,"name":"withParams","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":210,"name":"withParams","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets params that will be added to the request url as a query string.","returns":"The chainable RequestBuilder to use in further configuration of the request.\n"},"parameters":[{"id":211,"name":"params","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The key/value pairs to use to build the query string."},"type":{"type":"reference","name":"Object"}},{"id":212,"name":"traditional","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"instrinct","name":"boolean"}}],"type":{"type":"reference","name":"RequestBuilder","id":178}}],"sources":[{"fileName":"aurelia-http-client.d.ts","line":563,"character":12}]},{"id":244,"name":"withProgressCallback","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":245,"name":"withProgressCallback","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets an upload progress callback.","returns":"The chainab