Reads an index from archive bytes.
A single top folder (GitHub's FNNDSC-chris-plugins-<sha>/) is the root; the pax global header's comment is the commit.
FNNDSC-chris-plugins-<sha>/
comment
The archive, gzipped or plain.
The source word, for the index's source and label.
source
label
The index.
When the archive is unreadable, an entry's path is unsafe, or the schema it carries is not JSON.
const index: PluginIndex = pluginIndexArchive_read(readFileSync('index.tar.gz'), 'FNNDSC/chris-plugins@main'); Copy
const index: PluginIndex = pluginIndexArchive_read(readFileSync('index.tar.gz'), 'FNNDSC/chris-plugins@main');
Reads an index from archive bytes.
A single top folder (GitHub's
FNNDSC-chris-plugins-<sha>/) is the root; the pax global header'scommentis the commit.