Typescript documentation, test or demo case

[ghost]

Since about a year, your project has Typescript support using a types.d.ts file.

Now, I was wondering if you could provide some basic info on how to set up a simple tree with a few nodes. I'm no expert with Typescript myself so I was looking for some documentation, but I found very little. Perhaps that @bendtherules can chip in as he was part of the original implementation team.

[joaonuno]

I know this is not what you're requesting, but check if this file helps in any way: https://github.com/joaonuno/tree-model-js/blob/master/types/tree-model-tests.ts

[bendtherules]

Hey @Kevin-at-Navigram, thanks for opening the issue.

Would you prefer existing (and some more ??) readme examples to be also available in typescript?
I think the tests file linked above does that to some extent.

Just as a quickstart, this is how you create simple tree (copied from tests file):

interface TestModel {
    name: string;
}

const tree = new TreeModel({});

const root = tree.parse<TestModel>({ name: 'a', children: [{ name: 'b' }, { name: 'c' }] });

It is also possible to type the input object (to parse) itself, instead of providing the generic type to .parse. That would be something like:

const data : TreeModel.Model<TestModel> = { name: 'a', children: [{ name: 'b' }, { name: 'c' }] };
const root = tree.parse(data);

[ghost]

He, I really appreciate this quick feedback. I did actually use the tests.ts file as a reference, but I thought it would be a nice addition to the website and documentation.

I've added it myself to the readme:
#65