Typescript: ListOption for format: 'json' is invalid

[lordnox]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure it has not already been reported

Fastify version

3.19.1

Plugin version

4.2.2

Node.js version

14.17.1

Operating system

macOS

Operating system version (i.e. 20.04, 11.3, 10)

11.4 (Apple M1 Chip)

Description

The type for list (boolean | ListOptions) is not correct for the json case:

interface ListOptions {
  format: 'json' | 'html';
  names: string[];
  render: ListRender;
}

It should not include the render property as it is not used in json but required here

Steps to Reproduce

  const staticOptions: FastifyStaticOptions = {
    root: path.resolve(options.imagePath),
    prefix: options.path,
    dotfiles: 'ignore',
    prefixAvoidTrailingSlash: true,
    list: {
      format: 'json',
      names: ['index', 'index.json', '/', ''],
     // missing render 
    },
  }

Expected Behavior

type ListOptions {
  format: 'json';
  names: string[];
} | {
  format: 'html';
  names: string[];
  render: ListRender;
}

[Eomm]

Would you like to send a Pull Request to address this issue? Remember to add unit tests.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[is2ei]

This issue is still a problem.
e.g. https://stackblitz.com/edit/node-yonvhw?file=index.ts