Melon-dbMelon-db
API reference@melon-db/db

MelonCollectionRecordShape

@melon-db/db — MelonCollectionRecordShape

@melon-db/db API Reference


Interface: MelonCollection<RecordShape>

Defined in: packages/melon-db/src/database/types.ts:31

Type Parameters

Type ParameterDefault type
RecordShapeRecord<string, unknown>

Properties

PropertyModifierTypeDefined in
namereadonlystringpackages/melon-db/src/database/types.ts:32

Methods

count()

count(query?): Promise<number>

Defined in: packages/melon-db/src/database/types.ts:38

Parameters

ParameterType
query?CollectionQueryInput<RecordShape>

Returns

Promise<number>


delete()

delete(id): Promise<void>

Defined in: packages/melon-db/src/database/types.ts:47

Parameters

ParameterType
idstring | number

Returns

Promise<void>


findById()

findById(id): Promise<RecordShape | null>

Defined in: packages/melon-db/src/database/types.ts:33

Parameters

ParameterType
idstring | number

Returns

Promise<RecordShape | null>


findFirst()

findFirst(query?): Promise<RecordShape | null>

Defined in: packages/melon-db/src/database/types.ts:35

Parameters

ParameterType
query?CollectionQueryInput<RecordShape>

Returns

Promise<RecordShape | null>


findMany()

findMany(query?): Promise<RecordShape[]>

Defined in: packages/melon-db/src/database/types.ts:34

Parameters

ParameterType
query?CollectionQueryInput<RecordShape>

Returns

Promise<RecordShape[]>


insert()

insert(data): Promise<RecordShape>

Defined in: packages/melon-db/src/database/types.ts:42

Parameters

ParameterType
dataInsertInput<RecordShape>

Returns

Promise<RecordShape>


query()

query(query?): MelonQueryHandle<RecordShape>

Defined in: packages/melon-db/src/database/types.ts:39

Parameters

ParameterType
query?CollectionQueryInput<RecordShape>

Returns

MelonQueryHandle<RecordShape>


update()

update(id, data): Promise<RecordShape>

Defined in: packages/melon-db/src/database/types.ts:43

Parameters

ParameterType
idstring | number
dataUpdateInput<RecordShape>

Returns

Promise<RecordShape>