Class HandleHttpService

Hierarchy

HttpService
- HandleHttpService

Index

Constructors

constructor

new HandleHttpService(__namedParameters: HandleServiceDependencies, router?: Router): HandleHttpService
Parameters
- __namedParameters: HandleServiceDependencies
- router: Router = ...
Returns HandleHttpService
Overrides HttpService.constructor
- Defined in packages/cardano-services/src/Handle/HandleHttpService.ts:13

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
Inherited from HttpService.apiVersionPath
- Defined in packages/cardano-services/src/Http/HttpService.ts:77

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
Inherited from HttpService.attachProviderRoutes
- Defined in packages/cardano-services/src/Http/HttpService.ts:81

healthCheck

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

initialize

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

initializeAfter

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

initializeBefore

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

`Protected` initializeImpl

initializeImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpService.initializeImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:56

shutdown

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

shutdownAfter

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

shutdownBefore

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

`Protected` shutdownImpl

shutdownImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpService.shutdownImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:69

start

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

startAfter

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

startBefore

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

`Protected` startImpl

startImpl(): Promise<void>
Returns Promise<void>
Inherited from HttpService.startImpl
- Defined in packages/cardano-services/src/Http/HttpService.ts:65

`Static` routeHandler

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

Generated using TypeDoc