Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
tbnritzdoge committed Apr 7, 2021
2 parents 2b44da1 + 6d1acb3 commit bec5c13
Show file tree
Hide file tree
Showing 55 changed files with 2,260 additions and 57 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/cd-document.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@ on:
push:
branches:
- master
paths:
- "docs/**"
pull_request:
branches:
- master
paths:
- "docs/**"
release:
types: [published]
types: [created]
jobs:
test:
name: Build Documentation
Expand Down Expand Up @@ -89,7 +85,10 @@ jobs:
with:
ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
- name: "[EXEC] Deploy documentation"
run: npm run deploy
run: |
git config --global user.name 'Kludge Cyber Systems (CI)'
git config --global user.email contact@kludge-cs.co.uk
npm run deploy
working-directory: ./docs
env:
USE_SSH: true
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/cd-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ jobs:
git config --global user.email contact@kludge-cs.co.uk
mkdir $GITHUB_WORKSPACE/../transfer
PACKAGE_VERSION=$(node -pe "require('./package.json').version")
TARBALL=$(npm pack)
cp $TARBALL $GITHUB_WORKSPACE/../transfer
npm pack
cp *.tgz $GITHUB_WORKSPACE/../transfer
if [[ $(git checkout build) ]]; then
echo -e "# Using existing build"
git restore --staged . || true
Expand All @@ -89,8 +89,8 @@ jobs:
git commit --allow-empty -m 'chore: initial commit' || true
fi
git clean -fdx && git reset --hard HEAD
git rm -rf . && cp -r $GITHUB_WORKSPACE/../transfer/$TARBALL ./
tar -xf $TARBALL && rm $TARBALL
git rm -rf . && cp -r $GITHUB_WORKSPACE/../transfer/*.tgz ./
tar -xf *.tgz && rm *.tgz
git add .
git commit -m "build: v${PACKAGE_VERSION}" || true
git push --set-upstream origin build
Expand Down
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
## [1.2.1](https://github.com/helperdiscord/petitio/compare/v1.2.0...v1.2.1) (2021-04-07)


### Bug Fixes

* **docs:** new baseUrl ([cc50d17](https://github.com/helperdiscord/petitio/commit/cc50d176ad14f2ca10a865c3eb0ed7d2b511f84a))

# [1.2.0](https://github.com/helperdiscord/petitio/compare/v1.1.0...v1.2.0) (2021-04-07)


### Bug Fixes

* **PetitioResponse:** support non-ascii json responses ([#11](https://github.com/helperdiscord/petitio/issues/11)) ([d8344e4](https://github.com/helperdiscord/petitio/commit/d8344e44bb2ca247082c7f330354a76869e49793))


### Features

* add support for stream ([c706801](https://github.com/helperdiscord/petitio/commit/c7068011464ce003d4443ab975b48bab9b0ac74f))
* add text encoding option & tests ([7f6f5c6](https://github.com/helperdiscord/petitio/commit/7f6f5c63f3dddc2838c7dc1975c8a5c9335f120d))


### Performance Improvements

* remove spread operators and callback loops ([#12](https://github.com/helperdiscord/petitio/issues/12)) ([3bf48cc](https://github.com/helperdiscord/petitio/commit/3bf48cc1d002fb342af932f720dfc833c94461fe))

# [1.1.0](https://github.com/helperdiscord/petitio/compare/v1.0.0...v1.1.0) (2021-03-22)


Expand Down
56 changes: 28 additions & 28 deletions docs/docs/pkg/classes/petitiorequest.petitiorequest-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Name | Type | Default value | Description |

The Petitio request instance for your URL.

Defined in: [lib/PetitioRequest.ts:66](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L66)
Defined in: [lib/PetitioRequest.ts:66](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L66)

## Properties

Expand All @@ -39,7 +39,7 @@ Options to use for Undici under the hood.

**`see`** [Undici ClientOptions documentation](https://github.com/nodejs/undici/blob/main/docs/api/Client.md#parameter-clientoptions)

Defined in: [lib/PetitioRequest.ts:34](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L34)
Defined in: [lib/PetitioRequest.ts:34](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L34)

___

Expand All @@ -51,7 +51,7 @@ The data to be sent as the request body.
This will be a buffer or string for normal requests, or a stream.Readable
if the request is to be sent as a stream.

Defined in: [lib/PetitioRequest.ts:40](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L40)
Defined in: [lib/PetitioRequest.ts:40](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L40)

___

Expand All @@ -61,7 +61,7 @@ ___

**`see`** [HTTPMethod](../modules/petitiorequest.md#httpmethod)

Defined in: [lib/PetitioRequest.ts:44](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L44)
Defined in: [lib/PetitioRequest.ts:44](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L44)

___

Expand All @@ -71,7 +71,7 @@ ___

**`see`** [PetitioRequest.client](petitiorequest.petitiorequest-1.md#client)

Defined in: [lib/PetitioRequest.ts:48](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L48)
Defined in: [lib/PetitioRequest.ts:48](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L48)

___

Expand All @@ -82,7 +82,7 @@ ___
Whether [PetitioRequest.kClient](petitiorequest.petitiorequest-1.md#kclient) will persist between [PetitioRequest.send](petitiorequest.petitiorequest-1.md#send)
calls. It is recommended to enable this for superior performance.

Defined in: [lib/PetitioRequest.ts:53](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L53)
Defined in: [lib/PetitioRequest.ts:53](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L53)

___

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

The headers to attach to the request.

Defined in: [lib/PetitioRequest.ts:57](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L57)
Defined in: [lib/PetitioRequest.ts:57](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L57)

___

Expand All @@ -104,7 +104,7 @@ The timeout options for the Undici client.

**`see`** [TimeoutOptions](../interfaces/petitiorequest.timeoutoptions.md)

Defined in: [lib/PetitioRequest.ts:62](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L62)
Defined in: [lib/PetitioRequest.ts:62](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L62)

___

Expand All @@ -114,7 +114,7 @@ ___

The URL destination for the request, targeted in [PetitioRequest.send](petitiorequest.petitiorequest-1.md#send).

Defined in: [lib/PetitioRequest.ts:66](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L66)
Defined in: [lib/PetitioRequest.ts:66](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L66)

## Methods

Expand All @@ -130,7 +130,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:131](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L131)
Defined in: [lib/PetitioRequest.ts:129](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L129)

**body**(`data`: *Record*<string, any\>, `sendAs?`: *json*): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -143,7 +143,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:139](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L139)
Defined in: [lib/PetitioRequest.ts:137](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L137)

**body**(`data`: *string* \| *ParsedUrlQueryInput*, `sendAs`: *form*): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -156,7 +156,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:147](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L147)
Defined in: [lib/PetitioRequest.ts:145](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L145)

**body**(`data`: *Readable*, `sendAs`: *stream*): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -169,7 +169,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:154](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L154)
Defined in: [lib/PetitioRequest.ts:152](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L152)

___

Expand All @@ -190,7 +190,7 @@ Name | Type | Description |

The request object for further composition.

Defined in: [lib/PetitioRequest.ts:85](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L85)
Defined in: [lib/PetitioRequest.ts:85](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L85)

___

Expand All @@ -207,7 +207,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:198](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L198)
Defined in: [lib/PetitioRequest.ts:196](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L196)

**header**(`header`: *Record*<string, string\>): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -219,7 +219,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:202](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L202)
Defined in: [lib/PetitioRequest.ts:200](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L200)

___

Expand All @@ -237,7 +237,7 @@ Name | Default | Description |

A serialized object result from sending the request.

Defined in: [lib/PetitioRequest.ts:264](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L264)
Defined in: [lib/PetitioRequest.ts:262](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L262)

___

Expand All @@ -255,7 +255,7 @@ Name | Type | Description |

The request object for further composition.

Defined in: [lib/PetitioRequest.ts:216](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L216)
Defined in: [lib/PetitioRequest.ts:214](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L214)

___

Expand All @@ -273,7 +273,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:245](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L245)
Defined in: [lib/PetitioRequest.ts:243](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L243)

**option**<T\>(`key`: T, `value`: Options[T]): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -294,7 +294,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:252](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L252)
Defined in: [lib/PetitioRequest.ts:250](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L250)

___

Expand All @@ -315,7 +315,7 @@ Name | Type | Description |

The request object for further composition.

Defined in: [lib/PetitioRequest.ts:122](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L122)
Defined in: [lib/PetitioRequest.ts:120](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L120)

___

Expand All @@ -336,7 +336,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:99](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L99)
Defined in: [lib/PetitioRequest.ts:99](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L99)

**query**(`key`: *Record*<string, any\>): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -352,7 +352,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:106](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L106)
Defined in: [lib/PetitioRequest.ts:106](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L106)

___

Expand All @@ -364,7 +364,7 @@ ___

The raw response body as a buffer.

Defined in: [lib/PetitioRequest.ts:272](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L272)
Defined in: [lib/PetitioRequest.ts:270](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L270)

___

Expand All @@ -378,7 +378,7 @@ Finalizes and sends the composable request to the target server.

The response object.

Defined in: [lib/PetitioRequest.ts:290](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L290)
Defined in: [lib/PetitioRequest.ts:288](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L288)

___

Expand All @@ -390,7 +390,7 @@ ___

The raw response body as a string.

Defined in: [lib/PetitioRequest.ts:280](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L280)
Defined in: [lib/PetitioRequest.ts:278](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L278)

___

Expand All @@ -408,7 +408,7 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:227](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L227)
Defined in: [lib/PetitioRequest.ts:225](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L225)

**timeout**(`timeout`: keyof [*TimeoutOptions*](../interfaces/petitiorequest.timeoutoptions.md), `time`: *number*): [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Expand All @@ -423,4 +423,4 @@ Name | Type | Description |

**Returns:** [*PetitioRequest*](petitiorequest.petitiorequest-1.md)

Defined in: [lib/PetitioRequest.ts:233](https://github.com/helperdiscord/petitio/blob/eff2aca/src/lib/PetitioRequest.ts#L233)
Defined in: [lib/PetitioRequest.ts:231](https://github.com/helperdiscord/petitio/blob/4e06ad6/src/lib/PetitioRequest.ts#L231)
Loading

0 comments on commit bec5c13

Please sign in to comment.