Interface IDataStore

packages/foam-core/src/services/datastore.ts:8–49

 * Represents a source of files and content
 */
export interface IDataStore {
  /**
   * List the URIs known to this store.
   *
   * With no argument, returns the full set of URIs the store can see (the
   * usual workspace enumeration).
   *
   * When a workspace-relative glob `pattern` is passed, the store **must**
   * return only URIs matching that glob. 
   */
  list: (pattern?: string) => Promise<URI[]>;

  /**
   * Read the content of the file from the store
   *
   * Returns `null` in case of errors while reading
   */
  read: (uri: URI) => Promise<string | null>;

  /**
   * Write content to the file. Creates parent directories as needed.
   * Overwrites existing files.
   */
  write: (uri: URI, content: string) => Promise<void>;

  /**
   * Delete the file at the given URI. No-op if it doesn't exist.
   */
  delete: (uri: URI) => Promise<void>;

  /**
   * Move (rename) a file from one URI to another. Creates destination
   * parent directories as needed. Atomic where the underlying filesystem
   * supports it.
   */
  move: (from: URI, to: URI) => Promise<void>;

  /**
   * Returns true if the file exists at the given URI.
   */
  exists: (uri: URI) => Promise<boolean>;
}

export interface IWatcher {
  onDidChange: Event<URI>;