@valon-technologies/gestalt
    Preparing search index...

    IndexedDB models the shared Gestalt IndexedDB-provider protocol.

    Index

    Constructors

    • Parameters

      • transport: Transport
      • Optionaloptions: { timeoutMs?: number }

      Returns IndexedDB

    Methods

    • Parameters

      • Optionaloptions: { name?: string; timeoutMs?: number }

      Returns IndexedDB

    • Parameters

      • name: string
      • Optionalschema: {
            indexes?: { name?: string; keyPath?: string[]; unique?: boolean }[];
            columns?: {
                name?: string;
                type?: number;
                primaryKey?: boolean;
                notNull?: boolean;
                unique?: boolean;
            }[];
        }

      Returns Promise<void>

    • Lifecycle

      Parameters

      • request: {
            name?: string;
            schema?: {
                indexes?: { name?: string; keyPath?: string[]; unique?: boolean }[];
                columns?: {
                    name?: string;
                    type?: number;
                    primaryKey?: boolean;
                    notNull?: boolean;
                    unique?: boolean;
                }[];
            };
        }

      Returns Promise<void>

    • Parameters

      • name: string

      Returns Promise<void>

    • Parameters

      • request: { name?: string }

      Returns Promise<void>

    • Parameters

      • store: string
      • name: string
      • keyPath: string[]
      • unique: boolean

      Returns Promise<void>

    • Parameters

      • request: { store?: string; name?: string; keyPath?: string[]; unique?: boolean }

      Returns Promise<void>

    • Parameters

      • store: string
      • name: string

      Returns Promise<void>

    • Parameters

      • request: { store?: string; name?: string }

      Returns Promise<void>

    • Primary key CRUD

      Parameters

      • request: { store?: string; id?: string }

      Returns Promise<RecordResponse>

    • Parameters

      • store: string
      • id: string

      Returns Promise<KeyResponse>

    • Parameters

      • request: { store?: string; id?: string }

      Returns Promise<KeyResponse>

    • Parameters

      • store: string
      • Optionalrecord: {
            fields?: {
                [key: string]: {
                    kind?:
                        | { case: undefined; value?: undefined }
                        | { case: "nullValue"; value: null }
                        | { case: "stringValue"; value: string }
                        | { case: "intValue"; value: bigint }
                        | { case: "floatValue"; value: number }
                        | { case: "boolValue"; value: boolean }
                        | { case: "timeValue"; value: Date }
                        | { case: "bytesValue"; value: Uint8Array<ArrayBufferLike> }
                        | {
                            case: "jsonValue";
                            value: string | number | boolean | object | unknown[] | null;
                        };
                };
            };
        }

      Returns Promise<void>

    • Parameters

      • request: {
            store?: string;
            record?: {
                fields?: {
                    [key: string]: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | { case: "nullValue"; value: null }
                            | { case: "stringValue"; value: string }
                            | { case: "intValue"; value: bigint }
                            | { case: "floatValue"; value: number }
                            | { case: "boolValue"; value: boolean }
                            | { case: "timeValue"; value: Date }
                            | { case: "bytesValue"; value: Uint8Array<ArrayBufferLike> }
                            | {
                                case: "jsonValue";
                                value: string | number | boolean | object | unknown[] | null;
                            };
                    };
                };
            };
        }

      Returns Promise<void>

    • Parameters

      • store: string
      • Optionalrecord: {
            fields?: {
                [key: string]: {
                    kind?:
                        | { case: undefined; value?: undefined }
                        | { case: "nullValue"; value: null }
                        | { case: "stringValue"; value: string }
                        | { case: "intValue"; value: bigint }
                        | { case: "floatValue"; value: number }
                        | { case: "boolValue"; value: boolean }
                        | { case: "timeValue"; value: Date }
                        | { case: "bytesValue"; value: Uint8Array<ArrayBufferLike> }
                        | {
                            case: "jsonValue";
                            value: string | number | boolean | object | unknown[] | null;
                        };
                };
            };
        }

      Returns Promise<void>

    • Parameters

      • request: {
            store?: string;
            record?: {
                fields?: {
                    [key: string]: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | { case: "nullValue"; value: null }
                            | { case: "stringValue"; value: string }
                            | { case: "intValue"; value: bigint }
                            | { case: "floatValue"; value: number }
                            | { case: "boolValue"; value: boolean }
                            | { case: "timeValue"; value: Date }
                            | { case: "bytesValue"; value: Uint8Array<ArrayBufferLike> }
                            | {
                                case: "jsonValue";
                                value: string | number | boolean | object | unknown[] | null;
                            };
                    };
                };
            };
        }

      Returns Promise<void>

    • Parameters

      • store: string
      • id: string

      Returns Promise<void>

    • Parameters

      • request: { store?: string; id?: string }

      Returns Promise<void>

    • Parameters

      • store: string

      Returns Promise<void>

    • Bulk operations (with optional query)

      Parameters

      • request: { store?: string }

      Returns Promise<void>

    • Parameters

      • store: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }
      • Optionaloptions: { count?: number }

      Returns Promise<RecordsResponse>

    • Parameters

      • request: {
            store?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<RecordsResponse>

    • Parameters

      • store: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }
      • Optionaloptions: { count?: number }

      Returns Promise<KeysResponse>

    • Parameters

      • request: {
            store?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<KeysResponse>

    • Parameters

      • store: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<bigint>

    • Parameters

      • request: {
            store?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<CountResponse>

    • Parameters

      • store: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<DeleteResponse>

    • Parameters

      • request: {
            store?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<DeleteResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<RecordResponse>

    • Index queries

      Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<RecordResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<KeyResponse>

    • Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<KeyResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }
      • Optionaloptions: { count?: number }

      Returns Promise<RecordsResponse>

    • Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<RecordsResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }
      • Optionaloptions: { count?: number }

      Returns Promise<KeysResponse>

    • Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<KeysResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<bigint>

    • Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<CountResponse>

    • Parameters

      • store: string
      • index: string
      • Optionalquery: {
            query?:
                | { case: undefined; value?: undefined }
                | {
                    case: "key";
                    value: {
                        kind?:
                            | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | { case: undefined; value?: undefined }
                                        | { case: "nullValue"; value: null }
                                        | { case: "stringValue"; value: string }
                                        | { case: "intValue"; value: bigint }
                                        | { case: "floatValue"; value: number }
                                        | { case: "boolValue"; value: boolean }
                                        | { case: "timeValue"; value: Date }
                                        | { case: "bytesValue"; value: Uint8Array<(...)> }
                                        | {
                                            case: "jsonValue";
                                            value: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                        };
                                };
                            }
                            | {
                                case: "array";
                                value: {
                                    elements?: (
                                        { kind?: { case: undefined; value?: undefined; } | { case: "scalar"; value: { kind?: { case: undefined; value?: undefined; } | { case: "nullValue"; value: null; } | { case: "stringValue"; value: string; } | ... 6 more ... | undefined; }; } | { ...; } | undefined; }
                                    )[];
                                };
                            };
                    };
                }
                | {
                    case: "range";
                    value: {
                        lower?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        upper?: {
                            kind?: | { case: undefined; value?: undefined }
                            | {
                                case: "scalar";
                                value: {
                                    kind?:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                };
                            }
                            | { case: "array"; value: { elements?: (...)
                            | (...) } };
                        };
                        lowerOpen?: boolean;
                        upperOpen?: boolean;
                    };
                };
        }

      Returns Promise<DeleteResponse>

    • Parameters

      • request: {
            store?: string;
            index?: string;
            query?: {
                query?:
                    | { case: undefined; value?: undefined }
                    | {
                        case: "key";
                        value: {
                            kind?:
                                | { case: undefined; value?: undefined }
                                | {
                                    case: "scalar";
                                    value: {
                                        kind?:
                                            | { case: ...; value?: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... }
                                            | { case: ...; value: ... };
                                    };
                                }
                                | { case: "array"; value: { elements?: (...)[] } };
                        };
                    }
                    | {
                        case: "range";
                        value: {
                            lower?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            upper?: {
                                kind?: | { case: undefined; value?: undefined }
                                | { case: "scalar"; value: { kind?: ... } }
                                | { case: "array"; value: { elements?: ... } };
                            };
                            lowerOpen?: boolean;
                            upperOpen?: boolean;
                        };
                    };
            };
            count?: number;
        }

      Returns Promise<DeleteResponse>

    • Cursor iteration (bidirectional stream)

      Parameters

      • requests: AsyncIterable<
            {
                msg?: | { case: undefined; value?: undefined }
                | {
                    case: "open";
                    value: {
                        store?: string;
                        index?: string;
                        query?: {
                            query?:
                                | { case: undefined; value?: undefined }
                                | { case: "key"; value: { kind?: (...) | (...) | (...) | (...) } }
                                | {
                                    case: "range";
                                    value: {
                                        lower?: (...) | (...);
                                        upper?: (...) | (...);
                                        lowerOpen?: (...) | (...) | (...);
                                        upperOpen?: (...) | (...) | (...);
                                    };
                                };
                        };
                        direction?: number;
                        keysOnly?: boolean;
                    };
                }
                | {
                    case: "command";
                    value: {
                        command?: | { case: undefined; value?: undefined }
                        | { case: "next"; value: boolean }
                        | {
                            case: "continueToKey";
                            value: { key?: { kind?: (...) | (...) | (...) | (...) } };
                        }
                        | { case: "advance"; value: number }
                        | {
                            case: "update";
                            value: { fields?: { [key: string]: { kind?: ... } } };
                        }
                        | { case: "delete"; value: boolean }
                        | { case: "close"; value: boolean };
                    };
                };
            },
        >

      Returns AsyncIterable<CursorResponse>

    • Transaction stream. The first client message must be BeginTransactionRequest. Stream close before commit aborts the transaction.

      Parameters

      • requests: AsyncIterable<
            {
                msg?: | { case: undefined; value?: undefined }
                | {
                    case: "begin";
                    value: { stores?: string[]; mode?: number; durabilityHint?: number };
                }
                | {
                    case: "operation";
                    value: {
                        requestId?: bigint;
                        operation?: | { case: undefined; value?: undefined }
                        | { case: "get"; value: { store?: string; id?: string } }
                        | { case: "getKey"; value: { store?: string; id?: string } }
                        | {
                            case: "add";
                            value: { store?: string; record?: { fields?: (...) | (...) } };
                        }
                        | {
                            case: "put";
                            value: { store?: string; record?: { fields?: (...)
                            | (...) } };
                        }
                        | { case: "delete"; value: { store?: string; id?: string } }
                        | { case: "clear"; value: { store?: string } }
                        | {
                            case: "getAll";
                            value: {
                                store?: string;
                                query?: { query?: (...) | (...) | (...) | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "getAllKeys";
                            value: {
                                store?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "count";
                            value: {
                                store?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "deleteRange";
                            value: {
                                store?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexGet";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexGetKey";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexGetAll";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexGetAllKeys";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexCount";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        }
                        | {
                            case: "indexDelete";
                            value: {
                                store?: string;
                                index?: string;
                                query?: { query?: (...)
                                | (...)
                                | (...)
                                | (...) };
                                count?: number;
                            };
                        };
                    };
                }
                | { case: "commit"; value: {} }
                | { case: "abort"; value: { reason?: string } };
            },
        >

      Returns AsyncIterable<TransactionServerMessage>