Update index.d.ts

[BlackGlory]

Update index.d.ts to v3.0

Checklist

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

[StarpTech]

lgtm, thanks.

[mcollina]

Would you mind to add a test for this type?

[BlackGlory]

@mcollina I did not find a file for testing TypeScript types in the repo, test/index.test-d.ts doesn't look like a unit test.

[BlackGlory]

test/index.test-d.ts is the v2.0 test file, so I updated it to v3.0.
But IMHO, since the file is not updated with the new version, obviously these tests are not helpful.

[BlackGlory]

Considering the properties of the field type, it seems necessary to split Multipart into two interfaces.
But it will break the examples in the README, because we need to distinguish between different types. I'm not sure if these definitions should be added.

type Multipart = MultipartField | MultipartFile

interface MultipartField {
  fieldname: string
  value: string
  fieldnameTruncated: boolean
  valueTruncated: boolean
  fields: MultipartFields
}

interface MultipartFile  {
  toBuffer: () => Promise<Buffer>,
  file: NodeJS.ReadableStream,
  filepath: string,
  fieldname: string,
  filename: string,
  encoding: string,
  mimetype: string,
  fields: MultipartFields
}

[hixus]

I might also export all interfaces (for example Multipart) so one can use them for own function declarations that use the result

[mcollina]

I don't understand the question. Is this ready to land?

[mcollina]

lgtm

[hixus]

I don't understand the question. Is this ready to land?

Could be different pr, but for example I might wan't to define separate handler which would take just the Multipart as an argument. Currently not possible without defining it again.

const handleFile = async (part: Multipart) => {
  pump(part.file, fs.createWriteStream(part.filename))
}

server.post("/upload", async (req, reply) => {
  const parts = req.parts()
  for await (const part of parts) {
    if (part.file) {
      await handleFile(part)
    } else {
      console.log(part)
    }
  }
  reply.send()
});

With type exports one could just do import {Multipart} from 'fastify-multipart'

[BlackGlory]

This PR is ready to merge.

It may take someone more familiar with this project to decide which TypeScript interfaces should be exported, not me.

[fox1t]

Nice work! Thanks for you contribution.
There is one missing export to add, then this PR can be merged.

[fox1t]

LGTM

[mcollina]

lgtm