Function Index /ˈfaɪ.dɛks/
A tool that scans TypeScript/TSX files and lists the locations of all function definitions.
Install globally:
npm i -g fidxOr use directly with npx:
npx fidx <path>You can also use yarn or pnpm as preferred.
fidx <path> [options]<path>
The directory or file you want to analyze for functions.
Specifies the output format. Available formats:
grouped (default)
Displays results grouped by file paths.
auth/login.ts
12 validateCredentials(credentials: { username: string; password: string; }): boolean
29 generateToken(userId: string, options: { expiresIn: number }): { token: string }
46 handleLoginRequest(request: { email: string; password: string; }): Promise<{ success: boolean }>
components/Button.tsx
8 Button(props: { label: string }): ReactElement
35 IconButton(props: { icon: string; label: string; }): ReactElement
utils/string.ts
5 capitalize(str: string): string
11 truncate(str: string, length: number): string
24 sanitizeInput(input: string): string
list
Displays results in a single-line format.
path/to/auth/login.ts
12 validateCredentials(credentials: { username: string; password: string; }): boolean
29 generateToken(userId: string, options: { expiresIn: number }): { token: string }
46 handleLoginRequest(request: { email: string; password: string; }): Promise<{ success: boolean }>
path/to/components/Button.tsx
8 Button(props: { label: string }): ReactElement
35 IconButton(props: { icon: string; label: string; }): ReactElement
path/to/utils/string.ts
5 capitalize(str: string): string
11 truncate(str: string, length: number): string
24 sanitizeInput(input: string): string
tsv
Displays results in Tab-Separated Values format, suitable for importing into spreadsheets or processing with other tools.
path line name parameters returnType
path/to/auth/login.ts 12 validateCredentials (credentials: { username: string; password: string; }) boolean
path/to/auth/login.ts 29 generateToken (userId: string, options: { expiresIn: number }) { token: string }
path/to/auth/login.ts 46 handleLoginRequest (request: { email: string; password: string; }) Promise<{ success: boolean }>
path/to/components/Button.tsx 8 Button (props: { label: string }) ReactElement
path/to/components/Button.tsx 35 IconButton (props: { icon: string; label: string; }) ReactElement
path/to/utils/string.ts 5 capitalize (str: string) string
path/to/utils/string.ts 11 truncate (str: string, length: number) string
path/to/utils/string.ts 24 sanitizeInput (input: string) string
json
Displays results in JSON format, suitable for processing with tools like jq. Each file is represented as an object containing its path and an array of functions.
[
{
"path": "auth/login.ts",
"functions": [
{
"line": 12,
"name": "validateCredentials",
"parameters": [
{
"name": "credentials",
"type": "{ username: string; password: string; }"
}
],
"returnType": "boolean"
},
{
"line": 29,
"name": "generateToken",
"parameters": [
{
"name": "userId",
"type": "string"
},
{
"name": "options",
"type": "{ expiresIn: number }"
}
],
"returnType": "{ token: string }"
},
{
"line": 46,
"name": "handleLoginRequest",
"parameters": [
{
"name": "request",
"type": "{ email: string; password: string; }"
}
],
"returnType": "Promise<{ success: boolean }>"
}
]
},
{
"path": "components/Button.tsx",
"functions": [
{
"line": 8,
"name": "Button",
"parameters": [
{
"name": "props",
"type": "{ label: string }"
}
],
"returnType": "ReactElement"
},
{
"line": 35,
"name": "IconButton",
"parameters": [
{
"name": "props",
"type": "{ icon: string; label: string; }"
}
],
"returnType": "ReactElement"
}
]
},
{
"path": "utils/string.ts",
"functions": [
{
"line": 5,
"name": "capitalize",
"parameters": [
{
"name": "str",
"type": "string"
}
],
"returnType": "string"
},
{
"line": 11,
"name": "truncate",
"parameters": [
{
"name": "str",
"type": "string"
},
{
"name": "length",
"type": "number"
}
],
"returnType": "string"
},
{
"line": 24,
"name": "sanitizeInput",
"parameters": [
{
"name": "input",
"type": "string"
}
],
"returnType": "string"
}
]
}
]Displays absolute file paths instead of relative paths from the target directory. When not specified, relative paths are displayed.
Displays the current version of fidx.
Display help for command.
- Node.js 22 or higher
MIT License - see the LICENSE file for details.
Copyright (c) 2025 Crescware Inc.