Blame view

node_modules/fstream/README.md 2.29 KB
2a09d1a4   liuqimichale   添加宜春 天水 宣化
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
  Like FS streams, but with stat on them, and supporting directories and
  symbolic links, as well as normal files.  Also, you can use this to set
  the stats on a file, even if you don't change its contents, or to create
  a symlink, etc.
  
  So, for example, you can "write" a directory, and it'll call `mkdir`.  You
  can specify a uid and gid, and it'll call `chown`.  You can specify a
  `mtime` and `atime`, and it'll call `utimes`.  You can call it a symlink
  and provide a `linkpath` and it'll call `symlink`.
  
  Note that it won't automatically resolve symbolic links.  So, if you
  call `fstream.Reader('/some/symlink')` then you'll get an object
  that stats and then ends immediately (since it has no data).  To follow
  symbolic links, do this: `fstream.Reader({path:'/some/symlink', follow:
  true })`.
  
  There are various checks to make sure that the bytes emitted are the
  same as the intended size, if the size is set.
  
  ## Examples
  
  ```javascript
  fstream
    .Writer({ path: "path/to/file"
            , mode: 0755
            , size: 6
            })
    .write("hello\n")
    .end()
  ```
  
  This will create the directories if they're missing, and then write
  `hello\n` into the file, chmod it to 0755, and assert that 6 bytes have
  been written when it's done.
  
  ```javascript
  fstream
    .Writer({ path: "path/to/file"
            , mode: 0755
            , size: 6
            , flags: "a"
            })
    .write("hello\n")
    .end()
  ```
  
  You can pass flags in, if you want to append to a file.
  
  ```javascript
  fstream
    .Writer({ path: "path/to/symlink"
            , linkpath: "./file"
            , SymbolicLink: true
            , mode: "0755" // octal strings supported
            })
    .end()
  ```
  
  If isSymbolicLink is a function, it'll be called, and if it returns
  true, then it'll treat it as a symlink.  If it's not a function, then
  any truish value will make a symlink, or you can set `type:
  'SymbolicLink'`, which does the same thing.
  
  Note that the linkpath is relative to the symbolic link location, not
  the parent dir or cwd.
  
  ```javascript
  fstream
    .Reader("path/to/dir")
    .pipe(fstream.Writer("path/to/other/dir"))
  ```
  
  This will do like `cp -Rp path/to/dir path/to/other/dir`.  If the other
  dir exists and isn't a directory, then it'll emit an error.  It'll also
  set the uid, gid, mode, etc. to be identical.  In this way, it's more
  like `rsync -a` than simply a copy.