Skip to content
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

fix: correct connector types #549

Merged
merged 1 commit into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/core/src/connectors/rest.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ export function restConnector(uri = 'http://localhost:3000/') {
* Query the DuckDB server.
* @param {object} query
* @param {'exec' | 'arrow' | 'json' | 'create-bundle' | 'load-bundle'} [query.type] The query type.
* @param {string} query.sql A SQL query string.
* @param {string} [query.sql] A SQL query string.
* @param {string[]} [query.queries] The queries used to create a bundle.
* @param {string} [query.name] The name of a bundle to create or load.
* @returns the query result
*/
async query(query) {
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/connectors/socket.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,9 @@ export function socketConnector(uri = 'ws://localhost:3000/') {
* Query the DuckDB server.
* @param {object} query
* @param {'exec' | 'arrow' | 'json' | 'create-bundle' | 'load-bundle'} [query.type] The query type.
* @param {string} query.sql A SQL query string.
* @param {string} [query.sql] A SQL query string.
* @param {string[]} [query.queries] The queries used to create a bundle.
* @param {string} [query.name] The name of a bundle to create or load.
* @returns the query result
*/
query(query) {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/connectors/wasm.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export function wasmConnector(options = {}) {
/**
* Query the DuckDB-WASM instance.
* @param {object} query
* @param {'exec' | 'arrow' | 'json' | 'create-bundle' | 'load-bundle'} [query.type] The query type.
* @param {'exec' | 'arrow' | 'json'} [query.type] The query type.
* @param {string} query.sql A SQL query string.
* @returns the query result
*/
Expand Down
Loading