scran.js/browser/realizeFile.js

Single cell RNA-seq analysis in Javascript

import * as methods from "./file.js";
import * as utils from "./utils.js";
import * as areal from "./abstract/realize.js";

/**
 * Choose a temporary file path on the system's default temporary directory (Node.js) or on the virtual file system (browser).
 * This can be used to enable environment-agnostic creation of temporary files.
 *
 * @param {object} [options={}] - Optional parameters.
 * @param {string} [options.extension=""] - File extension to use for any temporary file that might be created.
 *
 * @return {string} Temporary file path.
 */
export function chooseTemporaryPath(options = {}) {
    const { extension = "", ...others } = options;
    utils.checkOtherOptions(others);
    return areal.temp("temp_", extension);    
}

/**
 * Realize a file so that it can be read by **scran.js** functions across both Node.js and browsers.
 *
 * @param {string|Uint8Array} file - In general, a Uint8Array buffer containing the file contents.
 * For Node.js, this may also be a string containing a path to a file.
 * @param {object} [options={}] - Optional parameters.
 * @param {string} [options.extension=""] - File extension to use for any temporary file that might be created.
 *
 * @return {Object} Object with the following properties:
 *
 * - `path`: a string containing the path to the file on the local filesystem (Node.js) or virtual file system (browsers).
 *   For Node.js, `file` is returned directly if it is already a path;
 *   otherwise, a new file will be created in the system's default temporary directory.
 * - `flush`: a function to be called to remove any temporary file created by this function.
 *   For Node.js, this will be a no-op if `file` is already a path. 
 */
export function realizeFile(file, options = {}) {
    const { extension = "", ...others } = options;
    utils.checkOtherOptions(others);

    if (typeof file == "string") {
        return areal.handleString(file);
    }

    let tmppath = chooseTemporaryPath({ extension: extension });
    methods.writeFile(tmppath, file);
    return { 
        path: tmppath, 
        flush: () => methods.removeFile(tmppath) 
    };
}