Skip to content

Commit 6ea7784

Browse files
committed
Add type definitions file
Refs #80
1 parent 3d26b2f commit 6ea7784

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Format whitespace in a SQL query to make it more readable",
55
"license": "MIT",
66
"main": "lib/sqlFormatter.js",
7+
"types": "src/sqlFormatter.d.ts",
78
"bin": {
89
"sql-formatter": "./bin/sqlfmt.js"
910
},

src/sqlFormatter.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
export interface FormatOptions {
2+
language?:
3+
| 'db2'
4+
| 'mariadb'
5+
| 'mysql'
6+
| 'n1ql'
7+
| 'plsql'
8+
| 'postgresql'
9+
| 'redshift'
10+
| 'spark'
11+
| 'sql'
12+
| 'tsql';
13+
params?: { [x: string]: string } | string[];
14+
indent?: string;
15+
uppercase?: boolean;
16+
linesBetweenQueries?: number;
17+
}
18+
19+
export function format(sql: string, options?: FormatOptions): string;

0 commit comments

Comments
 (0)