Class Client

Hierarchy

Client

Constructors

`Private` constructor

new Client(resolver: Resolver, configuration: ClientConfiguration): Client
Parameters
- resolver: Resolver
- configuration: ClientConfiguration
Returns Client
- Defined in src/client.ts:62

Properties

`Private` `Readonly` configuration

configuration: ClientConfiguration

errorSubscriptions

errorSubscriptions: SubscriptionRecord<ClientErrorResponseDetails> = ...

`Private` `Readonly` logger

logger: Logger

`Optional` onErrorResponseCallback

onErrorResponseCallback?: ((details: ClientErrorResponseDetails) => void) = undefined

Type declaration

- (details: ClientErrorResponseDetails): void
- Parameters
  - details: ClientErrorResponseDetails
  Returns void

`Optional` onRequestCallback

onRequestCallback?: ((details: ClientRequestDetails) => void) = undefined

Type declaration

- (details: ClientRequestDetails): void
- Parameters
  - details: ClientRequestDetails
  Returns void

`Optional` onResponseCallback

onResponseCallback?: ((details: ClientResponseDetails) => void) = undefined

Type declaration

- (details: ClientResponseDetails): void
- Parameters
  - details: ClientResponseDetails
  Returns void

requestSubscriptions

requestSubscriptions: SubscriptionRecord<ClientRequestDetails> = ...

`Private` `Readonly` resolver

resolver: Resolver

responseSubscriptions

responseSubscriptions: SubscriptionRecord<ClientResponseDetails> = ...

`Private` `Optional` serverInformation

serverInformation?: null | ServerInformation

Methods

debug

debug(message: string): void
Parameters
- message: string
Returns void
- Defined in src/client.ts:46

del

del(path: string, args?: RouteArgs<RouteArgLookup>): Promise<unknown>
Parameters
- path: string
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<unknown>
- Defined in src/client.ts:208

`Private` dispatchRequest

dispatchRequest(method: any, url: string, requestBody?: any): Promise<unknown>
Parameters
- method: any
- url: string
- Optional requestBody: any
Returns Promise<unknown>
- Defined in src/client.ts:237

`Private` doCommand

doCommand<TReturn>(verb: string, path: string, command?: any, args?: RouteArgs<RouteArgLookup>): Promise<TReturn>
Type Parameters
- TReturn
Parameters
- verb: string
- path: string
- Optional command: any
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<TReturn>
- Defined in src/client.ts:175

doCreate

doCreate<TReturn>(path: string, command?: any, args?: RouteArgs<RouteArgLookup>): Promise<TReturn>
Type Parameters
- TReturn
Parameters
- path: string
- Optional command: any
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<TReturn>
- Defined in src/client.ts:167

doUpdate

doUpdate<TReturn>(path: string, command?: any, args?: RouteArgs<RouteArgLookup>): Promise<TReturn>
Type Parameters
- TReturn
Parameters
- path: string
- Optional command: any
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<TReturn>
- Defined in src/client.ts:171

error

error(message: string, error?: undefined | Error): void
Parameters
- message: string
- error: undefined | Error = undefined
Returns void
- Defined in src/client.ts:58

get

get<TResource>(path: undefined | string, args?: RouteArgs<RouteArgLookup>): Promise<TResource>
Type Parameters
- TResource
Parameters
- path: undefined | string
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<TResource>
- Defined in src/client.ts:99

getRaw

getRaw(path: string, args?: RouteArgs<RouteArgLookup>): Promise<string>
Parameters
- path: string
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<string>
- Defined in src/client.ts:107

getServerInformation

getServerInformation(): Promise<ServerInformation>
Returns Promise<ServerInformation>
- Defined in src/client.ts:217

info

info(message: string): void
Parameters
- message: string
Returns void
- Defined in src/client.ts:50

onErrorResponse

onErrorResponse(clientErrorResponseDetails: ClientErrorResponseDetails): void
Parameters
- clientErrorResponseDetails: ClientErrorResponseDetails
Returns void
- Defined in src/client.ts:151

onRequest

onRequest(clientRequestDetails: ClientRequestDetails): void
Parameters
- clientRequestDetails: ClientRequestDetails
Returns void
- Defined in src/client.ts:125

onResponse

onResponse(clientResponseDetails: ClientResponseDetails): void
Parameters
- clientResponseDetails: ClientResponseDetails
Returns void
- Defined in src/client.ts:138

post

post<TReturn>(path: string, resource?: any, args?: RouteArgs<RouteArgLookup>): Promise<TReturn>
Type Parameters
- TReturn
Parameters
- path: string
- Optional resource: any
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<TReturn>
- Defined in src/client.ts:202

request

request<TReturn>(path: string, request?: any): Promise<TReturn>
Type Parameters
- TReturn
Parameters
- path: string
- Optional request: any
Returns Promise<TReturn>
- Defined in src/client.ts:191

resolve

