Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bump to 2.6.0 #90

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Bump to 2.6.0 #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e443fe8
Bump Doc 422cbec
openkfwCI Nov 23, 2023
4972c52
Bump Doc d2b440c
openkfwCI Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions docs/developer/api-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_position: 1
sidebar_label: Introduction
---
# TruBudget-API

Api Code Documentation / [Exports](modules.md)

## Setup
Expand Down
25 changes: 13 additions & 12 deletions docs/developer/api-docs/classes/error.TruBudgetError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# TruBudgetError

[Api Code Documentation](../README.md) / [Exports](../modules.md) / [error](../modules/error.md) / TruBudgetError

[error](../modules/error.md).TruBudgetError
Expand Down Expand Up @@ -58,7 +59,7 @@ Error.constructor

#### Defined in

[src/error.ts:135](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L135)
[src/error.ts:135](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L135)

## Properties

Expand All @@ -68,7 +69,7 @@ Error.constructor

#### Defined in

[src/error.ts:121](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L121)
[src/error.ts:121](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L121)

___

Expand All @@ -78,7 +79,7 @@ ___

#### Defined in

[src/error.ts:113](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L113)
[src/error.ts:113](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L113)

___

Expand All @@ -88,7 +89,7 @@ ___

#### Defined in

[src/error.ts:131](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L131)
[src/error.ts:131](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L131)

___

Expand All @@ -98,7 +99,7 @@ ___

#### Defined in

[src/error.ts:129](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L129)
[src/error.ts:129](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L129)

___

Expand All @@ -108,7 +109,7 @@ ___

#### Defined in

[src/error.ts:117](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L117)
[src/error.ts:117](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L117)

___

Expand All @@ -118,7 +119,7 @@ ___

#### Defined in

[src/error.ts:133](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L133)
[src/error.ts:133](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L133)

___

Expand Down Expand Up @@ -156,7 +157,7 @@ ___

#### Defined in

[src/error.ts:127](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L127)
[src/error.ts:127](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L127)

___

Expand All @@ -180,7 +181,7 @@ ___

#### Defined in

[src/error.ts:125](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L125)
[src/error.ts:125](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L125)

___

Expand All @@ -190,7 +191,7 @@ ___

#### Defined in

[src/error.ts:123](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L123)
[src/error.ts:123](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L123)

___

Expand All @@ -200,7 +201,7 @@ ___

#### Defined in

[src/error.ts:119](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L119)
[src/error.ts:119](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L119)

___

Expand All @@ -210,7 +211,7 @@ ___

#### Defined in

