add TypeScript definitions #176

vaishnavachath · 2018-06-26T19:39:20Z

originally written by @troywweber7
also submitted to @types : DefinitelyTyped/DefinitelyTyped#26814

@troywweber7

originally written by @troywweber7 also submitted to @types : DefinitelyTyped/DefinitelyTyped#26814

jadonk

It seems like each function returns an 'any' type. When called locally (non-RPC), each function has a possible return value. For RPC-called functions, I think it should always be 'void' or whatever the Typescript equivalent is.

jadonk · 2018-07-09T18:39:01Z

src/index.d.ts

+
+export function getPlatform(callback?: (error: ErrorType, platform: any) => void): any;
+
+export function getEeproms(callback?: (error: ErrorType, eeproms: any) => void): any;


This should probably be deprecated from the public interface.

jadonk · 2018-07-09T18:39:28Z

src/index.d.ts

+// FUNCTIONS - TODO obliterate all "any" types where possible! --- TWW
+// https://github.com/jadonk/bonescript#system
+
+export function getPlatform(callback?: (error: ErrorType, platform: any) => void): any;


Is there a reason that 'platform' is of type 'any' and not a particular structure?

jadonk · 2018-07-09T18:39:54Z

src/index.d.ts

+
+export function echo(data: any, callback?: (error: ErrorType, data: any) => void): any;
+
+export function readTextFile(filename: string, callback?: (error: ErrorType, data: any) => void): any;


Shouldn't 'data' be of a string type?

jadonk · 2018-07-09T18:40:24Z

src/index.d.ts

+
+export function getEeproms(callback?: (error: ErrorType, eeproms: any) => void): any;
+
+export function echo(data: any, callback?: (error: ErrorType, data: any) => void): any;


Shouldn't 'data' on both the call and callback be of a string type?

jadonk · 2018-07-09T18:42:10Z

src/index.d.ts

+
+export function readTextFile(filename: string, callback?: (error: ErrorType, data: any) => void): any;
+
+export function writeTextFile(filename: string, data: any, callback?: (error: ErrorType, data: any) => void): void;


Why does the callback have a 'data' value? I think this should only be returning a status of error or not error.

jadonk · 2018-07-09T18:45:14Z

src/index.d.ts

+
+export function writeCModule(filename: string, data: any, callback?: (error: ErrorType, data: any) => void): void;
+
+export function setDate(date: any, callback?: (error: ErrorType, data: any) => void): void;


I don't think this should be returning any 'data', just an error status. The 'date' should be a string type with specific formatting.

jadonk · 2018-07-09T18:46:47Z

src/index.d.ts

+
+export function pinMode(
+    pin: string,
+    direction: any,


jadonk · 2018-07-09T18:46:58Z

src/index.d.ts

+    pin: string,
+    direction: any,
+    mux?: any,
+    pullup?: any,


jadonk · 2018-07-09T18:47:39Z

src/index.d.ts

+    direction: any,
+    mux?: any,
+    pullup?: any,
+    slew?: any,


string. Several of these should probably should be a string enums if typescript supports that.

jadonk · 2018-07-09T18:48:29Z

src/index.d.ts

+
+export function getPinMode(pin: string, callback?: (err: ErrorType, mode: PinModeObj) => void): any;
+
+export function shiftOut(dataPin: any, clockPin: any, bitOrder: any, val: any, callback?: ErrorCb): void;


dataPin and clockPin should be strings.
val should be a number.
I forget what bitOrder should be.

jadonk · 2018-07-09T18:50:08Z

src/index.d.ts

+    [i: string]: i2cInfo;
+}
+
+export interface PinInfo {


I'm not sure if we want to include full details here. They are handy, but I'm not 100% committed to keeping them all here. What ones do you think people actually use?

jadonk · 2018-07-09T18:50:35Z

src/index.d.ts

+    universalName?: string;
+}
+
+export interface PwmInfo {


Really don't think this should be a public interface. I should probably hide it.

jadonk · 2018-07-09T18:50:54Z

src/index.d.ts

+    sysfs: number;
+}
+
+export interface UartInfo {


Not really a public interface. Referenced only by string.

jadonk · 2018-07-09T18:51:07Z

src/index.d.ts

+    tx?: string;
+}
+
+export interface i2cInfo {


Not really a public interface. Referenced only by string.

jadonk · 2018-07-09T18:51:35Z

src/index.d.ts

+    sda?: string;
+}
+
+// TYPES - adjusted based on observation / testing


Did these get used up above?

Looks like this is a reasonable way to do string enums!

Yes, most of them were used above, i have removed some of the exports which were not necessary, had to export them previously due to this rule: https://github.com/Microsoft/dtslint/blob/master/docs/strict-export-declare-modifiers.md

change function return value type to any removed getEeproms definition defined platform object structure removed unnecesary exports

vaishnavachath · 2018-07-10T18:43:20Z

Hi, i have tried to make the suggested changes, can you have a look at it

vaishnavachath · 2018-08-05T19:33:44Z

beagleboard#46

add TypeScript definitions

4f5f33c

originally written by @troywweber7 also submitted to @types : DefinitelyTyped/DefinitelyTyped#26814