From 9777fe9eebe53debdf45091cab98f72a5987e05a Mon Sep 17 00:00:00 2001
From: John Livingston <38844060+JohnXLivingston@users.noreply.github.com>
Date: Thu, 3 Jun 2021 12:28:26 +0200
Subject: Adding frontend peertubeHelpers.getBaseRouterRoute. (#4153)

* Adding frontend peertubeHelpers.getBaseRouterRoute.

* Fix doctoc.
---
 support/doc/plugins/guide.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'support/doc')

diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index d3b9db0ed..db1f1863c 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -21,6 +21,7 @@
     - [Notifier](#notifier)
     - [Markdown Renderer](#markdown-renderer)
     - [Auth header](#auth-header)
+    - [Plugin router route](#plugin-router-route)
     - [Custom Modal](#custom-modal)
     - [Translate](#translate)
     - [Get public settings](#get-public-settings)
@@ -561,6 +562,27 @@ function register (...) {
 }
 ```
 
+#### Plugin router route
+
+**PeerTube >= 3.3**
+
+To get your plugin router route, you can use `peertubeHelpers.getBaseRouterRoute()`:
+
+```js
+function register (...) {
+  registerHook({
+    target: 'action:video-watch.video.loaded',
+    handler: ({ video }) => {
+      fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', {
+        method: 'GET',
+        headers: peertubeHelpers.getAuthHeader()
+      }).then(res => res.json())
+        .then(data => console.log('Hi %s.', data))
+    }
+  })
+}
+```
+
 #### Custom Modal
 
 To show a custom modal:
-- 
cgit v1.2.3