Default HTTP request method for the "add" method
Advanced part of URL for a request of all request methods (it is concatenated with the base part)
Provider alias
API for async operations
Base part of URL for a request for the "add" method
Base part of URL for a request for the "del" method
Base part of URL for a request for the "get" method
Base part of URL for a request for the "peek" method
Base part of URL for a request of all request methods
Base part of URL for a request for the "upd" method
Cache identifier
Socket connection
HTTP request method for all request methods. This parameter will override other method parameters, such as "getMethod" or "delMethod".
Default HTTP request method for the "del" method
Event emitter to broadcast provider events
Event name for requests. Please notice that all request methods except "get", "peek" and "request" emit events by default.
List of additional data providers for the "get" method. It can be useful if you have some providers that you want combine to one.
Default HTTP request method for the "get" method
Global event emitter to broadcast provider events
Default HTTP request method for the "peek" method
URL for a socket connection
Default HTTP request method for the "upd" method
Map of data decoder sequences. The key of a map element represent a name of the provider method: 'get', 'post', etc. The value of a map element represent a sequence of decoders for the specified provider method.
Map of data encoder sequences. The key of a map element represent a name of the provider method: 'get', 'post', etc. The value of a map element represent a sequence of encoders for the specified provider method.
Sequence of middlewares that is provided to the request function. An object form is easily to extend, bur you can choose any different form.
Map of data mocks.
This object can be used with a middleware that implements API for data mocking,
for example attachMock from 'core/data/middlewares'
.
The key of a map element represent a method request type: 'GET', 'POST', etc. The value of a map element represent a list of parameters to match.
Transport function for a request. Basically, you can use an overload of the request API for flexibly extending.
Creates a new remote request with the specified options
request path URL
request options
Returns a wrapped request constructor with the specified options. This overload helps to organize the "builder" pattern.
request options
Returns a function to create a new remote request with the specified options. This overload helps to create a factory of requests.
request path URL
function to resolve a request: it takes a request URL, request environment, and arguments from invoking the outer function and can modify some request parameters. Also, if the function returns a new string, the string will be appended to the request URL, or if the function returns a string wrapped with an array, the string fully overrides the original URL.
request options
Alias for the request function
Creates a new remote request with the specified options
request path URL
request options
Returns a wrapped request constructor with the specified options. This overload helps to organize the "builder" pattern.
request options
Returns a function to create a new remote request with the specified options. This overload helps to create a factory of requests.
request path URL
function to resolve a request: it takes a request URL, request environment, and arguments from invoking the outer function and can modify some request parameters. Also, if the function returns a new string, the string will be appended to the request URL, or if the function returns a string wrapped with an array, the string fully overrides the original URL.
request options
Add new data to the provider. This method is similar for a POST request.
Returns the base part of URL of any request
Sets the base part of URL for any request. This method returns a new provider object with context.
Connects to a socket server and returns the connection
Deletes data of the provider by a query. This method is similar for a DELETE request.
Drops the request cache of the current provider
Requests the provider for data by a query. This method is similar for a GET request.
Returns an object with authentication parameters
additional parameters
Returns a key to the class instance cache
Returns an event cache key by the specified parameters
event name
event data
Returns an object with request options by the specified model name and object with additional parameters
model method
Initializes the socket behaviour after successful connecting
Returns the custom HTTP request method of any request
Sets the custom HTTP request method for any request. This method returns a new provider object with context.
Returns the custom logical name of any request. If a request has the name, then it will fire an event with the same name after successful receiving.
Sets the custom logical name for any request. If a request has the name, then it will fire an event with the same name after successful receiving. This method returns a new provider object with context.
Checks accessibility of the provider by a query. This method is similar for a HEAD request.
Sends custom data to the provider without any logically effect. This method is similar for a POST request.
Function to resolve a request: it takes a request URL and request environment and can modify some request parameters.
Also, if the function returns a new string, the string will be appended to the request URL, or if the function returns a string that wrapped with an array, the string fully override the original URL.
request URL
request parameters
Sets a readonly value by the specified key to the current provider
Updates data of the provider by a query. This method is similar for a PUT request.
Updates the specified request with adding caching, etc.
request url
request factory
Updates the specified request with adding caching, etc.
request url
event name that is fired after resolving of the request
request factory
Returns the full URL of any request
Sets an extra URL part for any request (it is concatenated with the base part of URL). This method returns a new provider object with context.
Borrows API from the specified RequestPromise
object to the passed RequestResponse
object and returns it
Finds an element from an object by the specified parameters
object to search
search parameters
Default data provider