Skip to content

TypeScript API / contentia/documents/testing / DocumentsContractCase

Interface: DocumentsContractCase ​

Properties ​

collection? ​

ts
collection?: string;

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


collectionFolder? ​

ts
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 ​

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

Returns ​

| DocumentsRepository | Promise<DocumentsRepository>


name ​

ts
name: string;

skip? ​

ts
skip?: DocumentsContractCapability[];

teardown? ​

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

Returns ​

void | Promise<void>