TarParser

View Source

Summary

A parser for tar archives.

Signature

class TarParser {
  constructor(options: ParseTarHeaderOptions): TarParser;

  // Methods
  parse(archive: TarArchiveSource, handler: TarEntryHandler): Promise<void>;
}

Constructor Params

options

Options that control how the tar archive is parsed

Methods

parse(archive: TarArchiveSource, handler: TarEntryHandler): Promise

Parse a stream/buffer tar archive and call the given handler for each entry it contains. Resolves when the parse is finished and all handlers resolve.

archive

The tar archive source data

handler

A function to call for each entry in the archive