ref: Add JSDoc to exported enhancer

getsentry · Jul 24, 2020 · 7ce0256 · 7ce0256
1 parent 4c2895d
commit 7ce0256
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/react/src/redux.ts b/packages/react/src/redux.ts
@@ -77,6 +77,11 @@ const defaultOptions: SentryEnhancerOptions = {
   stateTransformer: state => state || null,
 };
 
+/**
+ * Creates an enhancer that would be passed to Redux's createStore to log actions and the latest state to Sentry.
+ *
+ * @param enhancerOptions Options to pass to the enhancer
+ */
 function createReduxEnhancer(enhancerOptions?: Partial<SentryEnhancerOptions>): StoreEnhancer {
   const options = {
     ...defaultOptions,