Class RequestClient

Before using static methods of this library the implementation must be defined and selected using RequestClient.useClient().

See HgNode.initialize() which calls useClient() for NodeJS projects
See HgFrontend.initialize() which calls useClient() for frontend projects

You may also use it as a standard class:

`const client = new RequestClient( clientImplementation );

Hierarchy

RequestClient

Constructors

constructor

new RequestClient(client: RequestClientInterface): RequestClient
Creates client instance
Parameters
- client: RequestClientInterface
Returns RequestClient
- Defined in fi/hg/core/RequestClient.ts:45

Properties

`Private` `Readonly` _client

_client: RequestClientInterface

Internal state for normal methods

`Static` `Private` _client

_client: RequestClient = undefined

Internal state for static methods.

You must call .useClient() to initialize it

Methods

deleteJson

deleteJson(url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<JsonAny>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:196

deleteJsonEntity

deleteJsonEntity(url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:246

deleteText

deleteText(url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<string>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:146

deleteTextEntity

deleteTextEntity(url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:93

getJson

getJson(url: string, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:165

getJsonEntity

getJsonEntity(url: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:215

getText

getText(url: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:112

getTextEntity

getTextEntity(url: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:59

jsonEntityRequest

jsonEntityRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<ResponseEntity<JsonAny>>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:206

jsonRequest

jsonRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<JsonAny>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:156

patchJson

patchJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:180

patchJsonEntity

patchJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:230

patchText

patchText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:128

patchTextEntity

patchTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:75

postJson

postJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:172

postJsonEntity

postJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:222

postText

postText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:119

postTextEntity

postTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:66

putJson

putJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:188

putJsonEntity

putJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:238

putText

putText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:137

putTextEntity

putTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:84

textEntityRequest

textEntityRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<ResponseEntity<string>>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:50

textRequest

textRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<string>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:103

`Static` `Private` _createClientError

_createClientError(): TypeError
Private

Throw
TypeError

Returns TypeError
- Defined in fi/hg/core/RequestClient.ts:496

`Static` deleteJson

deleteJson(url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<JsonAny>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:372

`Static` deleteJsonEntity

deleteJsonEntity(url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:483

`Static` deleteText

deleteText(url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<string>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:317

`Static` deleteTextEntity

deleteTextEntity(url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:428

`Static` getJson

getJson(url: string, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:336

`Static` getJsonEntity

getJsonEntity(url: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:447

`Static` getText

getText(url: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:280

`Static` getTextEntity

getTextEntity(url: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:391

`Static` jsonEntityRequest

jsonEntityRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<ResponseEntity<JsonAny>>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:437

`Static` jsonRequest

jsonRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: JsonAny): Promise<JsonAny>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: JsonAny
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:326

`Static` patchJson

patchJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:354

`Static` patchJsonEntity

patchJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:465

`Static` patchText

patchText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:298

`Static` patchTextEntity

patchTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:409

`Static` postJson

postJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:344

`Static` postJsonEntity

postJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:455

`Static` postText

postText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:288

`Static` postTextEntity

postTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:399

`Static` putJson

putJson(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<JsonAny>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<JsonAny>
- Defined in fi/hg/core/RequestClient.ts:363

`Static` putJsonEntity

putJsonEntity(url: string, data?: JsonAny, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<JsonAny>>
Parameters
- url: string
- Optional data: JsonAny
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<JsonAny>>
- Defined in fi/hg/core/RequestClient.ts:474

`Static` putText

putText(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<string>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:308

`Static` putTextEntity

putTextEntity(url: string, data?: string, headers?: {
[key: string]: string;
}): Promise<ResponseEntity<string>>
Parameters
- url: string
- Optional data: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:419

`Static` setClient

setClient(client: RequestClientInterface): void
Parameters
- client: RequestClientInterface
Returns void
- Defined in fi/hg/core/RequestClient.ts:264

`Static` setLogLevel

setLogLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in fi/hg/core/RequestClient.ts:260

`Static` textEntityRequest

textEntityRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<ResponseEntity<string>>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<ResponseEntity<string>>
- Defined in fi/hg/core/RequestClient.ts:381

`Static` textRequest

textRequest(method: RequestMethod, url: string, headers?: {
[key: string]: string;
}, data?: string): Promise<string>
Parameters
- method: RequestMethod
- url: string
- Optional headers: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional data: string
Returns Promise<string>
- Defined in fi/hg/core/RequestClient.ts:270

Class RequestClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: RequestClientInterface

Returns RequestClient

Properties

Private Readonly _client

Static Private _client

Methods

deleteJson

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Optional data: JsonAny

Returns Promise<JsonAny>

deleteJsonEntity

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Optional data: JsonAny

Returns Promise<ResponseEntity<JsonAny>>

deleteText

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Optional data: string

Returns Promise<string>

deleteTextEntity

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Optional data: string

Returns Promise<ResponseEntity<string>>

getJson

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Returns Promise<JsonAny>

getJsonEntity

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Returns Promise<ResponseEntity<JsonAny>>

getText

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Returns Promise<string>

getTextEntity

Parameters

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Returns Promise<ResponseEntity<string>>

jsonEntityRequest

Parameters

method: RequestMethod

url: string

Optional headers: { [key: string]: string; }

[key: string]: string

Optional data: JsonAny

Returns Promise<ResponseEntity<JsonAny>>

jsonRequest

Parameters

method: RequestMethod

url: string

Optional headers: { [key: string]: string; }

`Private` `Readonly` _client

`Static` `Private` _client

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` headers: {
[key: string]: string;
}

`Optional` headers: {
[key: string]: string;
}

`Optional` headers: {
[key: string]: string;
}

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` data: string

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny

`Optional` headers: {
[key: string]: string;
}

`Optional` data: JsonAny