Interface IFoamConfig

packages/foam-core/src/config.ts:1–46

export interface IFoamConfig {
  // Files
  getFilesInclude(): string[];
  getFilesExclude(): string[];
  getDefaultNoteExtension(): string;
  getNotesExtensions(): string[];
  getAttachmentExtensions(): string[];
  getNewNotePath(): 'root' | 'currentDir';

  // Templates
  getTemplatesFolder(): string;

  // Daily notes
  getDailyNoteDirectory(): string | null;
  getDailyNoteFilenameFormat(): string;
  getDailyNoteFileExtension(): string;
  getDailyNoteTitleFormat(): string | null;
  getOpenDailyNoteOnStartup(): boolean;

  // Date
  getDateLocale(): string;
  getDateSnippetsAfterCompletion(): 'noop' | 'createNote' | 'navigateToNote';

  // Links
  getLinksDirectoryMode(): 'resolve' | 'disabled';
  getLinksSyncEnable(): boolean;
  getLinksHoverEnable(): boolean;
  getEditLinkReferenceDefinitions(): 'withExtensions' | 'withoutExtensions' | 'off';

  // Completion
  getCompletionLabel(): 'path' | 'title' | 'identifier';
  getCompletionUseAlias(): 'never' | 'whenPathDiffersFromTitle';
  getCompletionLinkFormat(): 'wikilink' | 'link';

  // Preview
  getPreviewEmbedNoteType(): 'full-inline' | 'full-card' | 'content-inline' | 'content-card';

  // Graph
  getGraphOnStartup(): boolean;
  getGraphNavigateToPreview(): boolean;
  getGraphTitleMaxLength(): number;
  getGraphStyle(): object;

  // Languages
  getSupportedLanguages(): string[];
}

/**
 * A partial config source — represents one layer of a cascade.