chore(readme): minor text fixes
This commit is contained in:
20
README.md
20
README.md
@@ -113,54 +113,54 @@ Returns a string of the current working directory
|
|||||||
|
|
||||||
> Used in: `PWD`
|
> Used in: `PWD`
|
||||||
|
|
||||||
`get(fileName)`
|
`get(fileName)`
|
||||||
Returns a file stat object of file or directory
|
Returns a file stat object of file or directory
|
||||||
|
|
||||||
> Used in: `STAT`, `SIZE`, `RNFR`, `MDTM`
|
> Used in: `STAT`, `SIZE`, `RNFR`, `MDTM`
|
||||||
|
|
||||||
`list(path)`
|
`list(path)`
|
||||||
Returns array of file and directory stat objects
|
Returns array of file and directory stat objects
|
||||||
|
|
||||||
> Used in `LIST`, `STAT`
|
> Used in `LIST`, `STAT`
|
||||||
|
|
||||||
`chdir(path)`
|
`chdir(path)`
|
||||||
Returns new directory relative to cwd
|
Returns new directory relative to cwd
|
||||||
|
|
||||||
> Used in `CWD`, `CDUP`
|
> Used in `CWD`, `CDUP`
|
||||||
|
|
||||||
`mkdir(path)`
|
`mkdir(path)`
|
||||||
Return a path to a newly created directory
|
Return a path to a newly created directory
|
||||||
|
|
||||||
> Used in `MKD`
|
> Used in `MKD`
|
||||||
|
|
||||||
`write(fileName, options)`
|
`write(fileName, options)`
|
||||||
Returns a writable stream
|
Returns a writable stream
|
||||||
Options:
|
Options:
|
||||||
`append` if true, append to existing file
|
`append` if true, append to existing file
|
||||||
|
|
||||||
> Used in `STOR`, `APPE`
|
> Used in `STOR`, `APPE`
|
||||||
|
|
||||||
`read(fileName)`
|
`read(fileName)`
|
||||||
Returns a readable stream
|
Returns a readable stream
|
||||||
|
|
||||||
> Used in `RETR`
|
> Used in `RETR`
|
||||||
|
|
||||||
`delete(path)`
|
`delete(path)`
|
||||||
Delete a file or directory
|
Delete a file or directory
|
||||||
|
|
||||||
> Used in `DELE`
|
> Used in `DELE`
|
||||||
|
|
||||||
`rename(from, to)`
|
`rename(from, to)`
|
||||||
Rename a file or directory
|
Rename a file or directory
|
||||||
|
|
||||||
> Used in `RNFR`, `RNTO`
|
> Used in `RNFR`, `RNTO`
|
||||||
|
|
||||||
`chmod(path)`
|
`chmod(path)`
|
||||||
Modify a file or directory's permissions
|
Modify a file or directory's permissions
|
||||||
|
|
||||||
> Used in `SITE CHMOD`
|
> Used in `SITE CHMOD`
|
||||||
|
|
||||||
`getUniqueName()`
|
`getUniqueName()`
|
||||||
Return a unique file name to write to
|
Return a unique file name to write to
|
||||||
|
|
||||||
> Used in `STOU`
|
> Used in `STOU`
|
||||||
|
|||||||
Reference in New Issue
Block a user