Skip to content

Commit 4bd2507

Browse files
committed
Add JSDoc to withSentry
1 parent 5546d11 commit 4bd2507

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

packages/solidstart/src/config/withSentry.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ import type {
99
SolidStartInlineConfigNitroHooks,
1010
} from './types';
1111

12+
/**
13+
* Modifies the passed in Solid Start configuration with build-time enhancements such as
14+
* building the `instrument.server.ts` file into the appropriate build folder based on
15+
* build preset.
16+
*
17+
* @param solidStartConfig A Solid Start configuration object, as usually passed to `defineConfig` in `app.config.ts|js`
18+
* @param sentrySolidStartConfigOptions Options to configure the plugin
19+
* @returns The modified config to be exported and passed back into `defineConfig`
20+
*/
1221
export const withSentry = (
1322
solidStartConfig: SolidStartInlineConfig = {},
1423
sentrySolidStartConfigOptions: SentrySolidStartConfigOptions = {},

0 commit comments

Comments
 (0)