Typescript types file for PB functions?

[Texas]

Any chance anyone uses typescript to develop plugs and has a types file for all the proboards functions?

[Ulises]

Perhaps you are looking for this? www.proboards.com/developer/js/

[Texas]

Ulises, sorry, should have been more clear. I meant a Typescript declaration file: basarat.gitbooks.io/typescript/content/docs/types/ambient/d.ts.html

Typescript is basically a developing environment for javascrtipt. It forces you do only use defined variables and such. Which is great if your not depending on other resources...like using any built in proboards functions. I'm just wondering if anyone uses Typescript and already has a typescript declaration file.

[Ulises]

Oh, I gotchu, my only experience with typescript is in linux (which is completely different still from this )

Reading your link, I see where it would come in handy, neat -- didn't know that existed.

[Former Member]

It's straightforward to do, you just need to create an interface that describes each(function/object or property)

Getting the function signatures for proboards would be quite time consuming. You would need to find each function, try to figure out it's argument types(using the debugger) and return type.

You would also need to include jQuery type definition for some of proboards functions, for example: Ajax

The ajax method returns a Jquery Promise(a much earlier implementation of a promise) so you can't just typecast it to a regular Promise.

ajax( options : Object ) : Promise - this would give incorrect type


To start,
Add a definitions/ inside your project folder

create a proboards.d.ts file inside the definitions folder and include the following

export interface ProboardsInterface{
  // Properties
  active_ajax_calls : number;

  // Functions
  add_commified_numbers(numbers: Array<number>) : String;
  ajax( options : Object ) : Object
 
  // Objects
  analytics : {

     google: { getClientId() : String, send(options : Array<Object> ) : boolean }

  };

  // @TODO: implement the rest
}
In your application file example.ts

import { ProboardsInterface } from './definitions/proboards.d'

declare var proboards : ProboardsInterface

((proboards)=>{

 // @TODO

})(proboards)
Some older versions of typescript you would need to include a reference at the top of the file also

///<reference path="./definitions/proboards.d.ts" />


I'm not sure I would use typescript with proboards though. A module loader will add a bit of code overhead to your plugin

[Texas]

@synthtec,

Thanks for the help and advice. The reason I'd like to use it is that it forces me to use better programming techniques and helps avoid weird typecasting errors that I am prone to make. Anyway, I'll probably never get around to putting that much work into getting all of it set up in the first place so, probably just wishful thinking. A good linter is really all I need anyway.

[Former Member]

You can get away without any module loader overhead if you don't use any import,export,require statements and just add the proboardsInterface inside your example.ts file.

You would need to add it to all your files, so that could become annoying quickly.
The above method will work If you use a good IDE(visual studio code|Atom) and it will give you proper intellisense.

I think "Visual Studio Code" also has a default ES Linter.