Class PublicAPI

Index

Constructors

Methods

addInterceptor describe execute getApiVersion getContracts getOperation getOperations getPipeline getTransportRegistry getVersion registerHandler registerTransport removeInterceptor removeMiddleware unregisterHandler useMiddleware

Constructors

constructor

new PublicAPI(config?: PublicApiConfig): PublicAPI
Parameters
- Optionalconfig: PublicApiConfig
Returns PublicAPI
- Defined in api/dist/api.d.ts:29

Methods

addInterceptor

addInterceptor(interceptor: Interceptor, order?: number): void
Parameters
- interceptor: Interceptor
- Optionalorder: number
Returns void
- Defined in api/dist/api.d.ts:34

describe

describe(): PlatformDescription
Returns PlatformDescription
- Defined in api/dist/api.d.ts:38

execute

execute(
    operationId: string,
    request: RequestContext,
    parameters?: Record<string, unknown>,
): Promise<ApiResponse<unknown>>
Parameters
- operationId: string
- request: RequestContext
- Optionalparameters: Record<string, unknown>
Returns Promise<ApiResponse<unknown>>
- Defined in api/dist/api.d.ts:37

getApiVersion

getApiVersion(): string
Returns string
- Defined in api/dist/api.d.ts:45

getContracts

getContracts(): readonly ContractSchema[]
Returns readonly ContractSchema[]
- Defined in api/dist/api.d.ts:41

getOperation

getOperation(id: string): OperationDescriptor | undefined
Parameters
- id: string
Returns OperationDescriptor | undefined
- Defined in api/dist/api.d.ts:40

getOperations

getOperations(): readonly OperationDescriptor[]
Returns readonly OperationDescriptor[]
- Defined in api/dist/api.d.ts:39

getPipeline

getPipeline(): RequestPipeline
Returns RequestPipeline
- Defined in api/dist/api.d.ts:43

getTransportRegistry

getTransportRegistry(): TransportRegistry
Returns TransportRegistry
- Defined in api/dist/api.d.ts:42

getVersion

getVersion(): string
Returns string
- Defined in api/dist/api.d.ts:44

registerHandler

registerHandler(operationId: string, handler: OperationHandler): void
Parameters
- operationId: string
- handler: OperationHandler
Returns void
- Defined in api/dist/api.d.ts:30

registerTransport

registerTransport(adapter: TransportAdapter): void
Parameters
- adapter: TransportAdapter
Returns void
- Defined in api/dist/api.d.ts:36

removeInterceptor

removeInterceptor(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in api/dist/api.d.ts:35

removeMiddleware

removeMiddleware(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in api/dist/api.d.ts:33

unregisterHandler

unregisterHandler(operationId: string): boolean
Parameters
- operationId: string
Returns boolean
- Defined in api/dist/api.d.ts:31

useMiddleware

useMiddleware(name: string, fn: MiddlewareFunction, order?: number): void
Parameters
- name: string
- fn: MiddlewareFunction
- Optionalorder: number
Returns void
- Defined in api/dist/api.d.ts:32