reduct-js
Version:
ReductStore Client SDK for Javascript/NodeJS/Typescript
41 lines (40 loc) • 1.28 kB
TypeScript
import { QueryOptions } from "./QueryEntry";
/**
* Represents information about a bucket
*/
export declare class QueryLinkOptions {
/** bucket name */
bucket: string;
/** entry name (or bucket name for multi-entry queries) */
entry: string;
/** selected record entry name */
recordEntry?: string;
/** selected record timestamp */
recordTimestamp?: bigint;
/**
* @deprecated Legacy `index` is only honored by ReductStore versions before v1.19.
* Use `recordEntry` and `recordTimestamp` instead. Will be removed in SDK v1.21.
*/
index?: number;
/** query */
query: QueryOptions;
/** expiration time as UNIX timestamp in seconds */
expireAt: Date;
/** base url for link generation */
baseUrl?: string;
static serialize(options: QueryLinkOptions, start?: bigint, stop?: bigint, entries?: string[]): OriginalCreateQueryLink;
}
export type OriginalCreateQueryLink = {
bucket: string;
entry: string;
record_entry?: string;
record_timestamp?: bigint | number;
/**
* @deprecated Legacy `index` is only honored by ReductStore versions before v1.19.
* Will be removed in SDK v1.21.
*/
index?: number;
query: any;
expire_at: number;
base_url?: string;
};