[src/error.ts:115](https://github.com/openkfw/TruBudget/blob/92640998/api/src/error.ts#L115)
[src/error.ts:115](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/error.ts#L115)

___

Expand Down
3 changes: 2 additions & 1 deletion docs/developer/api-docs/classes/http_errors_bad_request.BadRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# BadRequest

[Api Code Documentation](../README.md) / [Exports](../modules.md) / [http\_errors/bad\_request](../modules/http_errors_bad_request.md) / BadRequest

[http\_errors/bad\_request](../modules/http_errors_bad_request.md).BadRequest
Expand Down Expand Up @@ -54,7 +55,7 @@ VError.constructor

#### Defined in

[src/http_errors/bad_request.ts:13](https://github.com/openkfw/TruBudget/blob/92640998/api/src/http_errors/bad_request.ts#L13)
[src/http_errors/bad_request.ts:13](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/http_errors/bad_request.ts#L13)

## Properties

Expand Down
45 changes: 23 additions & 22 deletions docs/developer/api-docs/classes/service_Client.RpcMultichainClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# RpcMultichainClient

[Api Code Documentation](../README.md) / [Exports](../modules.md) / [service/Client](../modules/service_Client.md) / RpcMultichainClient

[service/Client](../modules/service_Client.md).RpcMultichainClient
Expand Down Expand Up @@ -54,7 +55,7 @@

#### Defined in

[src/service/Client.ts:46](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L46)
[src/service/Client.ts:46](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L46)

## Properties

Expand All @@ -64,7 +65,7 @@

#### Defined in

[src/service/Client.ts:44](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L44)
[src/service/Client.ts:44](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L44)

___

Expand All @@ -74,7 +75,7 @@ ___

#### Defined in

[src/service/Client.ts:42](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L42)
[src/service/Client.ts:42](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L42)

## Methods

Expand All @@ -92,7 +93,7 @@ ___

#### Defined in

[src/service/Client.ts:137](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L137)
[src/service/Client.ts:137](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L137)

___

Expand All @@ -118,7 +119,7 @@ Get the latest block, possibly skipping a few.

#### Defined in

[src/service/Client.ts:246](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L246)
[src/service/Client.ts:246](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L246)

___

Expand All @@ -144,7 +145,7 @@ ___

#### Defined in

[src/service/Client.ts:161](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L161)
[src/service/Client.ts:161](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L161)

___

Expand All @@ -168,7 +169,7 @@ ___

#### Defined in

[src/service/Client.ts:55](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L55)
[src/service/Client.ts:55](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L55)

___

Expand All @@ -186,7 +187,7 @@ ___

#### Defined in

[src/service/Client.ts:250](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L250)
[src/service/Client.ts:250](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L250)

___

Expand All @@ -204,7 +205,7 @@ ___

#### Defined in

[src/service/Client.ts:51](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L51)
[src/service/Client.ts:51](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L51)

___

Expand All @@ -229,7 +230,7 @@ ___

#### Defined in

[src/service/Client.ts:208](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L208)
[src/service/Client.ts:208](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L208)

___

Expand All @@ -255,7 +256,7 @@ ___

#### Defined in

[src/service/Client.ts:141](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L141)
[src/service/Client.ts:141](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L141)

___

Expand All @@ -279,7 +280,7 @@ ___

#### Defined in

[src/service/Client.ts:132](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L132)
[src/service/Client.ts:132](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L132)

___

Expand All @@ -305,7 +306,7 @@ ___

#### Defined in

[src/service/Client.ts:108](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L108)
[src/service/Client.ts:108](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L108)

___

Expand Down Expand Up @@ -334,7 +335,7 @@ You can retrieve the current maximum block height through calling getLastBlockIn

#### Defined in

[src/service/Client.ts:258](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L258)
[src/service/Client.ts:258](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L258)

___

Expand Down Expand Up @@ -363,7 +364,7 @@ Retrieve all items within a stream by block height range.

#### Defined in

[src/service/Client.ts:266](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L266)
[src/service/Client.ts:266](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L266)

___

Expand All @@ -381,7 +382,7 @@ ___

#### Defined in

[src/service/Client.ts:254](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L254)
[src/service/Client.ts:254](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L254)

___

Expand All @@ -407,7 +408,7 @@ ___

#### Defined in

[src/service/Client.ts:221](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L221)
[src/service/Client.ts:221](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L221)

___

Expand All @@ -431,7 +432,7 @@ ___

#### Defined in

[src/service/Client.ts:95](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L95)
[src/service/Client.ts:95](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L95)

___

Expand All @@ -455,7 +456,7 @@ ___

#### Defined in

[src/service/Client.ts:82](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L82)
[src/service/Client.ts:82](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L82)

___

Expand All @@ -481,7 +482,7 @@ ___

#### Defined in

[src/service/Client.ts:123](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L123)
[src/service/Client.ts:123](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L123)

___

Expand All @@ -507,7 +508,7 @@ ___

#### Defined in

[src/service/Client.ts:226](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L226)
[src/service/Client.ts:226](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L226)

___

Expand All @@ -533,4 +534,4 @@ ___

#### Defined in

[src/service/Client.ts:283](https://github.com/openkfw/TruBudget/blob/92640998/api/src/service/Client.ts#L283)
[src/service/Client.ts:283](https://github.com/openkfw/TruBudget/blob/d2b440c/api/src/service/Client.ts#L283)
Loading
Loading