Oo1ClientBase<TLoadOptions>
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:56
Shared base class for SQLite clients that wrap an oo1.DB-style runtime
(@sqlite.org/sqlite-wasm, @sqliteai/sqlite-wasm, ...).
Subclasses only need to implement loadModule and clientName; everything else (queue management, init/disconnect lifecycle, change-event batching, custom function registration, OPFS fallback) lives here.
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
TLoadOptions extends Oo1ClientLoadOptions | Oo1ClientLoadOptions |
Implements
Constructors
Constructor
new Oo1ClientBase<TLoadOptions>(): Oo1ClientBase<TLoadOptions>;
Returns
Oo1ClientBase<TLoadOptions>
Inherited from
Properties
db
protected db: Oo1Database;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:68
sqlite3
protected sqlite3: Oo1Static;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:67
Accessors
clientName
Get Signature
get abstract protected clientName(): string;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:71
Short identifier used in error messages (e.g. 'sqliteai').
Returns
string
Methods
addEventListener()
addEventListener(type, handler): void;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:77
Public override that matches the exact SqliteClientLike signature. Delegates to the generic implementation in EventDispatcher.
Parameters
| Parameter | Type |
|---|---|
type | SQLiteChangeType |
handler | (event) => void |
Returns
void
Implementation of
SqliteClientLike.addEventListener
Overrides
EventDispatcher.addEventListener
disconnect()
disconnect(): Promise<void>;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:117
Returns
Promise<void>
Implementation of
dispatchEvent()
dispatchEvent<T>(type, data): void;
Defined in: packages/utils/dist/tools/event.d.ts:20
Type Parameters
| Type Parameter |
|---|
T extends keyof Oo1ClientEvents |
Parameters
| Parameter | Type |
|---|---|
type | T |
data | Oo1ClientEvents[T] |
Returns
void
Inherited from
execute()
execute(sql, bindings?): Promise<SqliteSuccessResult>;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:158
Parameters
| Parameter | Type |
|---|---|
sql | string |
bindings? | SQLiteCompatibleType[] |
Returns
Promise<SqliteSuccessResult>
Implementation of
hasEventListener()
hasEventListener<T>(type, listener): boolean;
Defined in: packages/utils/dist/tools/event.d.ts:18
Type Parameters
| Type Parameter |
|---|
T extends keyof Oo1ClientEvents |
Parameters
| Parameter | Type |
|---|---|
type | T |
listener | EventListener<Oo1ClientEvents[T]> |
Returns
boolean
Inherited from
EventDispatcher.hasEventListener
init()
init(dbName, options?): Promise<void>;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:81
Parameters
| Parameter | Type |
|---|---|
dbName | string |
options? | TLoadOptions |
Returns
Promise<void>
loadModule()
abstract protected loadModule(options?): Promise<Oo1Static>;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:166
Load and initialise the underlying sqlite-wasm module.
Parameters
| Parameter | Type |
|---|---|
options? | TLoadOptions |
Returns
Promise<Oo1Static>
normalizeRowId()
protected normalizeRowId(rowId): bigint;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:175
Normalise the rowId emitted by sqlite3_update_hook.
@sqlite.org/sqlite-wasm may yield a regular number for small rowIds, so
the official client overrides this to coerce to bigint. Subclasses whose
runtime always emits bigint can keep the default.
Parameters
| Parameter | Type |
|---|---|
rowId | number | bigint |
Returns
bigint
removeAllEventListeners()
removeAllEventListeners(): void;
Defined in: packages/utils/dist/tools/event.d.ts:21
Returns
void
Inherited from
EventDispatcher.removeAllEventListeners
removeEventListener()
removeEventListener<T>(type, listener): void;
Defined in: packages/utils/dist/tools/event.d.ts:19
Type Parameters
| Type Parameter |
|---|
T extends keyof Oo1ClientEvents |
Parameters
| Parameter | Type |
|---|---|
type | T |
listener | EventListener<Oo1ClientEvents[T]> |
Returns
void
Inherited from
EventDispatcher.removeEventListener
version()
version(): Promise<string>;
Defined in: packages/rxdb-adapter-sqlite-core/src/Oo1ClientBase.ts:112
Returns
Promise<string>