refactor: change exposed methods and accepted types

[jobo322]

BREAKING CHANGE:

• treeSimilarity now only accepts Tree objects
• createTree expects an object {x: [],y: []}

[targos]

The message for the changelog is wrong (breaking change is not the rename of the method). You should remove the ! from the title and add a BREAKING CHANGE: section with the actual breaking changes.

[jobo322]

@targos I have a question about the use of .d.ts to store the types. Is it needed to point to this file in the package.json or is it just enough with the importation in the jsdoc?

[targos]

You need to create a "types" key in the package.json that points to the file, and also include the file in the distribution (files array in package.json).

[jobo322]

The message for the changelog is wrong (breaking change is not the rename of the method). You should remove the ! from the title and add a BREAKING CHANGE: section with the actual breaking changes.

It is correct now?

[targos]

No, please have a look at the message I reworded: 3ec97d8

• It is not a fix
• We only talk about the breaking changes from the perspective of the end user

[targos]

I'm sorry, the format was actually wrong. Here is a new version that works: ec9318f

We cannot have an empty line for BREAKING CHANGE:
In general, I think the best way to solve this is to make more than one commit, so each commit has its description and BREAKING CHANGE: section.