Class PakFileReader

The main reader implementation, intended for reading the records from a single PAK file.

Hierarchy

PakFileReader

Index

Constructors

constructor

Methods

parse

Constructors

constructor

new PakFileReader(filePath: string, opts?: PakFileReaderOptions): PakFileReader

- Defined in fileReader.ts:30
Creates a new instance of the PakFileReader for the PAK file at the given path.

remarks

Changing the encoding is not recommended unless you really know what you're doing.

Parameters
- filePath: string
  
  Path to the PAK file to read.
- Optional opts: PakFileReaderOptions
  
  Options for fine-tuning the reader and parser behaviour.
Returns PakFileReader

Methods

parse

parse(): Promise<IPakFile>

- Defined in fileReader.ts:53
Parses the footer and index records of the current file.

Returns Promise<IPakFile>

An object for the records and metadata of the current PAK file.

Generated using TypeDoc