aurelia-fetch-client/doc/api.json

A simple client based on the Fetch standard.

{"name":"aurelia-fetch-client","children":[{"id":89,"name":"HttpClient","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"An HTTP client based on the Fetch API."},"children":[{"id":96,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"Creates an instance of HttpClient."},"signatures":[{"id":97,"name":"new HttpClient","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"Creates an instance of HttpClient."},"type":{"type":"reference","name":"HttpClient","id":89}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":251,"character":30}]},{"id":90,"name":"activeRequestCount","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The current number of active requests.\nRequests being processed by interceptors are considered active."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":226,"character":20}],"type":{"type":"intrinsic","name":"number"}},{"id":93,"name":"baseUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The base URL set by the config."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":241,"character":9}],"type":{"type":"intrinsic","name":"string"}},{"id":94,"name":"defaults","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The default request init to merge with values specified at request time."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":246,"character":10}],"type":{"type":"reference","name":"RequestInit","id":22}},{"id":95,"name":"interceptors","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The interceptors to be run during requests."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":251,"character":14}],"type":{"type":"array","elementType":{"type":"reference","name":"Interceptor","id":2}}},{"id":92,"name":"isConfigured","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Indicates whether or not the client has been configured."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":236,"character":14}],"type":{"type":"intrinsic","name":"boolean"}},{"id":91,"name":"isRequesting","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Indicates whether or not the client is currently making one or more requests."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":231,"character":14}],"type":{"type":"intrinsic","name":"boolean"}},{"id":108,"name":"buildRequest","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":109,"name":"buildRequest","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":110,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":111,"name":"init","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Request"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":283,"character":14}]},{"id":98,"name":"configure","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":99,"name":"configure","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Configure this client with default settings to be used by all requests.","returns":"The chainable instance of this HttpClient.","tags":[{"tag":"chainable","text":"\n"}]},"parameters":[{"id":100,"name":"config","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"A configuration object, or a function that takes a config\nobject and configures it."},"type":{"type":"union","types":[{"type":"reference","name":"RequestInit","id":22},{"type":"reflection","declaration":{"id":101,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":102,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":103,"name":"config","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","name":"HttpClientConfiguration","id":69}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":266,"character":33}]}}]}}],"type":{"type":"reference","name":"HttpClient","id":89}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":266,"character":11}]},{"id":131,"name":"delete","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":132,"name":"delete","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calls fetch with request method set to DELETE.","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":133,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":134,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The body of the request."},"type":{"type":"intrinsic","name":"any"}},{"id":135,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":342,"character":8}]},{"id":104,"name":"fetch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":105,"name":"fetch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Starts the process of fetching a resource. Default configuration parameters\nwill be applied to the Request. The constructed Request will be passed to\nregistered request interceptors before being sent. The Response will be passed\nto registered Response interceptors before it is returned.","text":"See also https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API\n","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":106,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":107,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":282,"character":7}]},{"id":112,"name":"get","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":113,"name":"get","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calls fetch as a GET request.","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":114,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":115,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":294,"character":5}]},{"id":126,"name":"patch","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":127,"name":"patch","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calls fetch with request method set to PATCH.","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":128,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":129,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The body of the request."},"type":{"type":"intrinsic","name":"any"}},{"id":130,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":330,"character":7}]},{"id":116,"name":"post","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":117,"name":"post","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calls fetch with request method set to POST.","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":118,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":119,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The body of the request."},"type":{"type":"intrinsic","name":"any"}},{"id":120,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":306,"character":6}]},{"id":121,"name":"put","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":122,"name":"put","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Calls fetch with request method set to PUT.","returns":"A Promise for the Response from the fetch request.\n"},"parameters":[{"id":123,"name":"input","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The resource that you wish to fetch. Either a\nRequest object, or a string containing the URL of the resource."},"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"intrinsic","name":"string"}]}},{"id":124,"name":"body","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The body of the request."},"type":{"type":"intrinsic","name":"any"}},{"id":125,"name":"init","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"An options object containing settings to be applied to\nthe Request."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":318,"character":5}]}],"groups":[{"title":"Constructors","kind":512,"children":[96]},{"title":"Properties","kind":1024,"children":[90,93,94,95,92,91]},{"title":"Methods","kind":2048,"children":[108,98,131,104,112,126,116,121]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":220,"character":31}]},{"id":69,"name":"HttpClientConfiguration","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A class for configuring HttpClients."},"children":[{"id":70,"name":"baseUrl","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The base URL to be prepended to each Request's url before sending."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":149,"character":9}],"type":{"type":"intrinsic","name":"string"}},{"id":71,"name":"defaults","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Default values to apply to init objects when creating Requests. Note that\ndefaults cannot be applied when Request objects are manually created because\nRequest provides its own defaults and discards the original init object.\nSee also https://developer.mozilla.org/en-US/docs/Web/API/Request/Request"},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":157,"character":10}],"type":{"type":"reference","name":"RequestInit","id":22}},{"id":72,"name":"interceptors","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Interceptors to be added to the HttpClient."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":162,"character":14}],"type":{"type":"array","elementType":{"type":"reference","name":"Interceptor","id":2}}},{"id":84,"name":"rejectErrorResponses","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":85,"name":"rejectErrorResponses","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Causes Responses whose status codes fall outside the range 200-299 to reject.\nThe fetch API only rejects on network errors or other conditions that prevent\nthe request from completing, meaning consumers must inspect Response.ok in the\nPromise continuation to determine if the server responded with a success code.\nThis method adds a response interceptor that causes Responses with error codes\nto be rejected, which is common behavior in HTTP client libraries.","returns":"The chainable instance of this configuration object.","tags":[{"tag":"chainable","text":"\n"}]},"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":213,"character":22}]},{"id":82,"name":"useStandardConfiguration","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":83,"name":"useStandardConfiguration","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Applies a configuration that addresses common application needs, including\nconfiguring same-origin credentials, and using rejectErrorResponses.","returns":"The chainable instance of this configuration object.","tags":[{"tag":"chainable","text":"\n"}]},"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":201,"character":26}]},{"id":73,"name":"withBaseUrl","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":74,"name":"withBaseUrl","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the baseUrl.","returns":"The chainable instance of this configuration object.","tags":[{"tag":"chainable","text":"\n"}]},"parameters":[{"id":75,"name":"baseUrl","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The base URL."},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":171,"character":13}]},{"id":76,"name":"withDefaults","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":77,"name":"withDefaults","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the defaults.","returns":"The chainable instance of this configuration object.","tags":[{"tag":"chainable","text":"\n"}]},"parameters":[{"id":78,"name":"defaults","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The defaults."},"type":{"type":"reference","name":"RequestInit","id":22}}],"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":180,"character":14}]},{"id":79,"name":"withInterceptor","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":80,"name":"withInterceptor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds an interceptor to be run on all requests or responses.","returns":"The chainable instance of this configuration object.","tags":[{"tag":"chainable","text":"\n"}]},"parameters":[{"id":81,"name":"interceptor","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An object with request, requestError,\nresponse, or responseError methods. request and requestError act as\nresolve and reject handlers for the Request before it is sent.\nresponse and responseError act as resolve and reject handlers for\nthe Response after it has been received."},"type":{"type":"reference","name":"Interceptor","id":2}}],"type":{"type":"reference","name":"HttpClientConfiguration","id":69}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":193,"character":17}]},{"id":86,"name":"withRetry","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":87,"name":"withRetry","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":88,"name":"config","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"RetryConfiguration","id":33}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":214,"character":11}]}],"groups":[{"title":"Properties","kind":1024,"children":[70,71,72]},{"title":"Methods","kind":2048,"children":[84,82,73,76,79,86]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":144,"character":44}]},{"id":52,"name":"RetryInterceptor","kind":128,"kindString":"Class","flags":{"isExported":true},"children":[{"id":54,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"signatures":[{"id":55,"name":"new RetryInterceptor","kind":16384,"kindString":"Constructor signature","flags":{},"parameters":[{"id":56,"name":"retryConfig","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"RetryConfiguration","id":33}}],"type":{"type":"reference","name":"RetryInterceptor","id":52}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":134,"character":34}]},{"id":53,"name":"retryConfig","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":134,"character":13}],"type":{"type":"reference","name":"RetryConfiguration","id":33}},{"id":57,"name":"request","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":58,"name":"request","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":59,"name":"request","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":136,"character":9}],"implementationOf":{"type":"reference","name":"Interceptor.request","id":3}},{"id":60,"name":"response","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":61,"name":"response","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":62,"name":"response","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}},{"id":63,"name":"request","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":137,"character":10}],"implementationOf":{"type":"reference","name":"Interceptor.response","id":11}},{"id":64,"name":"responseError","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":65,"name":"responseError","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":66,"name":"error","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}},{"id":67,"name":"request","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}},{"id":68,"name":"httpClient","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"any"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":138,"character":15}],"implementationOf":{"type":"reference","name":"Interceptor.responseError","id":16}}],"groups":[{"title":"Constructors","kind":512,"children":[54]},{"title":"Properties","kind":1024,"children":[53]},{"title":"Methods","kind":2048,"children":[57,60,64]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":133,"character":37}],"implementedTypes":[{"type":"reference","name":"Interceptor","id":2}]},{"id":2,"name":"Interceptor","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Interceptors can process requests before they are sent, and responses\nbefore they are returned to callers."},"children":[{"id":3,"name":"request","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Called with the request before it is sent. Request interceptors can modify and\nreturn the request, or return a new one to be sent. If desired, the interceptor\nmay return a Response in order to short-circuit the HTTP request itself.","tags":[{"tag":"returns","text":"The existing request, a new request or a response; or a Promise for any of these.\n"}]},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":21,"character":9}],"type":{"type":"reflection","declaration":{"id":4,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"comment":{"text":"The request to be sent."},"signatures":[{"id":5,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"text":"The request to be sent."},"parameters":[{"id":6,"name":"request","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Request"}}],"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"reference","name":"Response"},{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"reference","name":"Response"}]}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":21,"character":11}]}}},{"id":7,"name":"requestError","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Handles errors generated by previous request interceptors. This function acts\nas a Promise rejection handler. It may rethrow the error to propagate the\nfailure, or return a new Request or Response to recover.","tags":[{"tag":"param","text":"The rejection value from the previous interceptor.","param":"error"},{"tag":"returns","text":"The existing request, a new request or a response; or a Promise for any of these.\n"}]},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":31,"character":14}],"type":{"type":"reflection","declaration":{"id":8,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":9,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":10,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"reference","name":"Response"},{"type":"reference","name":"Promise","typeArguments":[{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"reference","name":"Response"}]}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":31,"character":16}]}}},{"id":11,"name":"response","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Called with the response after it is received. Response interceptors can modify\nand return the Response, or create a new one to be returned to the caller.","tags":[{"tag":"returns","text":"The response; or a Promise for one.\n"}]},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":40,"character":10}],"type":{"type":"reflection","declaration":{"id":12,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"comment":{"text":"The response."},"signatures":[{"id":13,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"comment":{"text":"The response."},"parameters":[{"id":14,"name":"response","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Response"}},{"id":15,"name":"request","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"Request"}}],"type":{"type":"union","types":[{"type":"reference","name":"Response"},{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":40,"character":12}]}}},{"id":16,"name":"responseError","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Handles fetch errors and errors generated by previous interceptors. This\nfunction acts as a Promise rejection handler. It may rethrow the error\nto propagate the failure, or return a new Response to recover.","tags":[{"tag":"param","text":"The rejection value from the fetch request or from a\nprevious interceptor.","param":"error"},{"tag":"returns","text":"The response; or a Promise for one.\n"}]},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":51,"character":15}],"type":{"type":"reflection","declaration":{"id":17,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":18,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":19,"name":"error","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":20,"name":"request","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"Request"}},{"id":21,"name":"httpClient","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"reference","name":"HttpClient","id":89}}],"type":{"type":"union","types":[{"type":"reference","name":"Response"},{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Response"}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":51,"character":17}]}}}],"groups":[{"title":"Properties","kind":1024,"children":[3,7,11,16]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":11,"character":36}],"implementedBy":[{"type":"reference","name":"RetryInterceptor","id":52}]},{"id":22,"name":"RequestInit","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"The init object used to initialize a fetch Request.\nSee https://developer.mozilla.org/en-US/docs/Web/API/Request/Request"},"children":[{"id":25,"name":"body","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any body that you want to add to your request: this can be a Blob, BufferSource, FormData, URLSearchParams, or USVString object. Note that a request using the GET or HEAD method cannot have a body."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":77,"character":6}],"type":{"type":"union","types":[{"type":"reference","name":"Blob"},{"type":"reference","name":"BufferSource"},{"type":"reference","name":"FormData"},{"type":"reference","name":"URLSearchParams"},{"type":"intrinsic","name":"string"}]}},{"id":28,"name":"cache","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The cache mode you want to use for the request: default, no-store, reload, no-cache, or force-cache."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":92,"character":7}],"type":{"type":"intrinsic","name":"string"}},{"id":27,"name":"credentials","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The request credentials you want to use for the request: omit, same-origin, or include. The default is omit. In Chrome the default is same-origin before Chrome 47 and include starting with Chrome 47."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":87,"character":13}],"type":{"type":"intrinsic","name":"string"}},{"id":24,"name":"headers","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Any headers you want to add to your request, contained within a Headers object or an object literal with ByteString values."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":72,"character":9}],"type":{"type":"union","types":[{"type":"reference","name":"Headers"},{"type":"reference","name":"Object"}]}},{"id":31,"name":"integrity","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"Contains the subresource integrity value of the request (e.g., sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE=)."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":107,"character":11}],"type":{"type":"intrinsic","name":"string"}},{"id":23,"name":"method","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The request method, e.g., GET, POST."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":67,"character":8}],"type":{"type":"intrinsic","name":"string"}},{"id":26,"name":"mode","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The mode you want to use for the request, e.g., cors, no-cors, same-origin, or navigate. The default is cors. In Chrome the default is no-cors before Chrome 47 and same-origin starting with Chrome 47."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":82,"character":6}],"type":{"type":"intrinsic","name":"string"}},{"id":29,"name":"redirect","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"The redirect mode to use: follow, error, or manual. In Chrome the default is follow before Chrome 47 and manual starting with Chrome 47."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":97,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":30,"name":"referrer","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"A USVString specifying no-referrer, client, or a URL. The default is client."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":102,"character":10}],"type":{"type":"intrinsic","name":"string"}},{"id":32,"name":"signal","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"comment":{"shortText":"An AbortSignal to set request’s signal."},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":112,"character":8}],"type":{"type":"reference","name":"AbortSignal"}}],"groups":[{"title":"Properties","kind":1024,"children":[25,28,27,24,31,23,26,29,30,32]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":62,"character":36}]},{"id":33,"name":"RetryConfiguration","kind":256,"kindString":"Interface","flags":{"isExported":true},"children":[{"id":47,"name":"beforeRetry","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":121,"character":13}],"type":{"type":"reflection","declaration":{"id":48,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":49,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":50,"name":"request","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Request"}},{"id":51,"name":"client","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"HttpClient","id":89}}],"type":{"type":"union","types":[{"type":"reference","name":"Request"},{"type":"reference","name":"Promise","typeArguments":[{"type":"reference","name":"Request"}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":121,"character":15}]}}},{"id":42,"name":"doRetry","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":120,"character":9}],"type":{"type":"reflection","declaration":{"id":43,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":44,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":45,"name":"response","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Response"}},{"id":46,"name":"request","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"Request"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"reference","name":"Promise","typeArguments":[{"type":"intrinsic","name":"boolean"}]}]}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":120,"character":11}]}}},{"id":35,"name":"interval","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":116,"character":10}],"type":{"type":"intrinsic","name":"number"}},{"id":41,"name":"maxRandomInterval","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":119,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":34,"name":"maxRetries","kind":1024,"kindString":"Property","flags":{"isExported":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":115,"character":12}],"type":{"type":"intrinsic","name":"number"}},{"id":40,"name":"minRandomInterval","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":118,"character":19}],"type":{"type":"intrinsic","name":"number"}},{"id":36,"name":"strategy","kind":1024,"kindString":"Property","flags":{"isExported":true,"isOptional":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":117,"character":10}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reflection","declaration":{"id":37,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"signatures":[{"id":38,"name":"__call","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":39,"name":"retryCount","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"number"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":117,"character":21}]}}]}}],"groups":[{"title":"Properties","kind":1024,"children":[47,42,35,41,34,40,36]}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":114,"character":43}]},{"id":140,"name":"retryStrategy","kind":32,"kindString":"Variable","flags":{"isExported":true,"isConst":true},"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":132,"character":34}],"type":{"type":"intrinsic","name":"any"}},{"id":136,"name":"json","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":137,"name":"json","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Serialize an object to JSON. Useful for easily creating JSON fetch request bodies.","returns":"A JSON string.\n"},"parameters":[{"id":138,"name":"body","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The object to be serialized to JSON."},"type":{"type":"intrinsic","name":"any"}},{"id":139,"name":"replacer","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"comment":{"text":"The JSON.stringify replacer used when serializing."},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"intrinsic","name":"string"}}],"sources":[{"fileName":"aurelia-fetch-client.d.ts","line":131,"character":28}]}],"groups":[{"title":"Classes","kind":128,"children":[89,69,52]},{"title":"Interfaces","kind":256,"children":[2,22,33]},{"title":"Variables","kind":32,"children":[140]},{"title":"Functions","kind":64,"children":[136]}]}