Skip to content

Commit

Permalink
docs(2.2.2): generate documentation [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@dan-online
dan-online committed Oct 17, 2023
1 parent 259d596 commit 49cbee3
Show file tree
Hide file tree
Showing 21 changed files with 159 additions and 189 deletions.
14 changes: 14 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,20 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## Testing

The project is tested with `vitest` and requires you to have a library on your BunnyCDN account to send commands to the Bunny API.

> Warning: all videos will be deleted during testing.
### Keys

```sh
BUNNY_VIDEO_LIBRARY=xxx BUNNY_API_KEY=xxx npm test
```

Also, `IGNORE_PRUNE=1` can be used to keep the testing video at the end of the tests for further manual checking.

<!-- LICENSE -->

## License
Expand Down
112 changes: 34 additions & 78 deletions docs/classes/BunnyCdnStream-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@

#### Defined in

[src/index.ts:26](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L26)
[src/index.ts:26](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L26)

## Properties

Expand All @@ -67,7 +67,7 @@

#### Defined in

[src/index.ts:10](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L10)
[src/index.ts:10](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L10)

___

Expand All @@ -79,7 +79,7 @@ Options for connecting and authenticating with the Bunny CDN API

#### Defined in

[src/index.ts:24](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L24)
[src/index.ts:24](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L24)

## Methods

Expand Down Expand Up @@ -113,7 +113,7 @@ A [AddCaptionsVideoResponse](../interfaces/BunnyCdnStream.AddCaptionsVideoRespon

#### Defined in

[src/index.ts:378](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L378)
[src/index.ts:378](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L378)

___

Expand Down Expand Up @@ -146,7 +146,7 @@ A [VideoResponse](../interfaces/BunnyCdnStream.VideoResponse.md) instance.

#### Defined in

[src/index.ts:166](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L166)
[src/index.ts:166](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L166)

___

Expand Down Expand Up @@ -176,7 +176,7 @@ A [CreateCollectionResponse](../interfaces/BunnyCdnStream.CreateCollectionRespon

#### Defined in

[src/index.ts:417](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L417)
[src/index.ts:417](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L417)

___

Expand All @@ -199,7 +199,7 @@ await stream.createDirectUpload({ title: "My Video" })
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `Object` | The data to create the video with |
| `data.collection?` | `string` | - |
| `data.collectionId?` | `string` | - |
| `data.title` | `string` | - |
| `expirationDate?` | `Date` | - |

Expand All @@ -211,7 +211,7 @@ A [CreateDirectUpload](../interfaces/BunnyCdnStream.CreateDirectUpload.md)

#### Defined in

[src/index.ts:572](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L572)
[src/index.ts:572](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L572)

___

Expand Down Expand Up @@ -243,7 +243,7 @@ A [VideoResponse](../interfaces/BunnyCdnStream.VideoResponse.md) instance.

#### Defined in

[src/index.ts:123](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L123)
[src/index.ts:123](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L123)

___

Expand All @@ -267,7 +267,7 @@ void

#### Defined in

[src/index.ts:549](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L549)
[src/index.ts:549](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L549)

___

Expand All @@ -293,7 +293,7 @@ void

#### Defined in

[src/index.ts:103](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L103)
[src/index.ts:103](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L103)

___

Expand Down Expand Up @@ -324,7 +324,7 @@ A [DeleteCaptionsVideoResponse](../interfaces/BunnyCdnStream.DeleteCaptionsVideo

#### Defined in

[src/index.ts:401](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L401)
[src/index.ts:401](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L401)

___

Expand Down Expand Up @@ -354,7 +354,7 @@ A [DeleteCollectionResponse](../interfaces/BunnyCdnStream.DeleteCollectionRespon

#### Defined in

[src/index.ts:534](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L534)
[src/index.ts:534](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L534)

___

Expand Down Expand Up @@ -384,7 +384,7 @@ A [DeleteVideoResponse](../interfaces/BunnyCdnStream.DeleteVideoResponse.md) ins

#### Defined in

[src/index.ts:85](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L85)
[src/index.ts:85](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L85)

___

Expand Down Expand Up @@ -419,7 +419,7 @@ A [FetchVideoResponse](../interfaces/BunnyCdnStream.FetchVideoResponse.md) insta

#### Defined in

[src/index.ts:359](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L359)
[src/index.ts:359](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L359)

___

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

#### Defined in

[src/index.ts:595](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L595)
[src/index.ts:595](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L595)

___

Expand Down Expand Up @@ -470,65 +470,21 @@ A [BunnyCdnStreamCollection](../interfaces/BunnyCdnStream.BunnyCdnStreamCollecti

#### Defined in

[src/index.ts:434](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L434)
[src/index.ts:434](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L434)

___

### getOptions

▸ `Private` **getOptions**(): `Object`
▸ `Private` **getOptions**(): `AxiosRequestConfig`<`any`\> & { `headers`: `AxiosHeaders` }

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `adapter?` | `AxiosAdapterConfig` \| `AxiosAdapterConfig`[] |
| `auth?` | `AxiosBasicCredentials` |
| `baseURL?` | `string` |
| `beforeRedirect?` | (`options`: `Record`<`string`, `any`\>, `responseDetails`: { `headers`: `Record`<`string`, `string`\> }) => `void` |
| `cancelToken?` | `CancelToken` |
| `data?` | `any` |
| `decompress?` | `boolean` |
| `env?` | { `FormData?`: (...`args`: `any`[]) => `object` } |
| `env.FormData?` | (...`args`: `any`[]) => `object` |
| `family?` | ``4`` \| ``6`` |
| `formSerializer?` | `FormSerializerOptions` |
| `headers` | `AxiosHeaders` |
| `httpAgent?` | `any` |
| `httpsAgent?` | `any` |
| `insecureHTTPParser?` | `boolean` |
| `lookup?` | (`hostname`: `string`, `options`: `object`, `cb`: (`err`: ``null`` \| `Error`, `address`: `string`, `family`: `number`) => `void`) => `void` \| (`hostname`: `string`, `options`: `object`) => `Promise`<`string` \| [address: string, family: number]\> |
| `maxBodyLength?` | `number` |
| `maxContentLength?` | `number` |
| `maxRate?` | `number` \| [`number`, `number`] |
| `maxRedirects?` | `number` |
| `method?` | `string` |
| `onDownloadProgress?` | (`progressEvent`: `AxiosProgressEvent`) => `void` |
| `onUploadProgress?` | (`progressEvent`: `AxiosProgressEvent`) => `void` |
| `params?` | `any` |
| `paramsSerializer?` | `ParamsSerializerOptions` \| `CustomParamsSerializer` |
| `proxy?` | ``false`` \| `AxiosProxyConfig` |
| `responseEncoding?` | `string` |
| `responseType?` | `ResponseType` |
| `signal?` | `GenericAbortSignal` |
| `socketPath?` | ``null`` \| `string` |
| `timeout?` | `number` |
| `timeoutErrorMessage?` | `string` |
| `transformRequest?` | `AxiosRequestTransformer` \| `AxiosRequestTransformer`[] |
| `transformResponse?` | `AxiosResponseTransformer` \| `AxiosResponseTransformer`[] |
| `transitional?` | `TransitionalOptions` |
| `transport?` | `any` |
| `url?` | `string` |
| `validateStatus?` | ``null`` \| (`status`: `number`) => `boolean` |
| `withCredentials?` | `boolean` |
| `xsrfCookieName?` | `string` |
| `xsrfHeaderName?` | `string` |
`AxiosRequestConfig`<`any`\> & { `headers`: `AxiosHeaders` }

#### Defined in

[src/index.ts:626](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L626)
[src/index.ts:626](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L626)

___

Expand Down Expand Up @@ -558,7 +514,7 @@ A [VideoResponse](../interfaces/BunnyCdnStream.VideoResponse.md) instance.

#### Defined in

[src/index.ts:40](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L40)
[src/index.ts:40](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L40)

___

Expand Down Expand Up @@ -588,7 +544,7 @@ A [VideoHeatmapResponse](../interfaces/BunnyCdnStream.VideoHeatmapResponse.md) i

#### Defined in

[src/index.ts:183](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L183)
[src/index.ts:183](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L183)

___

Expand Down Expand Up @@ -622,7 +578,7 @@ A [VideoStatisticsResponse](../interfaces/BunnyCdnStream.VideoStatisticsResponse

#### Defined in

[src/index.ts:200](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L200)
[src/index.ts:200](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L200)

___

Expand Down Expand Up @@ -656,7 +612,7 @@ An array of [BunnyCdnStreamCollection](../interfaces/BunnyCdnStream.BunnyCdnStre

#### Defined in

[src/index.ts:475](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L475)
[src/index.ts:475](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L475)

___

Expand All @@ -681,7 +637,7 @@ await stream.listAllVideos()
| `data.itemsPerPage?` | `number` | - |
| `data.orderBy?` | `string` | - |
| `data.search?` | `string` | - |
| `stop?` | (`videos`: [`BunnyCdnStreamVideo`](BunnyCdnStreamVideo.md)[], `page`: `number`, `totalPages`: `number`) => `boolean` | The callback that if returns ``true`` stops the iteration |
| `stop?` | (`videos`: [`BunnyCdnStreamVideo`](BunnyCdnStreamVideo.md)[], `page`: `number`, `totalPages`: `number`) => `boolean` \| `Promise`<`boolean`\> | The callback that if returns ``true`` stops the iteration |

#### Returns

Expand All @@ -691,7 +647,7 @@ An array of [VideoStatisticsResponse](../interfaces/BunnyCdnStream.VideoStatisti

#### Defined in

[src/index.ts:276](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L276)
[src/index.ts:276](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L276)

___

Expand Down Expand Up @@ -725,7 +681,7 @@ a [ListCollectionsResponse](../interfaces/BunnyCdnStream.ListCollectionsResponse

#### Defined in

[src/index.ts:449](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L449)
[src/index.ts:449](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L449)

___

Expand Down Expand Up @@ -760,7 +716,7 @@ An array of [VideoStatisticsResponse](../interfaces/BunnyCdnStream.VideoStatisti

#### Defined in

[src/index.ts:245](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L245)
[src/index.ts:245](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L245)

___

Expand Down Expand Up @@ -792,7 +748,7 @@ A [VideoResponse](../interfaces/BunnyCdnStream.VideoResponse.md) instance.

#### Defined in

[src/index.ts:226](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L226)
[src/index.ts:226](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L226)

___

Expand All @@ -819,7 +775,7 @@ ___

#### Defined in

[src/index.ts:602](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L602)
[src/index.ts:602](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L602)

___

Expand Down Expand Up @@ -853,7 +809,7 @@ A [SetThumbnailVideoResponse](../interfaces/BunnyCdnStream.SetThumbnailVideoResp

#### Defined in

[src/index.ts:327](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L327)
[src/index.ts:327](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L327)

___

Expand Down Expand Up @@ -885,7 +841,7 @@ A [UpdateCollectionResponse](../interfaces/BunnyCdnStream.UpdateCollectionRespon

#### Defined in

[src/index.ts:517](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L517)
[src/index.ts:517](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L517)

___

Expand Down Expand Up @@ -921,7 +877,7 @@ A [VideoResponse](../interfaces/BunnyCdnStream.VideoResponse.md) instance.

#### Defined in

[src/index.ts:58](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L58)
[src/index.ts:58](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L58)

___

Expand Down Expand Up @@ -954,4 +910,4 @@ A [UploadVideoResponse](../interfaces/BunnyCdnStream.UploadVideoResponse.md) ins

#### Defined in

[src/index.ts:145](https://github.com/dan-online/bunnycdn-stream/blob/ba93b87/src/index.ts#L145)
[src/index.ts:145](https://github.com/dan-online/bunnycdn-stream/blob/259d596/src/index.ts#L145)
Loading

0 comments on commit 49cbee3

Please sign in to comment.