@stencila/jesta/dist/util/dirs.d.ts

Stencila plugin for executable documents using JavaScript

/**
 * Utility module with functions that return the path to operating
 * system specific directories.
 *
 * Whilst there are packages that provide similar functions, we
 * generally prefer to roll our own for each language to make
 * sure that there is consistency in their implementation.
 *
 * Much of these implementations is based on
 * https://github.com/sindresorhus/env-paths/blob/master/index.js
 */
/**
 * Get a Stencila plugin directory.
 *
 * The `plugins` directory is used to store the manifests and other
 * data of Stencila plugins.
 */
export declare function plugin(name: string, ensure?: boolean): string;
/**
 * Get the Stencila cache directory.
 *
 * The `cache` directory is used to store cached content that may
 * be used across applications, plugins and machine restarts.
 */
export declare function cache(ensure?: boolean): string;