Type Definitions
CoreOptions
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
statConcurrency |
Number |
<optional> |
4 | Sets the number of workers used to process the internal fs stat queue. |
- Source:
EntryData
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
name |
String | Sets the entry name including internal path. |
||
date |
String | Date |
<optional> |
NOW() | Sets the entry date. |
mode |
Number |
<optional> |
D:0755/F:0644 | Sets the entry permissions. |
prefix |
String |
<optional> |
Sets a path prefix for the entry name. Useful
when working with methods like |
|
stats |
fs.Stats |
<optional> |
Sets the fs stat data for this entry allowing for reduction of fs stat calls when stat data is already known. |
- Source:
ErrorData
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
message |
String | The message of the error. |
code |
String | The error code assigned to this error. |
data |
String | Additional data provided for reporting or debugging (where available). |
- Source:
JsonOptions
Type:
- Object
- Source:
ProgressData
Type:
- Object
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
entries |
Object |
Properties
|
|||||||||
fs |
Object |
Properties
|
- Source:
TarEntryData
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
name |
String | Sets the entry name including internal path. |
||
date |
String | Date |
<optional> |
NOW() | Sets the entry date. |
mode |
Number |
<optional> |
D:0755/F:0644 | Sets the entry permissions. |
prefix |
String |
<optional> |
Sets a path prefix for the entry name. Useful
when working with methods like |
|
stats |
fs.Stats |
<optional> |
Sets the fs stat data for this entry allowing for reduction of fs stat calls when stat data is already known. |
- Source:
TarOptions
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
gzip |
Boolean |
<optional> |
false | Compress the tar archive using gzip. |
gzipOptions |
Object |
<optional> |
Passed to zlib to control compression. |
|
* |
* |
<optional> |
See tar-stream documentation for additional properties. |
- Source:
TransformOptions
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
allowHalfOpen |
Boolean |
<optional> |
true | If set to false, then the stream will automatically end the readable side when the writable side ends and vice versa. |
readableObjectMode |
Boolean |
<optional> |
false | Sets objectMode for readable side of the stream. Has no effect if objectMode is true. |
writableObjectMode |
Boolean |
<optional> |
false | Sets objectMode for writable side of the stream. Has no effect if objectMode is true. |
decodeStrings |
Boolean |
<optional> |
true | Whether or not to decode strings
into Buffers before passing them to _write(). |
encoding |
String |
<optional> |
NULL | If specified, then buffers will be decoded
to strings using the specified encoding. |
highWaterMark |
Number |
<optional> |
16kb | The maximum number of bytes to store
in the internal buffer before ceasing to read from the underlying resource.
|
objectMode |
Boolean |
<optional> |
false | Whether this stream should behave as a
stream of objects. Meaning that stream.read(n) returns a single value instead
of a Buffer of size n. |
- Source:
ZipEntryData
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
name |
String | Sets the entry name including internal path. |
||
date |
String | Date |
<optional> |
NOW() | Sets the entry date. |
mode |
Number |
<optional> |
D:0755/F:0644 | Sets the entry permissions. |
prefix |
String |
<optional> |
Sets a path prefix for the entry name. Useful
when working with methods like |
|
stats |
fs.Stats |
<optional> |
Sets the fs stat data for this entry allowing for reduction of fs stat calls when stat data is already known. |
|
store |
Boolean |
<optional> |
ZipOptions.store | Sets the compression method to STORE. |
- Source:
ZipOptions
Type:
- Object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
comment |
String |
<optional> |
Sets the zip archive comment. |
|
forceLocalTime |
Boolean |
<optional> |
false | Forces the archive to contain local file times instead of UTC. |
forceZip64 |
Boolean |
<optional> |
false | Forces the archive to contain ZIP64 headers. |
store |
Boolean |
<optional> |
false | Sets the compression method to STORE. |
zlib |
Object |
<optional> |
Passed to zlib to control compression. |
|
* |
* |
<optional> |
See zip-stream documentation for current list of properties. |
- Source: