Merge pull request segmentio#4014 from segmentio/niall/add_plugin_rn_info

pwseg · web-flow · commit 66c35ed07bb0 · 2023-01-09T20:27:59.000-06:00
Add docs for adding a plugin to a destination plugin
diff --git a/src/connections/sources/catalog/libraries/mobile/react-native/index.md b/src/connections/sources/catalog/libraries/mobile/react-native/index.md
@@ -481,6 +481,47 @@ segmentClient.add({ plugin: new Logger() });
 
 As the plugin overrides the `execute()` method, this `Logger` calls `console.log` for every event going through the Timeline.
 
+### Add a custom Destination Plugin 
+
+You can add custom plugins to Destination Plugins. For example, you could implement the following logic to send events to Braze on weekends only:
+
+```js
+
+import { createClient } from '@segment/analytics-react-native';
+
+import {BrazePlugin} from '@segment/analytics-react-native-plugin-braze';
+import {BrazeEventPlugin} from './BrazeEventPlugin';
+
+const segmentClient = createClient({
+  writeKey: 'SEGMENT_KEY'
+});
+
+const brazeplugin = new BrazePlugin();
+const myBrazeEventPlugin = new BrazeEventPlugin();
+brazeplugin.add(myBrazeEventPlugin);
+segmentClient.add({plugin: brazeplugin});
+
+// Plugin code for BrazeEventPlugin.ts
+import {
+  Plugin,
+  PluginType,
+  SegmentEvent,
+} from '@segment/analytics-react-native';
+
+export class BrazeEventPlugin extends Plugin {
+  type = PluginType.before;
+
+  execute(event: SegmentEvent) {
+    var today = new Date();
+    if (today.getDay() === 6 || today.getDay() === 0) {
+      return event;
+    }
+  }
+}
+```
+
+Segment would then send events to the Braze Destination Plugin on Saturdays and Sundays, based on device time.
+
 ### Example Plugins
 These are the example plugins you can use and alter to meet your tracking needs:
 
