@forge/kvs
1.2.7-next.0-experimental-2682d7a1.2.7-next.0-experimental-d997307
out/interfaces/types.d.tsout/interfaces/types.d.ts+32−1
Index: package/out/interfaces/types.d.ts
===================================================================
--- package/out/interfaces/types.d.ts
+++ package/out/interfaces/types.d.ts
@@ -1,20 +1,51 @@
export declare enum MetadataField {
CREATED_AT = "CREATED_AT",
- UPDATED_AT = "UPDATED_AT"
+ UPDATED_AT = "UPDATED_AT",
+ EXPIRE_TIME = "EXPIRE_TIME"
}
export interface GetOptions {
metadataFields?: MetadataField[];
}
+export interface QueryOptions {
+ metadataFields?: MetadataField[];
+}
+export declare type TtlUnit = 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS';
+export declare type Ttl = {
+ value: number;
+ unit: TtlUnit;
+};
+export interface SetOptions {
+ ttl?: Ttl;
+}
export interface GetResult<T> {
key: string;
value: T;
createdAt?: number;
updatedAt?: number;
+ expireTime?: string;
}
+export interface PolicySetOptions extends SetOptions {
+ keyPolicy: 'OVERRIDE' | 'FAIL_IF_EXISTS';
+}
+export interface OverrideAndReturnSetOptions extends SetOptions {
+ keyPolicy: 'OVERRIDE';
+ returnValue: 'PREVIOUS' | 'LATEST';
+ returnMetadataFields?: MetadataField[];
+}
+export declare function isOverrideAndReturnOptions(options?: ExtendedSetOptions): options is OverrideAndReturnSetOptions;
+export declare type ExtendedSetOptions = PolicySetOptions | OverrideAndReturnSetOptions;
+export interface SetResult<T> {
+ key: string;
+ value: T;
+ createdAt?: number;
+ updatedAt?: number;
+ expireTime?: string;
+}
export interface Result<T> {
key: string;
value: T;
+ expireTime?: string;
}
export interface ListResult<T> {
results: Result<T>[];
nextCursor?: string;