Skip to content

Commit d26dcc2

Browse files
author
Weffe
committed
Merge branch 'dev'
2 parents 1c7c61c + 69a8370 commit d26dcc2

22 files changed

+169
-17
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
# [2.1.0](https://github.com/Weffe/axios-api-versioning/compare/v2.0.0...v2.1.0) (2019-03-02)
6+
7+
8+
### Features
9+
10+
* **types:** expose custom axios types and bundle in a "types" folder ([086aa8c](https://github.com/Weffe/axios-api-versioning/commit/086aa8c))
11+
* **types:** break types into separate folders ([635e79d](https://github.com/Weffe/axios-api-versioning/commit/635e79d))
12+
13+
514
# [2.0.0](https://github.com/Weffe/axios-api-versioning/compare/v1.1.1...v2.0.0) (2019-03-01)
615

716

‎docs/api/types/AxiosAdapterWithVersioning.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `AxiosAdapterWithVersioning`
22

33
> [!NOTE]
4-
> Exported for public use? **No**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Can be accessed with: `axios-api-versioning/dist/types/axios`
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { AxiosAdapterWithVersioning } from 'axios-api-versioning/dist/types/axios';
11+
> ```
12+
13+
## Type Signature
514
615
```typescript
716
import { AxiosPromise } from 'axios';

‎docs/api/types/AxiosErrorWithVersioning.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `AxiosErrorWithVersioning`
22

33
> [!NOTE]
4-
> Exported for public use? **No**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Can be accessed with: `axios-api-versioning/dist/types/axios`
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { AxiosErrorWithVersioning } from 'axios-api-versioning/dist/types/axios';
11+
> ```
12+
13+
## Type Signature
514
615
```typescript
716
interface AxiosErrorWithVersioning extends Error {

‎docs/api/types/AxiosInstanceWithVersioning.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `AxiosInstanceWithVersioning`
22

33
> [!NOTE]
4-
> Exported for public use? **No**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Can be accessed with: `axios-api-versioning/dist/types/axios`
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { AxiosInstanceWithVersioning } from 'axios-api-versioning/dist/types/axios';
11+
> ```
12+
13+
## Type Signature
514
615
```typescript
716
import { AxiosPromise, AxiosInterceptorManager } from 'axios';

‎docs/api/types/AxiosRequestConfigWithVersioning.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `AxiosRequestConfigWithVersioning`
22

33
> [!NOTE]
4-
> Exported for public use? **No**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Can be accessed with: `axios-api-versioning/dist/types/axios`
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { AxiosRequestConfigWithVersioning } from 'axios-api-versioning/dist/types/axios';
11+
> ```
12+
13+
## Type Signature
514
615
```typescript
716
import { AxiosRequestConfig } from 'axios';

‎docs/api/types/AxiosResponseWithVersioning.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# `AxiosResponseWithVersioning`
22

33
> [!NOTE]
4-
> Exported for public use? **No**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Can be accessed with: `axios-api-versioning/dist/types/axios`
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { AxiosResponseWithVersioning } from 'axios-api-versioning/dist/types/axios';
11+
> ```
12+
13+
## Type Signature
514
615
```typescript
716
import { AxiosResponse } from 'axios';

‎docs/api/types/IWithVersioningConfig.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# `IWithVersioningConfig`
22

33
> [!NOTE]
4-
> Exported for public use? **Yes**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Import Example:
7+
> ```typescript
8+
> import { IWithVersioningConfig } from 'axios-api-versioning';
9+
> ```
10+
11+
## Type Signature
512
613
```typescript
714
interface IWithVersioningConfig {

‎docs/api/types/MediaTypeFormatterFn.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# `MediaTypeFormatterFn`
22

33
> [!NOTE]
4-
> Exported for public use? **Yes**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Import Example:
7+
> ```typescript
8+
> import { MediaTypeFormatterFn } from 'axios-api-versioning';
9+
> ```
510
611
This is used to format the value of the **Accept Header** and can only be used when your versioning strategy is `VersioningStrategy.MediaType`. Use this when you want to manually format the **Accept Header** value yourself. Make sure to return a string or else things might break.
712
13+
## Type Signature
14+
815
```typescript
916
type MediaTypeFormatterFn = (data: {
1017
apiVersion: string,

‎docs/api/types/VersioningStrategy.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# `VersioningStrategy`
22

33
> [!NOTE]
4-
> Exported for public use? **Yes**
4+
> Exported for public use? **Yes**.
5+
>
6+
> Import Example:
7+
> ```typescript
8+
> import { VersioningStrategy } from 'axios-api-versioning';
9+
> ```
10+
11+
## Type Signature
512
613
```typescript
714
enum VersioningStrategy {

‎docs/api/withVersioning.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
This method returns a new instance of the provided axios instance that's configured to manage api versioning.
44

5+
> [!NOTE]
6+
> Exported for public use? **Yes**.
7+
>
8+
> Import Example:
9+
> ```typescript
10+
> import { withVersioning } from 'axios-api-versioning';
11+
> ```
12+
13+
## Type Signature
14+
515
```typescript
616
import { AxiosInstance, AxiosStatic } from 'axios';
717

0 commit comments

Comments
 (0)