feature: typescript declaration file support?

[XGHeaven]

I use typescript with jayson, but there's no typescript declaration file.

Can you support it?

[tedeh]

Yes, let me have a look it should be possible since most of the method signatures are already quite well documented.

[XGHeaven]

Because I use typescript. If module without declaration file, tsc would show a error. 😂
And sometime I don't know what's type of variable. It's troublesome to look up document.

[dcunited001]

i'm also hoping to use the jayson library with typescript. in particular, inside an Angular 4 library. i've tried running the typescript branch, but it seems there's a few errors in the index.d.ts file. i'm just getting back into webdev, so i'm almost completely unfamiliar with typescript.

[tedeh]

@dcunited001 Yes you are right, I made a stab at a ts file a few weeks ago but am now swamped with work. Anyone that wants to help is welcome to fork and fix the definitions themselves. I estimate they should be 75 % done by now.

[dcunited001]

@tedeh for now, we're moving ahead only using the jayson client on the backend, but i would prefer to use it on the frontend. i'm just getting started with typescript myself, but if i get a chance, i'll try to take a shot at it.

[navono]

Is there any progress?

[tedeh]

I feel mostly finished with the Typescript implementation, anyone can add it to their project by checking out the typescript branch or running npm install 'github:tedeh/jayson#typescript'.

Would be good if anyone could write any feedback here ... The type definitions are probably not going to be merged into master unless I get some feedback from someone since I'm not a Typescript user myself yet.

Here are the type definitions: https://github.com/tedeh/jayson/blob/typescript/index.d.ts

[NicolasICible]

If the "noImplicitAny" config is set to "true" you get the following errors:

• 'execute', which lacks return-type annotation, implicitly has an 'any' return type.
• 'call', which lacks return-type annotation, implicitly has an 'any' return type.
• 'request', which lacks return-type annotation, implicitly has an 'any' return type.
• 'request', which lacks return-type annotation, implicitly has an 'any' return type.
• 'request', which lacks return-type annotation, implicitly has an 'any' return type.

Easy fix just add : any as a result for these 5 functions. ( or a real type if applicable )

Everything else seems to be good. I'll add feedback here as I encounter something.

[tedeh]

Thanks for the feedback, the problems with noImplicitAny should have been fixed and pushed to the typescript branch now.

Any more help appreciated...

[luozhihua]

In examples: server.js called the method: jayson.server(...), but in definitions file index.d.ts does not defined the method: jayson.server(), only has defined a class jayson.Server {};

[TS] property "server" in type "typeof import ("node_modules/jayson/index") "does not exist. Do you mean "Server"?

[tedeh]

Thanks @luozhihua unfortunately I couldn't manage to alias Server as server in the type definitions, so you probably need to use the uppercase version if you want the types to validate, unless you know how to alias definitions in typescript.

[tedeh]

The type definitions have been published in v2.1.0 for the general public to use. I expect there to be issues, but having them reported from now on as issues seems like a better way to get feedback.

[jpike88]

@tedeh Just using uppercase Server won't do the trick, it's a class, not a function.