Skip to content

Commit d5360ba

Browse files
committed
Update README
1 parent 57c6e5d commit d5360ba

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,20 @@ npm install sql-autocomplete
1616
```typescript
1717
import { SQLAutocomplete, SQLDialect } from 'sql-autocomplete';
1818

19-
const sqlAutocomplete = new SQLAutocomplete(SQLDialect.MYSQL);
19+
const sqlAutocomplete = new SQLAutocomplete(SQLDialect.MYSQL,
20+
['myDatabaseTableName'], // Optional
21+
['aColumnName']); // Optional
2022
const sql1 = 'SELECT * FR';
2123
const options1 = sqlAutocomplete.autocomplete(sql1);
2224
console.dir(options1);
2325

2426
// [ AutocompleteOption { value: 'FROM', optionType: 'KEYWORD' } ]
2527

26-
const sql2 = 'SELECT * FROM myDatabaseTableNam';
28+
const sql2 = 'SELECT * FROM myDatab';
2729
const options2 = sqlAutocomplete.autocomplete(sql2);
2830
console.dir(options2);
2931

30-
// [ AutocompleteOption { value: null, optionType: 'TABLE' } ]
32+
// [ AutocompleteOption { value: 'myDatabaseTableName', optionType: 'TABLE' } ]
3133
```
3234

3335
## Created By

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sql-autocomplete",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"description": "Autocomplete recommendations for SQL statements. Supports PostgreSQL, MySQL, SQL Server and Oracle (PL/SQL) dialects.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

src/SQLAutocomplete.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,13 @@ export class SQLAutocomplete {
116116
return autocompleteOptions;
117117
}
118118

119-
setTableNames(tableNames: string[]) {
119+
setTableNames(tableNames: string[]): void {
120120
if (tableNames !== null && tableNames !== undefined) {
121121
this.tableNames = [...tableNames];
122122
}
123123
}
124124

125-
setColumnNames(columnNames: string[]) {
125+
setColumnNames(columnNames: string[]): void {
126126
if (columnNames !== null && columnNames !== undefined) {
127127
this.columnNames = [...columnNames];
128128
}

0 commit comments

Comments
 (0)