UNPKG

ares-ide

Version:

A browser-based code editor and UI designer for Enyo 2 projects

github.com/enyojs/ares-project/blob/master/README.md

enyojs/ares-project

100 lines (53 loc) • 3.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# Archiver v0.4.10 [![Build Status](https://secure.travis-ci.org/ctalkington/node-archiver.png?branch=master)](http://travis-ci.org/ctalkington/node-archiver) Creates Archives (Zip, Tar) via Node Streams. Depends on Node's built-in zlib module for compression available since version 0.6.3. ## Install ```bash npm install archiver --save ``` You can also use `npm install https://github.com/ctalkington/node-archiver/archive/master.tar.gz` to test upcoming versions. ## Archiver #### #create(type, options) Creates an Archiver instance based on the type (ie zip/tar) passed. Can be passed to `Archiver` for convenience. ### Instance Methods #### #append(input, data, callback(err)) Appends a file to the instance. Input can be in the form of a text string, buffer, or stream. When the instance has received, processed, and emitted the input, the callback is fired. Replaces `#addFile` which is in the depreciation stage and set to be remove in next release. #### #finalize(callback(err, bytes)) Finalizes the instance. When the instance's stream has finished emitting, the callback is fired. This generally doesn't correspond to the end of the destination stream; though a solution to track the destination stream may come in a future release. ## Zip ### Options #### comment `string` Sets the zip comment. #### forceUTC `boolean` If true, forces the file date and time to UTC. Helps with testing across timezones. #### zlib `object` Passed to node's [zlib](http://nodejs.org/api/zlib.html#zlib_options) module to control compression. Options may vary by node version. ### File Data #### name `string` `required` Sets the file name including internal path. #### date `string|Date` Sets the file date. This can be any valid date string or instance. Defaults to current time in locale. #### store `boolean` If true, file contents will be stored without compression. #### comment `string` Sets the file comment. ## Tar ### Options #### recordSize `number` Sets the size (in bytes) of each record in a block, default is 512 (for advanced users only). #### recordsPerBlock `number` Sets the number of records in a block, default is 20 (for advanced users only). ### File Data #### name `string` `required` Sets the file name including internal path. #### date `string|Date` Sets the file date. This can be any valid date string or instance. Defaults to current time in locale. ## Things of Interest - [Examples](https://github.com/ctalkington/node-archiver/blob/master/examples) - [Changelog](https://github.com/ctalkington/node-archiver/blob/master/CHANGELOG) - [Archive Formats](https://github.com/ctalkington/node-archiver/blob/master/formats) - [Contributing](https://github.com/ctalkington/node-archiver/blob/master/CONTRIBUTING.md) - [MIT License](https://github.com/ctalkington/node-archiver/blob/master/LICENSE-MIT) ## Credits Concept inspired by Antoine van Wel's [node-zipstream](https://github.com/wellawaretech/node-zipstream). Tar inspired by isaacs's [node-tar](https://github.com/isaacs/node-tar).