Class HttpService`Abstract`

Hierarchy

RunnableModule
- HttpService

Index

Constructors

constructor

new HttpService(slug: string, provider: Provider, router: Router, openApiPath: string, logger: Logger): HttpService
Parameters
- slug: string
- provider: Provider
- router: Router
- openApiPath: string
- logger: Logger
Returns HttpService
Overrides RunnableModule.constructor
- Defined in packages/cardano-services/src/Http/HttpService.ts:30

Properties

logger

logger: Logger

name

name: string

openApiPath

openApiPath: string

provider

provider: Provider

router

router: Router

slug

slug: string

state

state: RunnableModuleState

Methods

apiVersionPath

apiVersionPath(): string
Returns string
- Defined in packages/cardano-services/src/Http/HttpService.ts:76

attachProviderRoutes

attachProviderRoutes<T>(provider: T, router: Router, paths: HttpProviderConfigPaths<T>): void
Type Parameters
- T extends Provider
Parameters
- provider: T
- router: Router
- paths: HttpProviderConfigPaths<T>
Returns void
- Defined in packages/cardano-services/src/Http/HttpService.ts:80

healthCheck

healthCheck(): Promise<HealthCheckResponse>
Returns Promise<HealthCheckResponse>
- Defined in packages/cardano-services/src/Http/HttpService.ts:72

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from RunnableModule.initialize
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:15

initializeAfter

initializeAfter(): void
Returns void
Inherited from RunnableModule.initializeAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:19

initializeBefore

initializeBefore(): void
Returns void
Inherited from RunnableModule.initializeBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:18

`Protected` initializeImpl

initializeImpl(): Promise<void>
Returns Promise<void>
Overrides RunnableModule.initializeImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:55

shutdown

shutdown(): Promise<void>
Returns Promise<void>
Inherited from RunnableModule.shutdown
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:17

shutdownAfter

shutdownAfter(): void
Returns void
Inherited from RunnableModule.shutdownAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:23

shutdownBefore

shutdownBefore(): void
Returns void
Inherited from RunnableModule.shutdownBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:22

`Protected` shutdownImpl

shutdownImpl(): Promise<void>
Returns Promise<void>
Overrides RunnableModule.shutdownImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:68

start

start(): Promise<void>
Returns Promise<void>
Inherited from RunnableModule.start
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:16

startAfter

startAfter(): void
Returns void
Inherited from RunnableModule.startAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:21

startBefore

startBefore(): void
Returns void
Inherited from RunnableModule.startBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:20

`Protected` startImpl

startImpl(): Promise<void>
Returns Promise<void>
Overrides RunnableModule.startImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:64

`Static` routeHandler

routeHandler(logger: Logger): ProviderHandler<any, any, any>
Parameters
- logger: Logger
Returns ProviderHandler<any, any, any>
- Defined in packages/cardano-services/src/Http/HttpService.ts:88

Generated using TypeDoc