Skip to content

Commit f09d738

Browse files
committed
docs(core): add jsdoc to MetaStorageOptions fields
1 parent c6bea49 commit f09d738

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

packages/core/src/storages/meta-storage.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,17 @@ export interface UploadList {
1818
}
1919

2020
export interface MetaStorageOptions {
21+
/**
22+
* Prefix added to the storage key (file path, Redis key, etc.).
23+
* @default ''
24+
*/
2125
prefix?: string;
26+
27+
/**
28+
* Suffix appended to the storage key.
29+
* Prevents name collisions when storing metadata alongside binary files.
30+
* @default '.META'
31+
*/
2232
suffix?: string;
2333
}
2434

@@ -28,6 +38,7 @@ export interface MetaStorageOptions {
2838
export class MetaStorage<T> {
2939
prefix = '';
3040
suffix = '';
41+
3142
logger: Logger = uploadxLogger.getChild(this.constructor.name);
3243

3344
constructor(options?: MetaStorageOptions) {

0 commit comments

Comments
 (0)