MelonDatabaseSchema
@melon-db/db — MelonDatabaseSchema
Interface: MelonDatabase<Schema>
Defined in: packages/melon-db/src/database/types.ts:64
Type Parameters
| Type Parameter | Default type |
|---|---|
Schema extends MelonSchema | MelonSchema |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
adapter | readonly | StorageAdapter | packages/melon-db/src/database/types.ts:66 |
devtools? | readonly | DevtoolsBridge | packages/melon-db/src/database/types.ts:67 |
schema | readonly | Schema | packages/melon-db/src/database/types.ts:65 |
Methods
applyRemoteChanges()
applyRemoteChanges(
changes,options?):Promise<void>
Defined in: packages/melon-db/src/database/types.ts:78
Parameters
| Parameter | Type |
|---|---|
changes | SyncChanges |
options? | ApplyRemoteChangesOptions |
Returns
Promise<void>
collection()
collection<
Name>(name):MelonCollection<CollectionRecord>
Defined in: packages/melon-db/src/database/types.ts:68
Type Parameters
| Type Parameter |
|---|
Name extends string |
Parameters
| Parameter | Type |
|---|---|
name | Name |
Returns
MelonCollection<CollectionRecord>
createCheckpointStore()
createCheckpointStore():
CheckpointStore
Defined in: packages/melon-db/src/database/types.ts:83
Returns
getLocalChanges()
getLocalChanges(
options?):Promise<SyncChanges>
Defined in: packages/melon-db/src/database/types.ts:77
Parameters
| Parameter | Type |
|---|---|
options? | GetLocalChangesOptions |
Returns
Promise<SyncChanges>
markLocalChangesPushed()
markLocalChangesPushed(
collections?):Promise<void>
Defined in: packages/melon-db/src/database/types.ts:82
Parameters
| Parameter | Type |
|---|---|
collections? | string[] |
Returns
Promise<void>
observeCollections()
observeCollections(
names,onChange): () =>void
Defined in: packages/melon-db/src/database/types.ts:73
Parameters
| Parameter | Type |
|---|---|
names | string[] |
onChange | (changes) => void |
Returns
() => void
read()
read<
T>(fn):Promise<T>
Defined in: packages/melon-db/src/database/types.ts:71
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
fn | (tx) => Promise<T> |
Returns
Promise<T>
unsafeReset()
unsafeReset():
Promise<void>
Defined in: packages/melon-db/src/database/types.ts:84
Returns
Promise<void>
write()
write<
T>(fn):Promise<T>
Defined in: packages/melon-db/src/database/types.ts:72
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
fn | (tx) => Promise<T> |
Returns
Promise<T>