Preparing search index...
The search index is not available
cardano-sdk
cardano-sdk
@cardano-sdk/cardano-services
HttpServer
Class HttpServer
Hierarchy
RunnableModule
HttpServer
PgBossWorkerHttpServer
BlockfrostWorker
Index
Constructors
constructor
Properties
#config
#dependencies
#health
Gauge
app
logger
name
server
state
Methods
#get
Services
Health
check
Req
Version
init
Metrics
initialize
initialize
After
initialize
Before
initialize
Impl
shutdown
shutdown
After
shutdown
Before
shutdown
Impl
start
start
After
start
Before
start
Impl
sendJSON
Constructors
constructor
new
Http
Server
(
config
:
HttpServerConfig
, __namedParameters
:
HttpServerDependencies
)
:
HttpServer
Parameters
config:
HttpServerConfig
__namedParameters:
HttpServerDependencies
Returns
HttpServer
Properties
Private
#config
#config
:
HttpServerConfig
Private
#dependencies
#dependencies
:
HttpServerDependencies
Private
#health
Gauge
#health
Gauge
:
Gauge
<
string
>
app
app
:
Application
logger
logger
:
Logger
name
name
:
string
server
server
:
Server
<
typeof
IncomingMessage
,
typeof
ServerResponse
>
state
state
:
RunnableModuleState
Methods
Private
#get
Services
Health
#get
Services
Health
(
)
:
Promise
<
{
ok
:
boolean
;
services
:
ServiceHealth
[]
;
}
>
Returns
Promise
<
{
ok
:
boolean
;
services
:
ServiceHealth
[]
;
}
>
Private
check
Req
Version
check
Req
Version
(
version
:
string
)
:
(
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
|
Response
<
any
,
Record
<
string
,
any
>
>
)
Parameters
version:
string
Returns
(
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
=>
void
|
Response
<
any
,
Record
<
string
,
any
>
>
)
(
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
, res
:
Response
<
any
,
Record
<
string
,
any
>
>
, next
:
NextFunction
)
:
void
|
Response
<
any
,
Record
<
string
,
any
>
>
Parameters
req:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res:
Response
<
any
,
Record
<
string
,
any
>
>
next:
NextFunction
Returns
void
|
Response
<
any
,
Record
<
string
,
any
>
>
Private
init
Metrics
init
Metrics
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
initialize
initialize
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
initialize
After
initialize
After
(
)
:
void
Returns
void
initialize
Before
initialize
Before
(
)
:
void
Returns
void
Protected
initialize
Impl
initialize
Impl
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
shutdown
shutdown
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
shutdown
After
shutdown
After
(
)
:
void
Returns
void
shutdown
Before
shutdown
Before
(
)
:
void
Returns
void
Protected
shutdown
Impl
shutdown
Impl
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
start
start
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
start
After
start
After
(
)
:
void
Returns
void
start
Before
start
Before
(
)
:
void
Returns
void
Protected
start
Impl
start
Impl
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Static
sendJSON
sendJSON
<
ResponseBody
>
(
res
:
Response
<
ProviderError
<
unknown
>
|
ResponseBody
,
Record
<
string
,
any
>
>
, obj
:
ProviderError
<
unknown
>
|
ResponseBody
, statusCode
?:
number
)
:
void
Type Parameters
ResponseBody
Parameters
res:
Response
<
ProviderError
<
unknown
>
|
ResponseBody
,
Record
<
string
,
any
>
>
obj:
ProviderError
<
unknown
>
|
ResponseBody
statusCode:
number
= 200
Returns
void
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
cardano-
sdk
@cardano-
sdk/cardano-
services
<internal>
errors
util
@cardano-
sdk/cardano-
services-
client
<internal>
@cardano-
sdk/core
<internal>
Asset
Asset
Name
Label
util
Cardano
Asset
Fingerprint
Asset
Id
Asset
Name
Cip1854
Extended
Account
Public
Key
DRepID
Pool
Id
Reward
Account
Transaction
Id
Vrf
Vk
Bech32
util
Cardano
Node
Util
Days
Hours
Milliseconds
Minutes
Provider
Util
Seconds
Serialization
Tx
BodyCBOR
TxCBOR
metadatum
util
@cardano-
sdk/e2e
<internal>
@cardano-
sdk/golden-
test-
generator
<internal>
@cardano-
sdk/governance
<internal>
cip36
@cardano-
sdk/input-
selection
<internal>
@cardano-
sdk/key-
management
<internal>
cip8
errors
util
@cardano-
sdk/ogmios
<internal>
ogmios
To
Core
@cardano-
sdk/projection
<internal>
Bootstrap
In
Memory
Mappers
@cardano-
sdk/util
<internal>
Base64
Blob
Hex
Blob
@cardano-
sdk/util-
dev
<internal>
Asset
Id
Docker
Util
Tx
Test
Util
cip19
Test
Vectors
handle
Provider
Mocks
mock
Providers
@cardano-
sdk/util-
rxjs
@cardano-
sdk/wallet
<internal>
cip30
storage
@cardano-
sdk/web-
extension
<internal>
cip30
Http
Server
constructor
#config
#dependencies
#health
Gauge
app
logger
name
server
state
#get
Services
Health
check
Req
Version
init
Metrics
initialize
initialize
After
initialize
Before
initialize
Impl
shutdown
shutdown
After
shutdown
Before
shutdown
Impl
start
start
After
start
Before
start
Impl
sendJSON
Generated using
TypeDoc