saulteafarmer/Stirling-PDF
1
0
Fork 0
mirror of https://github.com/Stirling-Tools/Stirling-PDF.git synced 2025-09-18 01:19:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve type info on param hooks (#4438)

Browse Source 
# Description of Changes
Changes it so that callers of `useBaseTool` know what actual type the
parameters hook that they passed in returned, so they can actually make
use of any extra methods that that params hook has.
This commit is contained in:
James Brunton 2025-09-15 14:28:18 +01:00 committed by GitHub
parent cfdb6eaa1e
commit 7dad484aa7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
frontend/src/hooks/tools/shared/useBaseTool.ts
View File

@ -6,12 +6,12 @@ import { ToolOperationHook } from './useToolOperation';
import { BaseParametersHook } from './useBaseParameters'; import { BaseParametersHook } from './useBaseParameters';
import { StirlingFile } from '../../../types/fileContext'; import { StirlingFile } from '../../../types/fileContext';
interface BaseToolReturn<TParams> { interface BaseToolReturn<TParams, TParamsHook extends BaseParametersHook<TParams>> {
// File management // File management
selectedFiles: StirlingFile[]; selectedFiles: StirlingFile[];
// Tool-specific hooks // Tool-specific hooks
params: BaseParametersHook<TParams>; params: TParamsHook;
operation: ToolOperationHook<TParams>; operation: ToolOperationHook<TParams>;
// Endpoint validation // Endpoint validation
@ -33,13 +33,13 @@ interface BaseToolReturn<TParams> {
/** /**
* Base tool hook for tool components. Manages standard behaviour for tools. * Base tool hook for tool components. Manages standard behaviour for tools.
*/ */
export function useBaseTool<TParams>( export function useBaseTool<TParams, TParamsHook extends BaseParametersHook<TParams>>(
toolName: string, toolName: string,
useParams: () => BaseParametersHook<TParams>, useParams: () => TParamsHook,
useOperation: () => ToolOperationHook<TParams>, useOperation: () => ToolOperationHook<TParams>,
props: BaseToolProps, props: BaseToolProps,
options?: { minFiles?: number } options?: { minFiles?: number }
): BaseToolReturn<TParams> { ): BaseToolReturn<TParams, TParamsHook> {
const minFiles = options?.minFiles ?? 1; const minFiles = options?.minFiles ?? 1;
const { onPreviewFile, onComplete, onError } = props; const { onPreviewFile, onComplete, onError } = props;