resolve(path: string, uriTemplateParameters?: RouteArgs<RouteArgLookup>): string
Parameters
- path: string
- Optional uriTemplateParameters: RouteArgs<RouteArgLookup>
Returns string
- Defined in src/client.ts:97

resolveUrl

resolveUrl(path: string, args?: RouteArgs<RouteArgLookup>): string
Parameters
- path: string
- Optional args: RouteArgs<RouteArgLookup>
Returns string
- Defined in src/client.ts:253

setOnErrorResponseCallback

setOnErrorResponseCallback(callback: ((details: ClientErrorResponseDetails) => void)): void
Parameters
- callback: ((details: ClientErrorResponseDetails) => void)
  - - (details: ClientErrorResponseDetails): void
    - Parameters
      
      details: ClientErrorResponseDetails
      
      Returns void
Returns void
- Defined in src/client.ts:93

setOnRequestCallback

setOnRequestCallback(callback: ((details: ClientRequestDetails) => void)): void
Parameters
- callback: ((details: ClientRequestDetails) => void)
  - - (details: ClientRequestDetails): void
    - Parameters
      
      details: ClientRequestDetails
      
      Returns void
Returns void
- Defined in src/client.ts:85

setOnResponseCallback

setOnResponseCallback(callback: ((details: ClientResponseDetails) => void)): void
Parameters
- callback: ((details: ClientResponseDetails) => void)
  - - (details: ClientResponseDetails): void
    - Parameters
      
      details: ClientResponseDetails
      
      Returns void
Returns void
- Defined in src/client.ts:89

subscribeToErrors

subscribeToErrors(registrationName: string, callback: ((details: ClientErrorResponseDetails) => void)): Unsubscribe
Parameters
- registrationName: string
- callback: ((details: ClientErrorResponseDetails) => void)
  - - (details: ClientErrorResponseDetails): void
    - Parameters
      
      details: ClientErrorResponseDetails
      
      Returns void
Returns Unsubscribe
- Defined in src/client.ts:81

subscribeToRequests

subscribeToRequests(registrationName: string, callback: Callback<ClientRequestDetails>): Unsubscribe
Parameters
- registrationName: string
- callback: Callback<ClientRequestDetails>
Returns Unsubscribe
- Defined in src/client.ts:73

subscribeToResponses

subscribeToResponses(registrationName: string, callback: Callback<ClientResponseDetails>): Unsubscribe
Parameters
- registrationName: string
- callback: Callback<ClientResponseDetails>
Returns Unsubscribe
- Defined in src/client.ts:77

tryGetServerInformation

tryGetServerInformation(): Promise<null | ServerInformation>
Returns Promise<null | ServerInformation>
- Defined in src/client.ts:227

warn

warn(message: string): void
Parameters
- message: string
Returns void
- Defined in src/client.ts:54

`Static` create

create(configuration: ClientConfiguration): Promise<Client>
Parameters
- configuration: ClientConfiguration
Returns Promise<Client>
- Defined in src/client.ts:31

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

resolver: Resolver

configuration: ClientConfiguration

Returns Client

Properties

Private Readonly configuration

errorSubscriptions

Private Readonly logger

Optional onErrorResponseCallback

Type declaration

Parameters

details: ClientErrorResponseDetails

Returns void

Optional onRequestCallback

Type declaration

Parameters

details: ClientRequestDetails

Returns void

Optional onResponseCallback

Type declaration

Parameters

details: ClientResponseDetails

Returns void

requestSubscriptions

Private Readonly resolver

responseSubscriptions

Private Optional serverInformation

Methods

debug

Parameters

message: string

Returns void

del

Parameters

path: string

Optional args: RouteArgs<RouteArgLookup>

Returns Promise<unknown>

Private dispatchRequest

Parameters

method: any

url: string

Optional requestBody: any

Returns Promise<unknown>

Private doCommand

Type Parameters

TReturn

Parameters

verb: string

path: string

Optional command: any

Optional args: RouteArgs<RouteArgLookup>

Returns Promise<TReturn>

doCreate

Type Parameters

TReturn

Parameters

path: string

Optional command: any

Optional args: RouteArgs<RouteArgLookup>

Returns Promise<TReturn>

doUpdate

Type Parameters

TReturn

Parameters

path: string

Optional command: any

Optional args: RouteArgs<RouteArgLookup>

Returns Promise<TReturn>

error

Parameters

message: string

error: undefined | Error = undefined

`Private` constructor

`Private` `Readonly` configuration

`Private` `Readonly` logger

`Optional` onErrorResponseCallback

`Optional` onRequestCallback

`Optional` onResponseCallback

`Private` `Readonly` resolver

`Private` `Optional` serverInformation

`Optional` args: RouteArgs<RouteArgLookup>

`Private` dispatchRequest

`Optional` requestBody: any

`Private` doCommand

`Optional` command: any

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` command: any

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` command: any

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` resource: any

`Optional` args: RouteArgs<RouteArgLookup>

`Optional` request: any

`Optional` uriTemplateParameters: RouteArgs<RouteArgLookup>

`Optional` args: RouteArgs<RouteArgLookup>