TypeScript API / laikacms/documents/testing / DocumentsContractCase

Interface: DocumentsContractCase

Properties

collection?

optional collection?: string;

Optional collection key. Defaults to 'posts'. Must match a collection the impl's settings provider knows about.

---

collectionFolder?

optional collectionFolder?: string;

Optional folder name to scope created keys under. Some impls (e.g. catalog on top of an Obsidian vault) require keys to live inside a configured collection directory.

---

makeRepo

makeRepo: () => 
  | DocumentsRepository
| Promise<DocumentsRepository>;

Returns

| DocumentsRepository | Promise<DocumentsRepository>

---

name

name: string;

---

skip?

optional skip?: DocumentsContractCapability[];

---

teardown?

optional teardown?: () => void | Promise<void>;

Returns

void | Promise<void>