@aicore/cocodb-ws-client
Advanced tools
Comparing version 1.0.11 to 1.0.12
{ | ||
"name": "@aicore/cocodb-ws-client", | ||
"version": "1.0.11", | ||
"version": "1.0.12", | ||
"description": "Websocket client for cocoDb", | ||
@@ -5,0 +5,0 @@ "main": "src/index.js", |
@@ -166,5 +166,10 @@ import {sendMessage} from "./client.js"; | ||
* @param{Object} queryObject - This is the object that you want to query the table with. | ||
* @param {Object} options Optional parameter to add pagination. | ||
* @param {number} options.pageOffset specify which row to start retrieving documents from. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @param {number} options.pageLimit specify number of documents to retrieve. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @returns {Promise} | ||
*/ | ||
export function getFromIndex(tableName, queryObject) { | ||
export function getFromIndex(tableName, queryObject, options= {}) { | ||
if (isStringEmpty(tableName)) { | ||
@@ -181,3 +186,4 @@ throw new Error('Please provide valid table name'); | ||
tableName: tableName, | ||
queryObject: queryObject | ||
queryObject: queryObject, | ||
options | ||
} | ||
@@ -191,5 +197,10 @@ }); | ||
* @param{Object} queryObject - This is the object that you want to query the table with. | ||
* @param {Object} options Optional parameter to add pagination. | ||
* @param {number} options.pageOffset specify which row to start retrieving documents from. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @param {number} options.pageLimit specify number of documents to retrieve. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @returns {Promise} | ||
*/ | ||
export function getFromNonIndex(tableName, queryObject = {}) { | ||
export function getFromNonIndex(tableName, queryObject = {}, options= {}) { | ||
if (isStringEmpty(tableName)) { | ||
@@ -203,3 +214,4 @@ throw new Error('Please provide valid table name'); | ||
tableName: tableName, | ||
queryObject: queryObject | ||
queryObject: queryObject, | ||
options | ||
} | ||
@@ -314,5 +326,10 @@ }); | ||
* @param {Array<string>}[useIndexForFields=null] - This is an array of fields that you want to use the index for. | ||
* @param {Object} options Optional parameter to add pagination. | ||
* @param {number} options.pageOffset specify which row to start retrieving documents from. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @param {number} options.pageLimit specify number of documents to retrieve. Eg: to get 10 documents from | ||
* the 100'th document, you should specify `pageOffset = 100` and `pageLimit = 10` | ||
* @returns {Promise}A promise | ||
*/ | ||
export function query(tableName, queryString, useIndexForFields = null) { | ||
export function query(tableName, queryString, useIndexForFields = null, options= {}) { | ||
if (isStringEmpty(tableName)) { | ||
@@ -330,3 +347,4 @@ throw new Error('Please provide valid table name'); | ||
tableName: tableName, | ||
queryString: queryString | ||
queryString: queryString, | ||
options | ||
} | ||
@@ -333,0 +351,0 @@ }); |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
73303
721