Interface IArchiveHandler

interface for archive handlers, exposing files inside archives to to other extensions

Export

IArchiveHandler

interface IArchiveHandler {
    addFile?(filePath: string, sourcePath: string): Bluebird<void>;
    create?(sourcePath: string): Bluebird<void>;
    extractAll(outputPath: string): Bluebird<void>;
    extractFile?(filePath: string, outputPath: string): Bluebird<void>;
    readDir(archPath: string): Bluebird<string[]>;
    readFile?(filePath: string): ReadableStream;
    write?(): Bluebird<void>;
}

Index

Methods

addFile? create? extractAll extractFile? readDir readFile? write?

Methods

`Optional`addFile

addFile?(filePath: string, sourcePath: string): Bluebird<void>
Parameters
- filePath: string
- sourcePath: string
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:182

`Optional`create

create?(sourcePath: string): Bluebird<void>
Parameters
- sourcePath: string
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:183

extractAll

extractAll(outputPath: string): Bluebird<void>
Parameters
- outputPath: string
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:181

`Optional`extractFile

extractFile?(filePath: string, outputPath: string): Bluebird<void>
Parameters
- filePath: string
- outputPath: string
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:180

readDir

readDir(archPath: string): Bluebird<string[]>
Parameters
- archPath: string
Returns Bluebird<string[]>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:178

`Optional`readFile

readFile?(filePath: string): ReadableStream
Parameters
- filePath: string
Returns ReadableStream
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:179

`Optional`write

write?(): Bluebird<void>
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:184