aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/types/plugins/register-server-option.model.ts
diff options
context:
space:
mode:
Diffstat (limited to 'server/types/plugins/register-server-option.model.ts')
-rw-r--r--server/types/plugins/register-server-option.model.ts14
1 files changed, 14 insertions, 0 deletions
diff --git a/server/types/plugins/register-server-option.model.ts b/server/types/plugins/register-server-option.model.ts
index a8b804b63..1e2bd830e 100644
--- a/server/types/plugins/register-server-option.model.ts
+++ b/server/types/plugins/register-server-option.model.ts
@@ -1,4 +1,5 @@
1import { Response, Router } from 'express' 1import { Response, Router } from 'express'
2import { Server } from 'http'
2import { Logger } from 'winston' 3import { Logger } from 'winston'
3import { ActorModel } from '@server/models/actor/actor' 4import { ActorModel } from '@server/models/actor/actor'
4import { 5import {
@@ -22,6 +23,7 @@ import {
22 RegisterServerAuthExternalResult, 23 RegisterServerAuthExternalResult,
23 RegisterServerAuthPassOptions 24 RegisterServerAuthPassOptions
24} from './register-server-auth.model' 25} from './register-server-auth.model'
26import { RegisterServerWebSocketRouteOptions } from './register-server-websocket-route.model'
25 27
26export type PeerTubeHelpers = { 28export type PeerTubeHelpers = {
27 logger: Logger 29 logger: Logger
@@ -83,6 +85,9 @@ export type PeerTubeHelpers = {
83 } 85 }
84 86
85 server: { 87 server: {
88 // PeerTube >= 5.0
89 getHTTPServer: () => Server
90
86 getServerActor: () => Promise<ActorModel> 91 getServerActor: () => Promise<ActorModel>
87 } 92 }
88 93
@@ -97,6 +102,8 @@ export type PeerTubeHelpers = {
97 102
98 // PeerTube >= 3.2 103 // PeerTube >= 3.2
99 getBaseRouterRoute: () => string 104 getBaseRouterRoute: () => string
105 // PeerTube >= 5.0
106 getBaseWebSocketRoute: () => string
100 107
101 // PeerTube >= 3.2 108 // PeerTube >= 3.2
102 getDataDirectoryPath: () => string 109 getDataDirectoryPath: () => string
@@ -140,5 +147,12 @@ export type RegisterServerOptions = {
140 // * /plugins/:pluginName/router/... 147 // * /plugins/:pluginName/router/...
141 getRouter(): Router 148 getRouter(): Router
142 149
150 // PeerTube >= 5.0
151 // Register WebSocket route
152 // Base routes of the WebSocket router are
153 // * /plugins/:pluginName/:pluginVersion/ws/...
154 // * /plugins/:pluginName/ws/...
155 registerWebSocketRoute: (options: RegisterServerWebSocketRouteOptions) => void
156
143 peertubeHelpers: PeerTubeHelpers 157 peertubeHelpers: PeerTubeHelpers
144} 158}