Skip to content

Commit

Permalink
fix: @module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
frytg committed Jan 5, 2025
1 parent de8f9cd commit 1905256
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 4 additions & 0 deletions storage-s3/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Storage S3 Changelog

## 2025-01-05 - 0.0.4

- fix: `@module` docs

## 2025-01-05 - 0.0.3

- fix: `@module` docs
Expand Down
2 changes: 1 addition & 1 deletion storage-s3/deno.jsonc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://jsr.io/schema/config-file.v1.json",
"name": "@frytg/storage-s3",
"version": "0.0.3",
"version": "0.0.4",
"exports": "./storage.ts",
"imports": {
"minio": "npm:minio@^8.0.3"
Expand Down
6 changes: 4 additions & 2 deletions storage-s3/storage.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Storage module for S3 with common operations using MinIO.
* @module
* @see https://min.io/docs/minio/linux/developers/javascript/API.html
*
* @see {@link https://min.io/docs/minio/linux/developers/javascript/API.html}
*
* @example
* ```ts
Expand All @@ -10,6 +10,8 @@
* const object = await getObject(process.env.S3_BUCKET_NAME, 'path/to/object.json', { parseJson: true })
* console.log(object)
* ```
*
* @module
*/

// import packages
Expand Down

0 comments on commit 1905256

Please sign in to comment.