Install

$ npm install --save @gmod/faidx

Usage

Operates on a readStream/writeStream

import { generateFastaIndex } from "@gmod/faidx";
const write = fs.createWriteStream("out.fa.fai");
const read = fs.createReadStream("out.fa");
await generateFastaIndex(write, read);

Academic Use

This package was written with funding from the NHGRI as part of the JBrowse project. If you use it in an academic project that you publish, please cite the most recent JBrowse paper, which will be linked from jbrowse.org.

License

MIT © Colin Diesh