Documents / @faasjs/dev

@faasjs/dev / isTypegenInputFile

Function: isTypegenInputFile()

isTypegenInputFile(filePath): boolean

Determine whether a file change should trigger Faas type generation.

API and job files affect generated declarations directly. faas.yaml and faas.yml files can affect the resolved server root, so watchers should treat them as typegen inputs as well.

Parameters

filePath

string

Absolute or relative path reported by a file watcher.

Returns

boolean

true when the changed file can affect generated route declarations.

Example

import { isTypegenInputFile } from '@faasjs/dev'

isTypegenInputFile('src/orders/create.api.ts') // true
isTypegenInputFile('src/orders/process.job.ts') // true
isTypegenInputFile('src/orders/service.ts') // false