Interfaces
Methods
SM appendFile(filename: string, data: any, options: module:fs.AppendFileOptionsType, callback: module:fs.AppendFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.AppendFileOptionsType | |
callback |
module:fs.AppendFileCallbackCallback |
<optional> |
SM appendFile(filename: string, data: any, options: module:fs.AppendFileOptionsType, callback: module:fs.AppendFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.AppendFileOptionsType | |
callback |
module:fs.AppendFileCallbackCallback |
<optional> |
SM appendFile(filename: string, data: any, callback: module:fs.AppendFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
callback |
module:fs.AppendFileCallbackCallback |
<optional> |
SM appendFileSync(filename: string, data: any, options: module:fs.AppendFileSyncOptionsType) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.AppendFileSyncOptionsType |
<optional> |
SM appendFileSync(filename: string, data: any, options: module:fs.AppendFileSyncOptionsType) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.AppendFileSyncOptionsType |
<optional> |
SM chmod(path: string, mode: number, callback: module:fs.ChmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
number | |
callback |
module:fs.ChmodCallbackCallback |
<optional> |
SM chmod(path: string, mode: string, callback: module:fs.ChmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
string | |
callback |
module:fs.ChmodCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
path |
string |
mode |
number |
Parameters:
Name | Type |
---|---|
path |
string |
mode |
string |
SM chown(path: string, uid: number, gid: number, callback: module:fs.ChownCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
uid |
number | |
gid |
number | |
callback |
module:fs.ChownCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
path |
string |
uid |
number |
gid |
number |
SM close(fd: number, callback: module:fs.CloseCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
callback |
module:fs.CloseCallbackCallback |
<optional> |
SM createReadStream(path: string, options: module:fs.CreateReadStreamOptionsType) fs.ReadStream
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
options |
module:fs.CreateReadStreamOptionsType |
<optional> |
SM createReadStream(path: string, options: module:fs.CreateReadStreamOptionsType) fs.ReadStream
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
options |
module:fs.CreateReadStreamOptionsType |
<optional> |
SM createWriteStream(path: string, options: module:fs.CreateWriteStreamOptionsType) fs.WriteStream
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
options |
module:fs.CreateWriteStreamOptionsType |
<optional> |
SM exists(path: string, callback: module:fs.ExistsCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.ExistsCallbackCallback |
<optional> |
SM fchmod(fd: number, mode: number, callback: module:fs.FchmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
mode |
number | |
callback |
module:fs.FchmodCallbackCallback |
<optional> |
SM fchmod(fd: number, mode: string, callback: module:fs.FchmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
mode |
string | |
callback |
module:fs.FchmodCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
fd |
number |
mode |
number |
Parameters:
Name | Type |
---|---|
fd |
number |
mode |
string |
SM fchown(fd: number, uid: number, gid: number, callback: module:fs.FchownCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
uid |
number | |
gid |
number | |
callback |
module:fs.FchownCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
fd |
number |
uid |
number |
gid |
number |
SM fstat(fd: number, callback: module:fs.FstatCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
callback |
module:fs.FstatCallbackCallback |
<optional> |
SM fsync(fd: number, callback: module:fs.FsyncCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
callback |
module:fs.FsyncCallbackCallback |
<optional> |
SM ftruncate(fd: number, callback: module:fs.FtruncateCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
callback |
module:fs.FtruncateCallbackCallback |
<optional> |
SM ftruncate(fd: number, len: number, callback: module:fs.FtruncateCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
len |
number | |
callback |
module:fs.FtruncateCallbackCallback |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
len |
number |
<optional> |
SM futimes(fd: number, atime: number, mtime: number, callback: module:fs.FutimesCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
atime |
number | |
mtime |
number | |
callback |
module:fs.FutimesCallbackCallback |
<optional> |
SM futimes(fd: number, atime: Date, mtime: Date, callback: module:fs.FutimesCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
atime |
Date | |
mtime |
Date | |
callback |
module:fs.FutimesCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
fd |
number |
atime |
number |
mtime |
number |
Parameters:
Name | Type |
---|---|
fd |
number |
atime |
Date |
mtime |
Date |
SM lchmod(path: string, mode: number, callback: module:fs.LchmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
number | |
callback |
module:fs.LchmodCallbackCallback |
<optional> |
SM lchmod(path: string, mode: string, callback: module:fs.LchmodCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
string | |
callback |
module:fs.LchmodCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
path |
string |
mode |
number |
Parameters:
Name | Type |
---|---|
path |
string |
mode |
string |
SM lchown(path: string, uid: number, gid: number, callback: module:fs.LchownCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
uid |
number | |
gid |
number | |
callback |
module:fs.LchownCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
path |
string |
uid |
number |
gid |
number |
SM link(srcpath: string, dstpath: string, callback: module:fs.LinkCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
srcpath |
string | |
dstpath |
string | |
callback |
module:fs.LinkCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
srcpath |
string |
dstpath |
string |
SM lstat(path: string, callback: module:fs.LstatCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.LstatCallbackCallback |
<optional> |
SM mkdir(path: string, callback: module:fs.MkdirCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.MkdirCallbackCallback |
<optional> |
SM mkdir(path: string, mode: number, callback: module:fs.MkdirCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
number | |
callback |
module:fs.MkdirCallbackCallback |
<optional> |
SM mkdir(path: string, mode: string, callback: module:fs.MkdirCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
string | |
callback |
module:fs.MkdirCallbackCallback |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
number |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
mode |
string |
<optional> |
SM open(path: string, flags: string, callback: module:fs.OpenCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
flags |
string | |
callback |
module:fs.OpenCallbackCallback |
<optional> |
SM open(path: string, flags: string, mode: number, callback: module:fs.OpenCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
flags |
string | |
mode |
number | |
callback |
module:fs.OpenCallbackCallback |
<optional> |
SM open(path: string, flags: string, mode: string, callback: module:fs.OpenCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
flags |
string | |
mode |
string | |
callback |
module:fs.OpenCallbackCallback |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
flags |
string | |
mode |
number |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
flags |
string | |
mode |
string |
<optional> |
SM read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback: module:fs.ReadCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
buffer |
Buffer | |
offset |
number | |
length |
number | |
position |
number | |
callback |
module:fs.ReadCallbackCallback |
<optional> |
SM readdir(path: string, callback: module:fs.ReaddirCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.ReaddirCallbackCallback |
<optional> |
SM readFile(filename: string, encoding: string, callback: module:fs.ReadFileCallbackCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
encoding |
string |
callback |
module:fs.ReadFileCallbackCallback |
SM readFile(filename: string, options: module:fs.ReadFileOptionsType, callback: module:fs.ReadFileCallbackCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
options |
module:fs.ReadFileOptionsType |
callback |
module:fs.ReadFileCallbackCallback |
SM readFile(filename: string, options: module:fs.ReadFileOptionsType, callback: module:fs.ReadFileCallbackCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
options |
module:fs.ReadFileOptionsType |
callback |
module:fs.ReadFileCallbackCallback |
SM readFile(filename: string, callback: module:fs.ReadFileCallbackCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
encoding |
string |
SM readFileSync(filename: string, options: module:fs.ReadFileSyncOptionsType) string
SM readFileSync(filename: string, options: module:fs.ReadFileSyncOptionsType) Buffer
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
options |
module:fs.ReadFileSyncOptionsType |
<optional> |
SM readlink(path: string, callback: module:fs.ReadlinkCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.ReadlinkCallbackCallback |
<optional> |
SM readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number) number
Parameters:
Name | Type |
---|---|
fd |
number |
buffer |
Buffer |
offset |
number |
length |
number |
position |
number |
SM realpath(path: string, callback: module:fs.RealpathCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.RealpathCallbackCallback |
<optional> |
SM realpath(path: string, cache: module:fs.RealpathCacheType, callback: module:fs.RealpathCallbackCallback) void
Parameters:
Name | Type |
---|---|
path |
string |
cache |
module:fs.RealpathCacheType |
callback |
module:fs.RealpathCallbackCallback |
SM realpathSync(path: string, cache: module:fs.RealpathSyncCacheType) string
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
cache |
module:fs.RealpathSyncCacheType |
<optional> |
SM rename(oldPath: string, newPath: string, callback: module:fs.RenameCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
oldPath |
string | |
newPath |
string | |
callback |
module:fs.RenameCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
oldPath |
string |
newPath |
string |
SM rmdir(path: string, callback: module:fs.RmdirCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.RmdirCallbackCallback |
<optional> |
SM stat(path: string, callback: module:fs.StatCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.StatCallbackCallback |
<optional> |
SM symlink(srcpath: string, dstpath: string, type: string, callback: module:fs.SymlinkCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
srcpath |
string | |
dstpath |
string | |
type |
string |
<optional> |
callback |
module:fs.SymlinkCallbackCallback |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
srcpath |
string | |
dstpath |
string | |
type |
string |
<optional> |
SM truncate(path: string, callback: module:fs.TruncateCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.TruncateCallbackCallback |
<optional> |
SM truncate(path: string, len: number, callback: module:fs.TruncateCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
len |
number | |
callback |
module:fs.TruncateCallbackCallback |
<optional> |
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
len |
number |
<optional> |
SM unlink(path: string, callback: module:fs.UnlinkCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
callback |
module:fs.UnlinkCallbackCallback |
<optional> |
SM unwatchFile(filename: string, listener: module:fs.UnwatchFileListenerCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
listener |
module:fs.UnwatchFileListenerCallback |
<optional> |
SM utimes(path: string, atime: number, mtime: number, callback: module:fs.UtimesCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
atime |
number | |
mtime |
number | |
callback |
module:fs.UtimesCallbackCallback |
<optional> |
SM utimes(path: string, atime: Date, mtime: Date, callback: module:fs.UtimesCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
path |
string | |
atime |
Date | |
mtime |
Date | |
callback |
module:fs.UtimesCallbackCallback |
<optional> |
Parameters:
Name | Type |
---|---|
path |
string |
atime |
number |
mtime |
number |
Parameters:
Name | Type |
---|---|
path |
string |
atime |
Date |
mtime |
Date |
SM watch(filename: string, listener: module:fs.WatchListenerCallback) fs.FSWatcher
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
listener |
module:fs.WatchListenerCallback |
<optional> |
SM watch(filename: string, options: module:fs.WatchOptionsType, listener: module:fs.WatchListenerCallback) fs.FSWatcher
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
options |
module:fs.WatchOptionsType | |
listener |
module:fs.WatchListenerCallback |
<optional> |
SM watchFile(filename: string, listener: module:fs.WatchFileListenerCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
listener |
module:fs.WatchFileListenerCallback |
SM watchFile(filename: string, options: module:fs.WatchFileOptionsType, listener: module:fs.WatchFileListenerCallback) void
Parameters:
Name | Type |
---|---|
filename |
string |
options |
module:fs.WatchFileOptionsType |
listener |
module:fs.WatchFileListenerCallback |
SM write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback: module:fs.WriteCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
fd |
number | |
buffer |
Buffer | |
offset |
number | |
length |
number | |
position |
number | |
callback |
module:fs.WriteCallbackCallback |
<optional> |
SM writeFile(filename: string, data: any, callback: module:fs.WriteFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
callback |
module:fs.WriteFileCallbackCallback |
<optional> |
SM writeFile(filename: string, data: any, options: module:fs.WriteFileOptionsType, callback: module:fs.WriteFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.WriteFileOptionsType | |
callback |
module:fs.WriteFileCallbackCallback |
<optional> |
SM writeFile(filename: string, data: any, options: module:fs.WriteFileOptionsType, callback: module:fs.WriteFileCallbackCallback) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.WriteFileOptionsType | |
callback |
module:fs.WriteFileCallbackCallback |
<optional> |
SM writeFileSync(filename: string, data: any, options: module:fs.WriteFileSyncOptionsType) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.WriteFileSyncOptionsType |
<optional> |
SM writeFileSync(filename: string, data: any, options: module:fs.WriteFileSyncOptionsType) void
Parameters:
Name | Type | Argument |
---|---|---|
filename |
string | |
data |
any | |
options |
module:fs.WriteFileSyncOptionsType |
<optional> |
SM writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number) number
Parameters:
Name | Type |
---|---|
fd |
number |
buffer |
Buffer |
offset |
number |
length |
number |
position |
number |
Callbacks
AppendFileCallbackCallback(err: NodeJS.ErrnoException) void
AppendFileCallbackCallback(err: NodeJS.ErrnoException) void
AppendFileCallbackCallback(err: NodeJS.ErrnoException) void
ChmodCallbackCallback(err: NodeJS.ErrnoException) void
ChmodCallbackCallback(err: NodeJS.ErrnoException) void
ChownCallbackCallback(err: NodeJS.ErrnoException) void
CloseCallbackCallback(err: NodeJS.ErrnoException) void
FchmodCallbackCallback(err: NodeJS.ErrnoException) void
FchmodCallbackCallback(err: NodeJS.ErrnoException) void
FchownCallbackCallback(err: NodeJS.ErrnoException) void
FstatCallbackCallback(err: NodeJS.ErrnoException, stats: fs.Stats) any
FsyncCallbackCallback(err: NodeJS.ErrnoException) void
FtruncateCallbackCallback(err: NodeJS.ErrnoException) void
FtruncateCallbackCallback(err: NodeJS.ErrnoException) void
FutimesCallbackCallback(err: NodeJS.ErrnoException) void
FutimesCallbackCallback(err: NodeJS.ErrnoException) void
LchmodCallbackCallback(err: NodeJS.ErrnoException) void
LchmodCallbackCallback(err: NodeJS.ErrnoException) void
LchownCallbackCallback(err: NodeJS.ErrnoException) void
LinkCallbackCallback(err: NodeJS.ErrnoException) void
LstatCallbackCallback(err: NodeJS.ErrnoException, stats: fs.Stats) any
MkdirCallbackCallback(err: NodeJS.ErrnoException) void
MkdirCallbackCallback(err: NodeJS.ErrnoException) void
MkdirCallbackCallback(err: NodeJS.ErrnoException) void
OpenCallbackCallback(err: NodeJS.ErrnoException, fd: number) any
OpenCallbackCallback(err: NodeJS.ErrnoException, fd: number) any
OpenCallbackCallback(err: NodeJS.ErrnoException, fd: number) any
ReadCallbackCallback(err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) void
ReaddirCallbackCallback(err: NodeJS.ErrnoException, files: string[]) void
ReadFileCallbackCallback(err: NodeJS.ErrnoException, data: Buffer) void
ReadFileCallbackCallback(err: NodeJS.ErrnoException, data: string) void
ReadFileCallbackCallback(err: NodeJS.ErrnoException, data: string) void
ReadFileCallbackCallback(err: NodeJS.ErrnoException, data: Buffer) void
ReadlinkCallbackCallback(err: NodeJS.ErrnoException, linkString: string) any
RealpathCallbackCallback(err: NodeJS.ErrnoException, resolvedPath: string) any
RealpathCallbackCallback(err: NodeJS.ErrnoException, resolvedPath: string) any
RenameCallbackCallback(err: NodeJS.ErrnoException) void
RmdirCallbackCallback(err: NodeJS.ErrnoException) void
StatCallbackCallback(err: NodeJS.ErrnoException, stats: fs.Stats) any
SymlinkCallbackCallback(err: NodeJS.ErrnoException) void
TruncateCallbackCallback(err: NodeJS.ErrnoException) void
TruncateCallbackCallback(err: NodeJS.ErrnoException) void
UnlinkCallbackCallback(err: NodeJS.ErrnoException) void
UtimesCallbackCallback(err: NodeJS.ErrnoException) void
UtimesCallbackCallback(err: NodeJS.ErrnoException) void
Parameters:
Name | Type |
---|---|
event |
string |
filename |
string |
Parameters:
Name | Type |
---|---|
event |
string |
filename |
string |
WriteCallbackCallback(err: NodeJS.ErrnoException, written: number, buffer: Buffer) void
WriteFileCallbackCallback(err: NodeJS.ErrnoException) void
WriteFileCallbackCallback(err: NodeJS.ErrnoException) void
WriteFileCallbackCallback(err: NodeJS.ErrnoException) void
Type Definitions
Type:
- Object
- Properties:
-
Name Type encoding
string mode
string flag
string
Type:
- Object
- Properties:
-
Name Type flags
string encoding
string fd
string mode
string bufferSize
number
Type:
- Object
- Properties:
-
Name Type flags
string encoding
string string
string
Type:
- Object
- Properties:
-
Name Type encoding
string mode
string flag
string