Skip to content

Commit

Permalink
📝 Update API references
Browse files Browse the repository at this point in the history
  • Loading branch information
cermakjiri committed Jun 18, 2021
1 parent ceeaf1e commit 23a6ee4
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 40 deletions.
22 changes: 11 additions & 11 deletions packages/@ackee/antonio-core/docs-api/classes/antonio.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ const api = new Antonio({

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:13](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L13)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:13](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L13)

## Properties

Expand All @@ -59,7 +59,7 @@ const api = new Antonio({

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:12](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L12)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:12](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L12)

---

Expand All @@ -69,7 +69,7 @@ const api = new Antonio({

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:13](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L13)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:13](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L13)

## Methods

Expand All @@ -90,7 +90,7 @@ const api = new Antonio({

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:58](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L58)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:58](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L58)

---

Expand All @@ -106,7 +106,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:73](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L73)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:73](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L73)

---

Expand All @@ -127,7 +127,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:54](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L54)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:54](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L54)

---

Expand All @@ -148,7 +148,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:62](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L62)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:62](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L62)

---

Expand All @@ -169,7 +169,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:66](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L66)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:66](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L66)

---

Expand All @@ -191,7 +191,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:50](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L50)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:50](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L50)

---

Expand All @@ -213,7 +213,7 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:42](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L42)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:42](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L42)

---

Expand All @@ -235,4 +235,4 @@ Clears-up memory after the current Antonio instance.

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:46](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L46)
[packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts:46](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/models/Antonio.ts#L46)
12 changes: 6 additions & 6 deletions packages/@ackee/antonio-core/docs-api/classes/antonioerror.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Error.constructor

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)

## Properties

Expand All @@ -60,7 +60,7 @@ Error.constructor

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:10](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L10)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:10](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L10)

---

Expand All @@ -70,7 +70,7 @@ Error.constructor

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:11](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L11)

---

Expand Down Expand Up @@ -98,7 +98,7 @@ Error.name

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:7](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L7)

---

Expand All @@ -108,7 +108,7 @@ Error.name

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:8](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L8)

---

Expand All @@ -118,7 +118,7 @@ Error.name

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:9](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L9)
[packages/@ackee/antonio-core/src/modules/response/errors/index.ts:9](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/errors/index.ts#L9)

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ It can be convenient to set `baseURL` for an instance of antonio to pass relativ

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:133](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L133)
[packages/@ackee/antonio-core/src/types.ts:133](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L133)

---

Expand Down Expand Up @@ -81,7 +81,7 @@ node_modules/typescript/lib/lib.dom.d.ts:1614

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:139](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L139)
[packages/@ackee/antonio-core/src/types.ts:139](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L139)

---

Expand Down Expand Up @@ -139,7 +139,7 @@ node_modules/typescript/lib/lib.dom.d.ts:1634

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:141](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L141)
[packages/@ackee/antonio-core/src/types.ts:141](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L141)

---

Expand Down Expand Up @@ -197,7 +197,7 @@ node_modules/typescript/lib/lib.dom.d.ts:1646

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:135](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L135)
[packages/@ackee/antonio-core/src/types.ts:135](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L135)

---

Expand All @@ -223,7 +223,7 @@ node_modules/typescript/lib/lib.dom.d.ts:1650

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:137](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L137)
[packages/@ackee/antonio-core/src/types.ts:137](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L137)

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:174](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L174)
[packages/@ackee/antonio-core/src/types.ts:174](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L174)

---

Expand All @@ -34,7 +34,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:154](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L154)
[packages/@ackee/antonio-core/src/types.ts:154](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L154)

---

Expand All @@ -46,7 +46,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:169](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L169)
[packages/@ackee/antonio-core/src/types.ts:169](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L169)

---

Expand All @@ -56,7 +56,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:152](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L152)
[packages/@ackee/antonio-core/src/types.ts:152](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L152)

---

Expand All @@ -66,7 +66,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:153](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L153)
[packages/@ackee/antonio-core/src/types.ts:153](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L153)

---

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

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:159](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L159)
[packages/@ackee/antonio-core/src/types.ts:159](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L159)

---

Expand All @@ -90,4 +90,4 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:164](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L164)
[packages/@ackee/antonio-core/src/types.ts:164](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L164)
22 changes: 11 additions & 11 deletions packages/@ackee/antonio-core/docs-api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:7](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L7)
[packages/@ackee/antonio-core/src/modules/core/general-config/index.ts:7](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/general-config/index.ts#L7)

---

Expand All @@ -59,7 +59,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:9](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L9)
[packages/@ackee/antonio-core/src/types.ts:9](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L9)

---

Expand All @@ -69,7 +69,7 @@

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:144](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L144)
[packages/@ackee/antonio-core/src/types.ts:144](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L144)

---

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

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:91](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L91)
[packages/@ackee/antonio-core/src/types.ts:91](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L91)

---

Expand Down Expand Up @@ -113,7 +113,7 @@ api.get('/posts', {

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:126](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L126)
[packages/@ackee/antonio-core/src/types.ts:126](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L126)

---

Expand All @@ -135,7 +135,7 @@ console.assert(data.id === '1');

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:103](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L103)
[packages/@ackee/antonio-core/src/types.ts:103](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L103)

---

Expand All @@ -145,7 +145,7 @@ console.assert(data.id === '1');

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:7](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L7)
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:7](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L7)

---

Expand All @@ -155,7 +155,7 @@ console.assert(data.id === '1');

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:75](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L75)
[packages/@ackee/antonio-core/src/types.ts:75](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L75)

---

Expand Down Expand Up @@ -231,7 +231,7 @@ function* fetchPosts() {

#### Defined in

[packages/@ackee/antonio-core/src/types.ts:73](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/types.ts#L73)
[packages/@ackee/antonio-core/src/types.ts:73](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/types.ts#L73)

## Variables

Expand All @@ -248,7 +248,7 @@ function* fetchPosts() {

#### Defined in

[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:1](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L1)
[packages/@ackee/antonio-core/src/modules/core/constants/index.ts:1](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/core/constants/index.ts#L1)

## Functions

Expand Down Expand Up @@ -294,4 +294,4 @@ function* fetchPosts() {

#### Defined in

[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/70b57b9/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)
[packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts:24](https://github.com/AckeeCZ/antonio/blob/ceeaf1e/packages/@ackee/antonio-core/src/modules/response/utils/runIterableStream.ts#L24)

0 comments on commit 23a6ee4

Please sign in to comment.