Class ArchiveWriter

Generic utility for building a tar octet stream by adding JSON-style entries. See the add***() options in this class definition for details.

Hierarchy

ArchiveWriter
- Archive

Implements

TarSerializable

Index

Constructors

constructor

new ArchiveWriter(entries?: TarEntry[]): ArchiveWriter
Parameters
- entries: TarEntry[] = []
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:14

Properties

entries

entries: TarEntry[] = []

Methods

addBinaryFile

addBinaryFile(path: string, content: Uint8Array, headerOptions?: Partial<UstarHeaderLike>): ArchiveWriter
Convenience option for building tarball data

Returns
this for operation chaining
Parameters
- path: string
  
  the file name, e.g. './relative/path/to/your/file.bin'
- content: Uint8Array
  
  the content of the file (shocker!)
- headerOptions: Partial<UstarHeaderLike> = {}
  
  custom options for this entry
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:87

addDirectory

addDirectory(path: string, headerOptions?: Partial<UstarHeaderLike>): ArchiveWriter
Convenience option for building tarball data

Returns
this for operation chaining
Parameters
- path: string
  
  the directory name, e.g. './relative/path/to/your/dir'
- headerOptions: Partial<UstarHeaderLike> = {}
  
  custom options for this entry
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:102

addEntry

addEntry(entry: TarEntry): ArchiveWriter
Convenience for appending a new entry to the existing entries array

Returns
this for operation chaining
Parameters
- entry: TarEntry
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:51

addEntryWith

addEntryWith(header: UstarHeaderLike | Partial<UstarHeaderLike>, content?: Uint8Array): ArchiveWriter
Convenience for appending a new entry to the existing entries array. Uses TarEntry.from() on the given parameters to create the entry.

Returns
this for operation chaining
Parameters
- header: UstarHeaderLike | Partial<UstarHeaderLike>
- Optional content: Uint8Array
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:61

addTextFile

addTextFile(path: string, content: string, headerOptions?: Partial<UstarHeaderLike>): ArchiveWriter
Convenience option for building tarball data

Returns
this for operation chaining
Parameters
- path: string
  
  the file name, e.g. './relative/path/to/your/file.txt'
- content: string
  
  the content of the file (shocker!)
- Optional headerOptions: Partial<UstarHeaderLike>
  
  custom options for this entry
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:72

cleanAllHeaders

cleanAllHeaders(): ArchiveWriter
Convenience option for cleaning the header of each listed entry. See also TarHeader.clean().

Returns ArchiveWriter
- Defined in archive/archive-writer.ts:124

removeEntriesWhere

removeEntriesWhere(predicate: TarEntryPredicate): ArchiveWriter
Removes any entries from this writer's cache that meet the given predicate condition.

Returns
this for operation chaining
Parameters
- predicate: TarEntryPredicate
  
  delegate that will return true for any entry that should be removed.
Returns ArchiveWriter
- Defined in archive/archive-writer.ts:115

toUint8Array

toUint8Array(): Uint8Array
Returns
a complete tar buffer from all the currently set tar entries in this instance.

Returns Uint8Array
Implementation of TarSerializable.toUint8Array
- Defined in archive/archive-writer.ts:43

`Static` serialize

serialize(entries: TarEntry[]): Uint8Array
Combines the given array of entries into a single, complete tarball buffer
Parameters
- entries: TarEntry[]
Returns Uint8Array
- Defined in archive/archive-writer.ts:22

Class ArchiveWriter

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

entries: TarEntry[] = []

Returns ArchiveWriter

Properties

entries

Methods

addBinaryFile

Returns

Parameters

path: string

content: Uint8Array

headerOptions: Partial<UstarHeaderLike> = {}

Returns ArchiveWriter

addDirectory

Returns

Parameters

path: string

headerOptions: Partial<UstarHeaderLike> = {}

Returns ArchiveWriter

addEntry

Returns

Parameters

entry: TarEntry

Returns ArchiveWriter

addEntryWith

Returns

Parameters

header: UstarHeaderLike | Partial<UstarHeaderLike>

Optional content: Uint8Array

Returns ArchiveWriter

addTextFile

Returns

Parameters

path: string

content: string

Optional headerOptions: Partial<UstarHeaderLike>

Returns ArchiveWriter

cleanAllHeaders

Returns ArchiveWriter

removeEntriesWhere

Returns

Parameters

predicate: TarEntryPredicate

Returns ArchiveWriter

toUint8Array

Returns

Returns Uint8Array

Static serialize

Parameters

entries: TarEntry[]

Returns Uint8Array

Settings

Member Visibility

Theme

`Optional` content: Uint8Array

`Optional` headerOptions: Partial<UstarHeaderLike>

`Static` serialize