Knex - Added more definitions

Added additional overloads for the Join interface and extra description for the callback function, including a description of the parameter passed to it, which is an instance of JoinClause. Therefore, also added the JoinClause interface description. Finally, added two new method overloads for Where.
This commit is contained in:
Travis Hill
2016-06-22 15:39:10 -04:00
committed by GitHub
parent 15b109941f
commit 696537ab6e
+14 -1
View File
@@ -164,17 +164,30 @@ declare module "knex" {
interface Join {
(raw: Raw): QueryBuilder;
(tableName: string, callback: Function): QueryBuilder;
(tableName: string, callback: (joinClause: JoinClause) => any): QueryBuilder;
(tableName: string, columns: {[key: string]: string|Raw}): QueryBuilder;
(tableName: string, raw: Raw): QueryBuilder;
(tableName: string, column1: string, column2: string): QueryBuilder;
(tableName: string, column1: string, raw: Raw): QueryBuilder;
(tableName: string, column1: string, operator: string, column2: string): QueryBuilder;
}
interface JoinClause {
on(raw: Raw): JoinClause;
on(callback: Function): JoinClause;
on(columns: {[key: string]: string|Raw}): JoinClause;
on(column1: string, column2: string): JoinClause;
on(column1: string, raw: Raw): JoinClause;
on(column1: string, operator: string, column2: string): JoinClause;
}
interface JoinRaw {
(tableName: string, binding?: Value): QueryBuilder;
}
interface Where extends WhereRaw, WhereWrapped, WhereNull {
(raw: Raw): QueryBuilder;
(callback: (queryBuilder: QueryBuilder) => any): QueryBuilder;
(object: Object): QueryBuilder;
(columnName: string, value: Value): QueryBuilder;
(columnName: string, operator: string, value: Value): QueryBuilder;