doc: missing ctx.state entries
Massimo Melina committed
May 1, 2026 at 00:25 UTC
dda000e5afef4ea9ec70779ac9ca1ce986fb3544
1 file changed
+9
-1
dev-plugins.md
+9
-1
@@ -884,6 +884,7 @@ If so, please report, and we'll do our best to update it asap.
884
Where there is too little information, you'll have to consult the source code. Apologies.
885
886
originalPath: string // before roots is applied
887
+ root?: string // root path applied to this request
888
browsing?: string // for admin/monitoring
889
dontLog?: boolean // don't log this request
890
logExtra?: object
@@ -891,17 +892,24 @@ Where there is too little information, you'll have to consult the source code. A
892
spam?: boolean // this request was marked as spam
893
params: Record<string, any>
894
account?: Account // user logged in
895
+ usernames?: Set<string> // cached expanded usernames for permission checks
896
revProxyPath: string
897
connection: Connection
898
+ whenProxyDetected?: Date
899
skipFilters?: boolean
900
vfsNode?: VfsNode
901
includesLastByte?: boolean
902
+ considerAsGui?: boolean // treat this request as part of the gui
903
serveApp?: boolean // please, serve the frontend app
904
uploadPath?: string // current one
905
uploads?: string[] // in case of request with potentially multiple uploads (POST), we register all filenames (no full path)
906
length?: number
907
+ opProgress?: number // current transfer progress, from 0 to 1
908
+ opTotal?: number // total bytes for the current operation
909
+ opOffset?: number // initial completed fraction for resumed operations
910
originalStream?: typeof ctx.body
911
uploadDestinationPath?: string // this value is the temporary file in uploadStart and the final one in uploadFinished
912
+ uploadSize?: number // final upload size
913
archive?: string
914
fileSource?: string // set when serving a file
915
fileStats?: Stat // file attributes
@@ -1190,4 +1198,4 @@ If you want to override a text regardless of the language, use the special langu
1198
- 13 (v3.1.0)
1199
- backend events: dirEntry, request, alert
1200
- HFS.pathSeparator
1193
- - config.type=show_html
\ No newline at end of file
1201
+ - config.type=show_html