Skip to content

Commit 73d457b

Browse files
authored
docs(rsc): fix jsdoc (#623)
1 parent 6ab1973 commit 73d457b

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

packages/plugin-rsc/src/plugin.ts

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,19 +95,26 @@ export type RscPluginOptions = {
9595

9696
/**
9797
* This option allows customizing how client build copies assets from server build.
98-
* By default, all assets are copied, but frameworks might want to establish some convention
99-
* to tighten security based on this option.
98+
* By default, all assets are copied, but frameworks can establish server asset convention
99+
* to tighten security using this option.
100100
*/
101101
copyServerAssetsToClient?: (fileName: string) => boolean
102102

103-
defineEncryptionKey?: string
104-
105103
/**
106-
* Allows enabling action closure encryption for debugging purpose.
104+
* This option allows disabling action closure encryption for debugging purpose.
107105
* @default true
108106
*/
109107
enableActionEncryption?: boolean
110108

109+
/**
110+
* By default, the plugin uses a build-time generated encryption key for
111+
* "use server" closure argument binding.
112+
* This can be overwritten by configuring `defineEncryptionKey` option,
113+
* for example, to obtain a key through environment variable during runtime.
114+
* cf. https://nextjs.org/docs/app/guides/data-security#overwriting-encryption-keys-advanced
115+
*/
116+
defineEncryptionKey?: string
117+
111118
/** Escape hatch for Waku's `allowServer` */
112119
keepUseCientProxy?: boolean
113120
}

0 commit comments

Comments
 (0)