Upgrading from v1 to v2 changes File properties, even though documentation says v2 is API backwards compatible with v1

[gboer]

Support plan

• which support plan is this issue covered by?: Community
• is this issue currently blocking your project?: No
• is this issue affecting a production system?: Yes

Context

• node version: v14.18.1
• module (formidable) version: 2.0.1
• environment (e.g. node, browser, native, OS): NodeJS
• used with (i.e. popular names of modules): Typescript
• any other relevant information: N/A

What are you trying to achieve or the steps to reproduce?

In V1, the API for the 'File' object looks like this (roughly):

interface File {
  size: number;
  path: string;
  name: string;
  type: string;
  hash: null | string;
  lastModifiedDate: Date;
  domain: null | string;
}

What was the result you got?

In V2, the API for the 'File' object looks like this (roughly):

interface File {
  size: number;
  filepath: string; // previously 'path'
  originalFilename: string; // previously 'name'
  newFilename: string; // new
  mimetype: string; // previously 'type'
  hash: null | string;
  lastModifiedDate: Date;
  domain: null | string;
}

What result did you expect?

I read the version notes here and it says that the V2 API is backwards compatible with V1, but that is apparently not the case. It would be helpful if the documentation could be updated to reflect the changes, so that people can more easily migrate their code.

[GrosSacASac]

Thanks I updated the notes, please have a look at the changelog to upgrade from v1 to v2

[gboer]

thanks :)

[tunnckoCore]

Well, because they should have remained. Lets just add them? If only that's the problem for compat.