Support TypeScript

[isergey]

Thank you!

[sbarfurth]

What type of support would you want exactly? This will run perfectly fine inside TypeScript, at least in theory.

[Azael05x]

He probably meant to provide typings (@types/v8n)

[isergey]

Azael05x is write. Needs @types/v8n for compile time type checking.
https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

[sbarfurth]

I've submitted declarations for publishing.

I will update with the status here!

[imbrn]

Thank you so much @sebastianbarfurth. Very great job!

[lazarljubenovic]

If the types are official, there's no reason to use @types. Just inclide the .d.ts files in the repo itself. Then there will be no compatibility issues and we'll know it's always up to date. You only install one package - if you're using TS it just works and if you're using JS it's ignored.

Better yet, rewrite the whole thing in TypeScript ;)

[sbarfurth]

@lazarljubenovic According to the docs the @types approach is favored for non TypeScript applications, so I'm trying to go with standards here. I do see your point, I believe rewriting to TypeScript for the core is useful anyway. When that happens the types can move into the project.

For switching to TypeScript @imbrn would need to agree. It's a fairly simple switch, if we wanna do it I can probably do it today or tomorrow. It's especially nice because it introduces no changes to the resulting code, it's merely a help in development and makes everything work a bit smoother.

[sbarfurth]

I actually feel like converting to TypeScript sooner rather than later would be a good thing. Just as an aside.

[imbrn]

Go ahead and do that! This is the last thing we need to do before releasing version 1.1. 🎉🎉

[sbarfurth]

I'm nearly done, but I can't find a way to make type definitions for a Proxy based approach, since the names of functions aren't known.

[imbrn]

Maybe we should keep this feature out of the next version, and then we can think about it better.

[sbarfurth]

@imbrn Yeah, I wanna do docs first and I will go ahead with this for 1.2.0.

[imbrn]

@sebastianbarfurth This library has a lot of dynamic behavior, and I think this is great. So, we really need to talk about how we can make this work for TypeScript. Maybe it needs some code refactoring to make it a little less dynamic, but this is something we quite need to discuss before though.

[sbarfurth]

I agree. I have done a lot of work on this with TypeScript and it adds a lot of consistency and insight into code quality, but the dynamic parts are hard to represent. Will revisit for a later version.

[imbrn]

Ok

[sbarfurth]

Removing this from 1.2.0 since this requires some additional refactoring before-hand.

[Raiondesu]

Awesome library!
In order to properly type it, it needs to create a separate context for custom rules (upon calling the extend function), instead of a global variable, as it is now.

Everything else is perfectly typable.

[BottlecapDave]

Is there any update on this? I'd love to use it, but lack of typings is a bit of a deal breaker for work related projects

[trevorr]

@BottlecapDave I felt the same way regarding this being the best library I could find for fluent validation, but I didn't see a way to easily address this Typescript issue and (perhaps more importantly) the lack of human-readable error messages. Therefore, I created a new one: https://github.com/trevorr/tsfv. Maybe it will meet your needs.

[iampervaze]

Awesome lib, but not been able to use it with Angular 8. Looking forward to the typescript version. Thank you!

[lazarljubenovic]

You can use it with any framework, you just won't get types.

[iampervaze]

Using v8n with Angular
https://stackblitz.com/edit/angular-ymlf4z

[GustavTaxen]

Has there been any progress on this lately?

If Typescript support isn't coming soon for v8n, I'm afraid that we'll have no choice but to switch to a different validation toolkit.

[sbarfurth]

@GustavTaxen and the rest: Just created #178.

[joeldesante]

Hi, just so you all are aware. I've forked the repository and published a version of it (with very basic typings) to npm under the name v8n.ts
https://www.npmjs.com/package/v8n.ts

My intentions are for this to be a temporary package that should be deprecated once this issue is resolved.