docs: adds section on beforeBreadcrumb

DiederikvandenB · Feb 26, 2020 · 1923195 · 1923195
1 parent 72b6b67
commit 1923195
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,13 @@ const defaultOptions = {
    * operations to pass. See PR #9 for more details.
    */
   filter: (operation) => true,
+
+  /**
+   * Provide a callback function which receives an instance of this package's OperationBreadcrumb class
+   * Use it to modify the data that is added to the breadcrumb. Leave undefined if you want all
+   * data to be included. Very useful in combination with options like includeVariables and includeContextKeys.
+   */
+  beforeBreadcrumb: (breadcrumb) => breadcrumb,
 };
 ```