TypeScript API / laikacms/documents/drizzle / DrizzleDocumentsRepositoryOptions

Interface: DrizzleDocumentsRepositoryOptions<CKE, CKSW, CSE, CSNE, CSI, CDLTE, CA, RKE, RE, RA>

Type Parameters

Type Parameter
CKE
CKSW
CSE
CSNE
CSI
CDLTE
CA
RKE
RE
RA

Properties

callbacks

callbacks: object;

documents

documents: object;

documents.count?

optional count?: (query) => Promise<number>;

Optional. Return the total number of rows matching where (no LIMIT/OFFSET). When provided, listRecords / listRecordSummaries populate done.total with the full matching count instead of the page count, enabling correct meta.page.total in the Documents JSON:API.

Parameters

Parameter	Type
query	{ where: CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA; }
query.where	CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA

Returns

Promise<number>

documents.delete

delete: (query) => Promise<DocumentModel[]>;

Parameters

Parameter	Type
query	{ where: CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA; }
query.where	CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA

Returns

Promise<DocumentModel[]>

documents.insert

insert: (query) => Promise<DocumentModel[]>;

Parameters

Parameter	Type
query	{ values: DocumentModelStrict; }
query.values	DocumentModelStrict

Returns

Promise<DocumentModel[]>

documents.select

select: (query) => Promise<DocumentModel[]>;

Parameters

Parameter	Type
query	{ excludeContent?: boolean; limit?: number; offset?: number; where: CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA; }
query.excludeContent?	boolean
query.limit?	number
query.offset?	number
query.where	CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA

Returns

Promise<DocumentModel[]>

documents.update

update: (query) => Promise<DocumentModel[]>;

Parameters

Parameter	Type
query	{ values: Partial<DocumentModelStrict>; where: CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA; }
query.values	Partial<DocumentModelStrict>
query.where	CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA

Returns

Promise<DocumentModel[]>

revisions

revisions: object;

revisions.count?

optional count?: (query) => Promise<number>;

Optional. Return the total number of revision rows matching where (no LIMIT/OFFSET). When provided, listRevisions populates done.total with the full count instead of the page count, enabling correct meta.page.total in the Documents JSON:API.

Parameters

Parameter	Type
query	{ where: RKE | RE | RA; }
query.where	RKE | RE | RA

Returns

Promise<number>

revisions.delete

delete: (query) => Promise<RevisionModel[]>;

Parameters

Parameter	Type
query	{ where: RKE | RE | RA; }
query.where	RKE | RE | RA

Returns

Promise<RevisionModel[]>

revisions.insert

insert: (query) => Promise<RevisionModel[]>;

Parameters

Parameter	Type
query	{ values: RevisionModelStrict; }
query.values	RevisionModelStrict

Returns

Promise<RevisionModel[]>

revisions.select

select: (query) => Promise<RevisionModel[]>;

Parameters

Parameter	Type
query	{ excludeContent?: boolean; limit?: number; offset?: number; where: RKE | RE | RA; }
query.excludeContent?	boolean
query.limit?	number
query.offset?	number
query.where	RKE | RE | RA

Returns

Promise<RevisionModel[]>

revisions.update

update: (query) => Promise<RevisionModel[]>;

Parameters

Parameter	Type
query	{ values: Partial<RevisionModelStrict>; where: RKE | RE | RA; }
query.values	Partial<RevisionModelStrict>
query.where	RKE | RE | RA

Returns

Promise<RevisionModel[]>

---

documentQueryBuilders

documentQueryBuilders: object;

and

and: (...conditions) => CA;

Parameters

Parameter	Type
...conditions	(CKE | CKSW | CSE | CSNE | CSI | CDLTE | CA)[]

Returns

CA

depthLte

depthLte: (value) => CDLTE;

Parameters

Parameter	Type
value	number

Returns

CDLTE

keyEquals

keyEquals: (value) => CKE;

Parameters

Parameter	Type
value	string

Returns

CKE

keyStartsWith

keyStartsWith: (prefix) => CKSW;

Parameters

Parameter	Type
prefix	string

Returns

CKSW

statusEquals

statusEquals: (value) => CSE;

Parameters

Parameter	Type
value	string

Returns

CSE

statusIn

statusIn: (values) => CSI;

Parameters

Parameter	Type
values	string[]

Returns

CSI

statusNotEquals

statusNotEquals: (value) => CSNE;

Parameters

Parameter	Type
value	string

Returns

CSNE

---

logger?

optional logger?: Pick<Console, "error" | "warn" | "info" | "debug">;

---

revisionQueryBuilders

revisionQueryBuilders: object;

and

and: (...conditions) => RA;

Parameters

Parameter	Type
...conditions	(RKE | RE | RA)[]

Returns

RA

keyEquals

keyEquals: (value) => RKE;

Parameters

Parameter	Type
value	string

Returns

RKE

revisionEquals

revisionEquals: (value) => RE;

Parameters

Parameter	Type
value	string

Returns

RE