Coal LLC - v1.0.0
    Preparing search index...

    Class Archive

    wrapper around an format-specific archive handler

    Archive

    Index

    Constructors

    constructor

    Accessors

    addFile create extractAll extractFile readDir readFile write

    Constructors

    Accessors

    • get addFile(): | ((filePath: string, sourcePath: string) => Bluebird<void>)
      | undefined

      add a single file to the archive

      Returns ((filePath: string, sourcePath: string) => Bluebird<void>) | undefined

    • get create(): ((sourcePath: string) => Bluebird<void>) | undefined

      create this archive from the files in sourcePath

      Returns ((sourcePath: string) => Bluebird<void>) | undefined

    • get extractAll(): ((outputPath: string) => Bluebird<void>) | undefined

      extract the entire archive

      Returns ((outputPath: string) => Bluebird<void>) | undefined

    • get extractFile(): | ((filePath: string, outputPath: string) => Bluebird<void>)
      | undefined

      extract a single file

      Returns ((filePath: string, outputPath: string) => Bluebird<void>) | undefined

    • get readDir(): ((archivePath: string) => Bluebird<string[]>) | undefined

      list files at the specified path

      Returns ((archivePath: string) => Bluebird<string[]>) | undefined

    • get readFile(): ((filePath: string) => ReadableStream) | undefined

      read a file at the specified path via a stream

      Returns ((filePath: string) => ReadableStream) | undefined

    • get write(): (() => Bluebird<void>) | undefined

      Returns (() => Bluebird<void>) | undefined

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors