Skip to content

Commit 5b18b56

Browse files
committed
fix: change jsdoc description
1 parent ba08287 commit 5b18b56

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

lib/ConfigManager.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,18 @@ export type ConfigManagerOptions<TData> = {
3535
& ({
3636
/**
3737
* Function to use to encode the data prior to saving it in persistent storage.
38-
* The input data is a serialized JSON object.
38+
* If this is specified, make sure to declare {@linkcode decodeData()} as well.
3939
*
4040
* You can make use of UserUtils' [`compress()`](https://github.com/Sv443-Network/UserUtils?tab=readme-ov-file#compress) function here to make the data use up less space at the cost of a little bit of performance.
41+
* @param data The input data as a serialized object (JSON string)
4142
*/
4243
encodeData: (data: string) => string | Promise<string>,
4344
/**
4445
* Function to use to decode the data after reading it from persistent storage.
45-
* The result should be a valid JSON object.
46+
* If this is specified, make sure to declare {@linkcode encodeData()} as well.
4647
*
4748
* You can make use of UserUtils' [`decompress()`](https://github.com/Sv443-Network/UserUtils?tab=readme-ov-file#decompress) function here to make the data use up less space at the cost of a little bit of performance.
49+
* @returns The resulting data as a valid serialized object (JSON string)
4850
*/
4951
decodeData: (data: string) => string | Promise<string>,
5052
} | {

0 commit comments

Comments
 (0)