@nifrajs/storage 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/dist/capabilities.d.ts +55 -0
- package/dist/capabilities.d.ts.map +1 -0
- package/dist/capabilities.js +122 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/conformance.d.ts +1 -1
- package/dist/conformance.js +1 -1
- package/dist/file.d.ts +20 -1
- package/dist/file.d.ts.map +1 -1
- package/dist/file.js +192 -25
- package/dist/file.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/key.d.ts +1 -1
- package/dist/key.js +2 -2
- package/dist/memory.js +1 -1
- package/dist/r2.js +1 -1
- package/dist/types.d.ts +3 -3
- package/dist/types.js +1 -1
- package/package.json +2 -2
- package/src/capabilities.ts +172 -0
- package/src/conformance.ts +1 -1
- package/src/file.ts +194 -23
- package/src/index.ts +8 -1
- package/src/key.ts +2 -2
- package/src/memory.ts +1 -1
- package/src/r2.ts +1 -1
- package/src/types.ts +3 -3
package/src/types.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @nifrajs/storage
|
|
2
|
+
* @nifrajs/storage - one blob-storage interface, several adapters. The persistence half of
|
|
3
3
|
* `@nifrajs/uploads` (which validates + signs but doesn't store): `uploads` decides what's allowed,
|
|
4
4
|
* `storage` puts the bytes somewhere. Adapters: {@link MemoryStorage} (dev/test), `FileStorage` (local
|
|
5
5
|
* disk), `R2Storage` (Cloudflare R2). Bring your own for S3/GCS by implementing {@link StorageAdapter}.
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
|
-
/** Accepted `put` payloads
|
|
8
|
+
/** Accepted `put` payloads - normalized to bytes by each adapter. */
|
|
9
9
|
export type StorageData = Uint8Array | ArrayBuffer | string
|
|
10
10
|
|
|
11
11
|
export interface PutOptions {
|
|
@@ -15,7 +15,7 @@ export interface PutOptions {
|
|
|
15
15
|
readonly metadata?: Readonly<Record<string, string>>
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
/** An object read back from storage. `body` is buffered (not streamed)
|
|
18
|
+
/** An object read back from storage. `body` is buffered (not streamed) - fine for typical uploads. */
|
|
19
19
|
export interface StorageObject {
|
|
20
20
|
readonly body: Uint8Array
|
|
21
21
|
readonly size: number
|