Skip to content

feat(types): add fromParameters method #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 2, 2025
+34 −3
Merged

feat(types): add fromParameters method #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73338fc
feat(types): add fromParameters method
rozzilla Dec 2, 2025
719df55
lint
rozzilla Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import {
FastifyPluginCallback,
FastifyReply,
FastifyRequest,
preHandlerHookHandler,
preValidationHookHandler,
Expand All @@ -17,6 +18,28 @@ import {
import { ClientOptions, ServerOptions, WebSocket } from 'ws'
import { Logger } from 'pino'

type FastifyReplyWithFromParameters = FastifyReply & {
fromParameters: (
url: string,
params?: unknown,
prefix?: string
) => { url: string; options: unknown };
}

type ProxyPreHandlerHookHandler = (
this: preHandlerHookHandler,
request: Parameters<preHandlerHookHandler>[0],
reply: FastifyReplyWithFromParameters,
done: Parameters<preHandlerHookHandler>[2]
) => void

type ProxyPreValidationHookHandler = (
this: preValidationHookHandler,
request: Parameters<preValidationHookHandler>[0],
reply: FastifyReplyWithFromParameters,
done: Parameters<preValidationHookHandler>[2]
) => void

interface WebSocketHooks {
onConnect?: (context: { log: Logger }, source: WebSocket, target: WebSocket) => void;
onDisconnect?: (context: { log: Logger }, source: WebSocket) => void;
Expand All @@ -42,6 +65,7 @@ interface FastifyHttpProxyWebsocketOptionsEnabled {
wsHooks?: WebSocketHooks;
wsReconnect?: WebSocketReconnectOptions;
}

interface FastifyHttpProxyWebsocketOptionsDisabled {
websocket?: false | never;
wsUpstream?: never;
Expand All @@ -64,9 +88,9 @@ declare namespace fastifyHttpProxy {
prefix?: string;
rewritePrefix?: string;
proxyPayloads?: boolean;
preHandler?: preHandlerHookHandler;
beforeHandler?: preHandlerHookHandler;
preValidation?: preValidationHookHandler;
preHandler?: ProxyPreHandlerHookHandler;
beforeHandler?: ProxyPreHandlerHookHandler;
preValidation?: ProxyPreValidationHookHandler;
config?: Object;
replyOptions?: FastifyReplyFromHooks;
wsClientOptions?: ClientOptions & { queryString?: { [key: string]: unknown } | QueryStringFunction; };
Expand Down
7 changes: 7 additions & 0 deletions types/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,21 @@ app.register(fastifyHttpProxy, {
preHandler: (request, reply) => {
expectType<RawRequestDefaultExpression>(request.raw)
expectType<RawReplyDefaultExpression>(reply.raw)
expectType<(url: string, params?: unknown, prefix?: string) => { url: string; options: unknown }>(reply.fromParameters)
},
beforeHandler: (request, reply) => {
expectType<RawRequestDefaultExpression>(request.raw)
expectType<RawReplyDefaultExpression>(reply.raw)
expectType<(url: string, params?: unknown, prefix?: string) => { url: string; options: unknown }>(reply.fromParameters)
},
preValidation: (request, reply) => {
expectType<RawRequestDefaultExpression>(request.raw)
expectType<RawReplyDefaultExpression>(reply.raw)
expectType<(url: string, params?: unknown, prefix?: string) => { url: string; options: unknown }>(reply.fromParameters)

const result = reply.fromParameters('/')
expectType<unknown>(result.options)
expectType<string>(result.url)
},
base: 'whatever',
cacheURLs: 10,
Expand Down
Loading