fix: update docusaurus and fix config

LabO8 · Aug 7, 2024 · 1543c2d · 1543c2d
1 parent 306023e
commit 1543c2d
Show file tree

Hide file tree

Showing 38 changed files with 5,465 additions and 4,283 deletions.
diff --git a/site/docs/api/_category_.yml b/site/docs/api/_category_.yml
diff --git a/site/docs/api/classes/BucketsService.md b/site/docs/api/classes/BucketsService.md
@@ -1,223 +1,207 @@
----
-id: "BucketsService"
-title: "Class: BucketsService"
-sidebar_label: "BucketsService"
-sidebar_position: 0
-custom_edit_url: null
----
+# Class: BucketsService
 
 ## Constructors
 
-### constructor
+### new BucketsService()
 
-• **new BucketsService**(`client`)
+> **new BucketsService**(`client`): [`BucketsService`](BucketsService.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `client` | `S3Client` |
+• **client**: `S3Client`
+
+#### Returns
+
+[`BucketsService`](BucketsService.md)
 
 #### Defined in
 
-[services/buckets.service.ts:34](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L34)
+[services/buckets.service.ts:34](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L34)
 
 ## Methods
 
-### create
+### create()
 
-▸ **create**(`bucket`, `options?`): `Promise`<`CreateBucketCommandOutput`\>
+> **create**(`bucket`, `options`): `Promise`\<`CreateBucketCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `options` | `Omit`<`CreateBucketCommandInput`, ``"Bucket"``\> |
+• **bucket**: `string`
+
+• **options**: `Omit`\<`CreateBucketCommandInput`, `"Bucket"`\> = `{}`
 
 #### Returns
 
-`Promise`<`CreateBucketCommandOutput`\>
+`Promise`\<`CreateBucketCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:36](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L36)
+[services/buckets.service.ts:36](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L36)
 
-___
+***
 
-### delete
+### delete()
 
-▸ **delete**(`bucket`): `Promise`<`DeleteBucketCommandOutput`\>
+> **delete**(`bucket`): `Promise`\<`DeleteBucketCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
+• **bucket**: `string`
 
 #### Returns
 
-`Promise`<`DeleteBucketCommandOutput`\>
+`Promise`\<`DeleteBucketCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:48](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L48)
+[services/buckets.service.ts:48](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L48)
 
-___
+***
 
-### find
+### find()
 
-▸ **find**(`bucket`): `Promise`<`Bucket`\>
+> **find**(`bucket`): `Promise`\<`Bucket`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
+• **bucket**: `string`
 
 #### Returns
 
-`Promise`<`Bucket`\>
+`Promise`\<`Bucket`\>
 
 #### Defined in
 
-[services/buckets.service.ts:60](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L60)
+[services/buckets.service.ts:60](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L60)
 
-___
+***
 
-### list
+### list()
 
-▸ **list**(): `Promise`<`ListBucketsCommandOutput`\>
+> **list**(): `Promise`\<`ListBucketsCommandOutput`\>
 
 #### Returns
 
-`Promise`<`ListBucketsCommandOutput`\>
+`Promise`\<`ListBucketsCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:56](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L56)
+[services/buckets.service.ts:56](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L56)
 
-___
+***
 
-### tagging
+### tagging()
 
-▸ **tagging**(`bucket`): `Promise`<`GetBucketTaggingCommandOutput`\>
+> **tagging**(`bucket`): `Promise`\<`GetBucketTaggingCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
+• **bucket**: `string`
 
 #### Returns
 
-`Promise`<`GetBucketTaggingCommandOutput`\>
+`Promise`\<`GetBucketTaggingCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:66](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L66)
+[services/buckets.service.ts:66](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L66)
 
-___
+***
 
-### updateAccelerateConfiguration
+### updateAccelerateConfiguration()
 
-▸ **updateAccelerateConfiguration**(`bucket`, `configuration`): `Promise`<`PutBucketAccelerateConfigurationCommandOutput`\>
+> **updateAccelerateConfiguration**(`bucket`, `configuration`): `Promise`\<`PutBucketAccelerateConfigurationCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `configuration` | `AccelerateConfiguration` |
+• **bucket**: `string`
+
+• **configuration**: `AccelerateConfiguration`
 
 #### Returns
 
