diff --git a/README.md b/README.md index a649f1e..8c8e3d9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/deno.jsonc b/deno.jsonc index 4afb0b8..894735f 100644 --- a/deno.jsonc +++ b/deno.jsonc @@ -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": { @@ -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" diff --git a/deno.lock b/deno.lock index 36e9573..862a97f 100644 --- a/deno.lock +++ b/deno.lock @@ -12,7 +12,7 @@ "npm:@types/luxon@*": "3.4.2", "npm:@types/luxon@^3.4.2": "3.4.2", "npm:@types/node@*": "22.5.4", - "npm:@types/node@^22.10.2": "22.10.2", + "npm:@types/node@^22.10.5": "22.10.5", "npm:luxon@^3.5.0": "3.5.0", "npm:minio@^8.0.3": "8.0.3", "npm:sinon@^19.0.2": "19.0.2", @@ -122,8 +122,8 @@ "@types/luxon@3.4.2": { "integrity": "sha512-TifLZlFudklWlMBfhubvgqTXRzLDI5pCbGa4P8a3wPyUQSW+1xQ5eDsreP9DWHX3tjq1ke96uYG/nwundroWcA==" }, - "@types/node@22.10.2": { - "integrity": "sha512-Xxr6BBRCAOQixvonOye19wnzyDiUtTeqldOOmj3CkeblonbccA12PFwlufvRdrpjXxqnmUaeiU5EOA+7s5diUQ==", + "@types/node@22.10.5": { + "integrity": "sha512-F8Q+SeGimwOo86fiovQh8qiXfFEh2/ocYv7tU5pJ3EXMSSxk1Joj5wefpFK2fHTf/N6HKGSxIDBT9f3gCxXPkQ==", "dependencies": [ "undici-types@6.20.0" ] @@ -675,7 +675,7 @@ "jsr:@cross/test@^0.0.10", "jsr:@std/assert@^1.0.10", "npm:@biomejs/biome@^1.9.4", - "npm:@types/node@^22.10.2", + "npm:@types/node@^22.10.5", "npm:sinon@^19.0.2" ], "members": { diff --git a/storage-s3/CHANGELOG.md b/storage-s3/CHANGELOG.md index 8be8814..35a54f1 100644 --- a/storage-s3/CHANGELOG.md +++ b/storage-s3/CHANGELOG.md @@ -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 diff --git a/storage-s3/deno.jsonc b/storage-s3/deno.jsonc index c83696d..f34e450 100644 --- 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.1", + "version": "0.0.2", "exports": "./storage.ts", "imports": { "minio": "npm:minio@^8.0.3" diff --git a/storage-s3/storage.ts b/storage-s3/storage.ts index 98f73c3..3375290 100644 --- a/storage-s3/storage.ts +++ b/storage-s3/storage.ts @@ -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