Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: @module docs #15

Merged
merged 1 commit into from
Jan 5, 2025
Merged

fix: @module docs #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Other tools that I regularly use and don't feel the need to optimize or re-creat
- [`axios`](https://github.com/axios/axios) - _Promise based HTTP client for the browser and node.js_
- [`hono`](https://jsr.io/@hono/hono) - _small, simple, and ultrafast web framework built on Web Standards_
- [`undici`](https://github.com/nodejs/undici) - performant HTTP/1.1 client for Node.js
- [`@upstash/redis`](https://github.com/upstash/redis-js) for HTTP redis and [`redis`](https://github.com/redis/node-redis) for TCP
- [`@turf/turf`](https://github.com/Turfjs/turf) for anything geospatial

## Lint

Expand Down
5 changes: 3 additions & 2 deletions deno.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"tasks": {
"check": "deno fmt --check && deno lint && biome lint",
"dry-run": "deno publish --dry-run",
"test": "deno test --allow-sys --allow-env --clean --coverage"
"test": "deno test --allow-sys --allow-env --clean --coverage",
"update": "deno outdated --update --latest"
},
"lint": {
"rules": {
Expand All @@ -34,7 +35,7 @@
"workspace": ["./check-required-env", "./crypto", "./dates", "./logger", "./storage-s3"],
"imports": {
"@biomejs/biome": "npm:@biomejs/biome@^1.9.4",
"@types/node": "npm:@types/node@^22.10.2",
"@types/node": "npm:@types/node@^22.10.5",
"@cross/test": "jsr:@cross/test@^0.0.10",
"@std/assert": "jsr:@std/assert@^1.0.10",
"sinon": "npm:sinon@^19.0.2"
Expand Down
8 changes: 4 additions & 4 deletions deno.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions storage-s3/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Storage S3 Changelog

## 2025-01-05 - 0.0.2

- fix: `@module` docs

## 2024-12-18 - 0.0.1

- feat: added basic setup
2 changes: 1 addition & 1 deletion storage-s3/deno.jsonc
View file
Open in desktop
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.1",
"version": "0.0.2",
"exports": "./storage.ts",
"imports": {
"minio": "npm:minio@^8.0.3"
Expand Down
10 changes: 9 additions & 1 deletion storage-s3/storage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
/**
* Storage module for S3 with common operations using MinIO.
*
* @module
*
* @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 })
* console.log(object)
* ```
*/

// import packages
Expand Down
Loading