-`Promise`<`PutBucketAccelerateConfigurationCommandOutput`\>
+`Promise`\<`PutBucketAccelerateConfigurationCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:119](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L119)
+[services/buckets.service.ts:119](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L119)
 
-___
+***
 
-### updateAcl
+### updateAcl()
 
-▸ **updateAcl**(`bucket`, `configuration`): `Promise`<`PutBucketAclCommandOutput`\>
+> **updateAcl**(`bucket`, `configuration`): `Promise`\<`PutBucketAclCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `configuration` | `Omit`<`PutBucketAclCommandInput`, ``"Bucket"``\> |
+• **bucket**: `string`
+
+• **configuration**: `Omit`\<`PutBucketAclCommandInput`, `"Bucket"`\>
 
 #### Returns
 
-`Promise`<`PutBucketAclCommandOutput`\>
+`Promise`\<`PutBucketAclCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:83](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L83)
+[services/buckets.service.ts:83](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L83)
 
-___
+***
 
-### updateCors
+### updateCors()
 
-▸ **updateCors**(`bucket`, `configuration`): `Promise`<`PutBucketCorsCommandOutput`\>
+> **updateCors**(`bucket`, `configuration`): `Promise`\<`PutBucketCorsCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `configuration` | `CORSConfiguration` |
+• **bucket**: `string`
+
+• **configuration**: `CORSConfiguration`
 
 #### Returns
 
-`Promise`<`PutBucketCorsCommandOutput`\>
+`Promise`\<`PutBucketCorsCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:74](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L74)
+[services/buckets.service.ts:74](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L74)
 
-___
+***
 
-### updateEncryption
+### updateEncryption()
 
-▸ **updateEncryption**(`bucket`, `configuration`): `Promise`<`PutBucketEncryptionCommandOutput`\>
+> **updateEncryption**(`bucket`, `configuration`): `Promise`\<`PutBucketEncryptionCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `configuration` | `Omit`<`PutBucketEncryptionCommandInput`, ``"Bucket"``\> |
+• **bucket**: `string`
+
+• **configuration**: `Omit`\<`PutBucketEncryptionCommandInput`, `"Bucket"`\>
 
 #### Returns
 
-`Promise`<`PutBucketEncryptionCommandOutput`\>
+`Promise`\<`PutBucketEncryptionCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:107](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L107)
+[services/buckets.service.ts:107](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L107)
 
-___
+***
 
-### updateLogging
+### updateLogging()
 
-▸ **updateLogging**(`bucket`, `configuration`): `Promise`<`PutBucketLoggingCommandOutput`\>
+> **updateLogging**(`bucket`, `configuration`): `Promise`\<`PutBucketLoggingCommandOutput`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bucket` | `string` |
-| `configuration` | `Omit`<`PutBucketLoggingCommandInput`, ``"Bucket"``\> |
+• **bucket**: `string`
+
+• **configuration**: `Omit`\<`PutBucketLoggingCommandInput`, `"Bucket"`\>
 
 #### Returns
 
-`Promise`<`PutBucketLoggingCommandOutput`\>
+`Promise`\<`PutBucketLoggingCommandOutput`\>
 
 #### Defined in
 
-[services/buckets.service.ts:95](https://github.com/LabO8/nestjs-s3/blob/65a196f/src/services/buckers.service.ts#L95)
+[services/buckets.service.ts:95](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/buckets.service.ts#L95)
diff --git a/site/docs/api/classes/DefaultPrefixAlgorithmService.md b/site/docs/api/classes/DefaultPrefixAlgorithmService.md
@@ -0,0 +1,39 @@
+# Class: DefaultPrefixAlgorithmService
+
+## Implements
+
+- [`IPrefixAlgorithm`](../interfaces/IPrefixAlgorithm.md)
+
+## Constructors
+
+### new DefaultPrefixAlgorithmService()
+
+> **new DefaultPrefixAlgorithmService**(): [`DefaultPrefixAlgorithmService`](DefaultPrefixAlgorithmService.md)
+
+#### Returns
+
+[`DefaultPrefixAlgorithmService`](DefaultPrefixAlgorithmService.md)
+
+## Methods
+
+### prefix()
+
+> **prefix**(`remote`, `prefix`?): `string`
+
+#### Parameters
+
+• **remote**: `string`
+
+• **prefix?**: `string`
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+[`IPrefixAlgorithm`](../interfaces/IPrefixAlgorithm.md).[`prefix`](../interfaces/IPrefixAlgorithm.md#prefix)
+
+#### Defined in
+
+[services/default-prefix-algorithm.service.ts:4](https://github.com/LabO8/nestjs-s3/blob/306023e15fcb498533a66fc2f9b000dc61a2bf64/src/services/default-prefix-algorithm.service.ts#L4)