HTTP client module for REST API interactions
Interfaces
- HttpFlags
Interface extending RepositoryFlags with HTTP-specific options
Namespaces
- axios
This module provides classes and utilities for interacting with REST APIs. It exposes repository and service classes for making HTTP requests, along with type definitions and adapters for different HTTP clients. The module includes
RestRepositoryandRestServicefor API interactions.
Members
# inner constant COMMIT
Stores the current git commit hash for the package. The build replaces the placeholder with the actual commit hash at publish time.
Represents the current commit hash of the module build.
# inner constant FULL_VERSION
Stores the semver version and commit hash for the package.
The build replaces the placeholder with the actual <version>-<commit> value at publish time.
Represents the full version string of the module.
Type Definitions
Object
# HttpConfig
Configuration type for HTTP connections specifying protocol and host
HTTP configuration type
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
protocol |
'http'
|
'https'
|
The HTTP protocol to use |
|
host |
string
|
The host address |
|
protocol |
"http"
|
"https"
|
||
host |
string
|
||
parsers |
Array
|
<optional> |
|
eventsListenerPath |
string
|
<optional> |
|
headers |
boolean
|
<optional> |
|
events |
boolean
|
<optional> |
|
eventHeaderResolver |
function
|
<optional> |