fix: @module docs

frytg · Jan 5, 2025 · de8f9cd · de8f9cd
1 parent 630980c
commit de8f9cd
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/storage-s3/CHANGELOG.md b/storage-s3/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Storage S3 Changelog
 
+## 2025-01-05 - 0.0.3
+
+- fix: `@module` docs
+
 ## 2025-01-05 - 0.0.2
 
 - fix: `@module` docs

diff --git a/storage-s3/deno.jsonc b/storage-s3/deno.jsonc
@@ -1,7 +1,7 @@
 {
 	"$schema": "https://jsr.io/schema/config-file.v1.json",
 	"name": "@frytg/storage-s3",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"exports": "./storage.ts",
 	"imports": {
 		"minio": "npm:minio@^8.0.3"

diff --git a/storage-s3/storage.ts b/storage-s3/storage.ts
@@ -1,13 +1,13 @@
 /**
  * Storage module for S3 with common operations using MinIO.
  * @module
+ * @see https://min.io/docs/minio/linux/developers/javascript/API.html
  *
  * @example
  * ```ts
- * import { getRequiredEnv } from '@frytg/check-required-env/get'
  * import { getObject } from '@frytg/storage-s3'
  *
- * const object = await getObject(getRequiredEnv('S3_BUCKET_NAME'), 'path/to/object.json', { parseJson: true })
+ * const object = await getObject(process.env.S3_BUCKET_NAME, 'path/to/object.json', { parseJson: true })
  * console.log(object)
  * ```
  */