SheWhoReignsSupreme/revenge-bundle-next
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(lib/storage): document default options

Browse source
This commit is contained in:
PalmDevs 2025-10-23 17:04:24 +07:00
parent 0f7218aa1a
commit b2a378a3b2
No known key found for this signature in database
GPG key ID: 6FAE8F8677ACA8BA
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/storage/src/index.ts
View file

@ -130,14 +130,20 @@ export function getStorage<T extends AnyObject = AnyObject>(
export interface StorageOptions<T extends AnyObject = AnyObject> {
/**
* The directory of the storage file.
*
* @default 'documents'
*/
directory?: StorageDirectory
/**
* The default value to use for the storage. This will also be used for cache.
*
* @default {}
*/
default?: T
/**
* Automatically load the storage after creating the instance.
*
* @default false
*/
load?: boolean
}