-
Notifications
You must be signed in to change notification settings - Fork 656
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Better structure for typescript definition #836
Comments
The proposed file works for flow-typed |
Hello, |
Hi @kaktus40 thank you so much for fast interaction :) I better get into the typescript thing too so I can test too and help develop the definition :) |
From what I see:
Following these recommendations, is it not possible to only use this following definitions: declare namespace alaSQLSpace {
interface AlaSQLCallback {
(data?: any, err?: Error): void;
}
interface AlaSQLOptions {
errorlog: boolean;
valueof: boolean;
dropifnotexists: boolean; // drop database in any case
datetimeformat: string; // how to handle DATE and DATETIME types
casesensitive: boolean; // table and column names are case sensitive and converted to lower-case
logtarget: string; // target for log. Values: 'console', 'output', 'id' of html tag
logprompt: boolean; // print SQL at log
modifier: any; // values: RECORDSET, VALUE, ROW, COLUMN, MATRIX, TEXTSTRING, INDEX
columnlookup: number; // how many rows to lookup to define columns
autovertex: boolean; // create vertex if not found
usedbo: boolean; // use dbo as current database (for partial T-SQL comaptibility)
autocommit: boolean; // the AUTOCOMMIT ON | OFF
cache: boolean; // use cache
nocount: boolean; // for SET NOCOUNT OFF
nan: boolean; // check for NaN and convert it to undefined
angularjs: boolean;
tsql: boolean;
mysql: boolean;
postgres: boolean;
oracle: boolean;
sqlite: boolean;
orientdb: boolean;
}
// compiled Statement
interface AlaSQLStatement {
(params?: any, cb?: AlaSQLCallback, scope?: any): any;
}
// abstract Syntax Tree
interface AlaSQLAST {
compile(databaseid: string): AlaSQLStatement;
}
// https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/es6-promise/es6-promise.d.ts
interface Thenable<T> {
then<U>(onFulfilled?: (value: T) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
then<U>(onFulfilled?: (value: T) => U | Thenable<U>, onRejected?: (error: any) => void): Thenable<U>;
catch<U>(onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
}
// see https://github.com/agershun/alasql/wiki/User%20Defined%20Functions
interface userDefinedFunction {
(x: any): any;
}
interface userDefinedFunctionLookUp {
[x: string]: userDefinedFunction;
}
// see https://github.com/agershun/alasql/wiki/User%20Defined%20Functions
interface userAggregator {
(value: any, accumulator: any, stage: number): any;
}
interface userAggregatorLookUp {
[x: string]: userAggregator;
}
interface AlaSQL {
options: AlaSQLOptions;
error: Error;
(sql: any, params?: any, cb?: AlaSQLCallback, scope?: any): any;
parse(sql): AlaSQLAST;
promise(sql: any, params?: any): Thenable<any>;
fn: userDefinedFunctionLookUp;
aggr: userAggregatorLookUp;
autoval(tablename: string, colname: string, getNext?:boolean): number;
}
}
declare var alasql: alaSQLSpace.AlaSQL; This example works in typescript. Is it ok in flow? |
Hi guys, creating a plugin in TS I can't use alasql.yy as this example say. Any help? Thank you!! |
Please make a new issue with the question (just post a link) The alasql.yy have not been defined in TS. please try to add |
It works :) Thanks! |
hello, you should check this. I think this could be helpful... |
awesome - i got a .d.ts file with 13031 lines... might need to remove some elements... |
According to #738 (comment) problems with compiling with the existing typescript definition was solved by removing namespace and avoiding deklare a module to export (but just do the export)
This sounds like same changes made to the definition made for the flow-typed: https://github.com/AlaSQL/flow-typed/blob/master/definitions/npm/alasql_v0.3.x/flow_v0.25.x-/alasql_v0.3.x.js
This would be great, as we would only have one version of the definition and could reuse it for both projects.
Basically we need people to test if the following code works as definition files for both typescript and flow-typed
The text was updated successfully, but these errors were encountered: