Class Asar

A directory entry.

Hierarchy

DirectoryEntry
- Asar

Index

Constructors

constructor

new Asar(asarBytes?, opts?): Asar
Parameters
- Optional asarBytes: Uint8Array
- opts: Partial<AsarOptions> = {}
Returns Asar
Overrides DirectoryEntry.constructor
- Defined in asar.ts:83

Properties

files

files: {
[filename: string]: EntryData | undefined;
}

Type declaration

[filename: string]: EntryData | undefined

`Optional` initialParseData

initialParseData?: AsarInitialParseData

Methods

extract

extract(output): Promise<void>
Extracts the Asar archive to a directory
Parameters
- output: string
  
  The directory to extract to
Returns Promise<void>
- Defined in asar.ts:300

getData

getData(opts?): {
    bytes: Uint8Array;
    header?: DirectoryEntryData;
    headerString?: string;
    rawHeader?: Uint8Array;
    rawHeaderSize?: number;
}
Gets the Asar archive data
Parameters
- opts: Partial<AsarGetDataOptions> = {}
  
  Options for getting the data and what to return
Returns {
    bytes: Uint8Array;
    header?: DirectoryEntryData;
    headerString?: string;
    rawHeader?: Uint8Array;
    rawHeaderSize?: number;
}
The Asar archive data, and more if specified in the options
- bytes: Uint8Array
  
  The raw Asar archive data that can be saved to a file.
- Optional header?: DirectoryEntryData
- Optional headerString?: string
- Optional rawHeader?: Uint8Array
- Optional rawHeaderSize?: number
- Defined in asar.ts:333

getFromPath

getFromPath(path): Entry
Gets the entry at the given path.
Parameters
- path: string | string[]
  
  The path or path chunks to get the entry at.
Returns Entry
Inherited from DirectoryEntry.getFromPath
- Defined in entries.ts:167

listFiles

listFiles(): string[]
Lists all files in this directory. This is not recursive.

Returns string[]
A list of all files in this directory.
Inherited from DirectoryEntry.listFiles
- Defined in entries.ts:214

readFile

readFile(path): Uint8Array
Reads a file from the Asar archive
Parameters
- path: string | string[] | Entry
  
  The path to the file inside the Asar archive
Returns Uint8Array
The file data
- Defined in asar.ts:211

saveData

saveData(asarPath, opts?): Promise<void>
Gets the Asar archive data and saves it to a file
Parameters
- asarPath: string
  
  The path to save the Asar archive to
- opts: Partial<AsarGetDataOptions> = {}
  
  Options passed to Asar.getData
Returns Promise<void>
- Defined in asar.ts:474

walkFiles

walkFiles(includeDirectories?, _path?): Generator<readonly [string, string[], Entry], void, unknown>
Walks through the directory and recursively yields all files and directories.
Parameters
- includeDirectories: boolean = true
  
  Whether to include directories in the result.
- _path: null | string[] = null
  
  Used internally for recursion.
Returns Generator<readonly [string, string[], Entry], void, unknown>
Inherited from DirectoryEntry.walkFiles
- Defined in entries.ts:223

writeFile

writeFile(path, data, createDirs?): void
Writes to a file inside the Asar archive
Parameters
- path: string | string[]
  
  The path to the file inside the Asar archive
- data: string | Uint8Array
  
  The data to write to the file
- createDirs: boolean = false
  
  Whether to create directories in between if they don't exist
Returns void
- Defined in asar.ts:243

`Static` fromData

fromData(entryData): FileEntry
Creates an entry from the given entry data.
Parameters
- entryData: FileEntryData
  
  The entry data to create the entry from.
Returns FileEntry
Inherited from DirectoryEntry.fromData
- Defined in entries.ts:24
fromData(entryData): DirectoryEntry
Parameters
- entryData: DirectoryEntryData
Returns DirectoryEntry
Inherited from DirectoryEntry.fromData
- Defined in entries.ts:25
fromData(entryData): Entry
Parameters
- entryData: EntryData
Returns Entry
Inherited from DirectoryEntry.fromData
- Defined in entries.ts:26

`Static` fromDirectory

fromDirectory(inputDir, opts?): Promise<Asar>
Creates a new Asar instance from a directory
Parameters
- inputDir: string
  
  The directory to read from
- Optional opts: Partial<AsarOptions>
  
  Options for initialising the Asar instance
Returns Promise<Asar>
The Asar instance
- Defined in asar.ts:174

`Static` fromFile

fromFile(asarPath, opts?): Promise<Asar>
Creates a new Asar instance from an Asar archive file
Parameters
- asarPath: string
  
  The path to the Asar archive file
- Optional opts: Partial<AsarOptions>
  
  Options for initialising the Asar instance
Returns Promise<Asar>
The Asar instance
- Defined in asar.ts:198

`Static` isDirectory

isDirectory(entry): entry is DirectoryEntry
Checks whether the given entry is a directory.
Parameters
- entry: BaseEntry
  
  The entry or entry data to check.
Returns entry is DirectoryEntry
Inherited from DirectoryEntry.isDirectory
- Defined in entries.ts:49
isDirectory(entry): entry is DirectoryEntryData
Parameters
- entry: EntryData
Returns entry is DirectoryEntryData
Inherited from DirectoryEntry.isDirectory
- Defined in entries.ts:50

`Static` isEntry

isEntry(entry): entry is Entry
Checks wether the given value is an entry.
Parameters
- entry: unknown
  
  The value to check.
Returns entry is Entry
Inherited from DirectoryEntry.isEntry
- Defined in entries.ts:41

`Static` isFile

isFile(entry): entry is FileEntry
Checks whether the given entry is a file.
Parameters
- entry: BaseEntry
  
  The entry or entry data to check.
Returns entry is FileEntry
Inherited from DirectoryEntry.isFile
- Defined in entries.ts:59
isFile(entry): entry is FileEntryData
Parameters
- entry: EntryData
Returns entry is FileEntryData
Inherited from DirectoryEntry.isFile
- Defined in entries.ts:60

`Static` `Private` readFileFromBytes

readFileFromBytes(bytes, offset, size): Uint8Array
Parameters
- bytes: Uint8Array
- offset: number
- size: number
Returns Uint8Array
- Defined in asar.ts:229

Class Asar

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional asarBytes: Uint8Array

opts: Partial<AsarOptions> = {}

Returns Asar

Properties

files

Type declaration

[filename: string]: EntryData | undefined

Optional initialParseData

Methods

extract

Parameters

output: string

Returns Promise<void>

getData

Parameters

opts: Partial<AsarGetDataOptions> = {}

Returns { bytes: Uint8Array; header?: DirectoryEntryData; headerString?: string; rawHeader?: Uint8Array; rawHeaderSize?: number; }

bytes: Uint8Array

Optional header?: DirectoryEntryData

Optional headerString?: string

Optional rawHeader?: Uint8Array

Optional rawHeaderSize?: number

getFromPath

Parameters

path: string | string[]

Returns Entry

listFiles

Returns string[]

readFile

Parameters

path: string | string[] | Entry

Returns Uint8Array

saveData

Parameters

asarPath: string

opts: Partial<AsarGetDataOptions> = {}

Returns Promise<void>

walkFiles

Parameters

includeDirectories: boolean = true

_path: null | string[] = null

Returns Generator<readonly [string, string[], Entry], void, unknown>

writeFile

Parameters

path: string | string[]

data: string | Uint8Array

createDirs: boolean = false

Returns void

Static fromData

Parameters

entryData: FileEntryData

Returns FileEntry

Parameters

entryData: DirectoryEntryData

Returns DirectoryEntry

Parameters

entryData: EntryData

Returns Entry

Static fromDirectory

Parameters

inputDir: string

Optional opts: Partial<AsarOptions>

Returns Promise<Asar>

Static fromFile

Parameters

asarPath: string

Optional opts: Partial<AsarOptions>

Returns Promise<Asar>

Static isDirectory

Parameters

entry: BaseEntry

`Optional` asarBytes: Uint8Array

`Optional` initialParseData

Returns {
bytes: Uint8Array;
header?: DirectoryEntryData;
headerString?: string;
rawHeader?: Uint8Array;
rawHeaderSize?: number;
}

`Optional` header?: DirectoryEntryData

`Optional` headerString?: string

`Optional` rawHeader?: Uint8Array

`Optional` rawHeaderSize?: number

`Static` fromData

`Static` fromDirectory

`Optional` opts: Partial<AsarOptions>

`Static` fromFile

`Optional` opts: Partial<AsarOptions>

`Static` isDirectory

`Static` isEntry

`Static` isFile

`Static` `Private` readFileFromBytes