Search
Preparing search index...
The search index is not available
@xblox/fs
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"file"
External module "file"
Index
Interfaces
IOptions
Variables
Q
promised
Chmod
promised
Stat
Functions
accept
async
check
Content
check
Content
Async
check
Mode
check
Mode
Async
defaults
is
File
is
File
Async
sync
touch
touch
Async
validate
Input
write
Async
Variables
Q
Q
:
any
= require('q')
promised
Chmod
promised
Chmod
:
any
= Q.denodeify(fs.chmod)
promised
Stat
promised
Stat
:
any
= Q.denodeify(fs.stat)
Functions
accept
accept
(
path
:
string
, stat
:
Stats
, options
?:
IOptions
)
:
void
Parameters
path:
string
stat:
Stats
Optional
options:
IOptions
Returns
void
async
async
(
path
:
string
, options
:
IOptions
)
:
Promise
<
Object
>
Parameters
path:
string
options:
IOptions
Returns
Promise
<
Object
>
check
Content
check
Content
(
path
:
string
, mode
:
string
, options
:
IOptions
)
:
boolean
Parameters
path:
string
mode:
string
options:
IOptions
Returns
boolean
check
Content
Async
check
Content
Async
(
path
:
string
, mode
:
string
, options
:
IOptions
)
:
Promise
<
Object
>
Parameters
path:
string
mode:
string
options:
IOptions
Returns
Promise
<
Object
>
check
Mode
check
Mode
(
path
:
string
, mode
:
string
, options
:
IOptions
)
:
void
Parameters
path:
string
mode:
string
options:
IOptions
Returns
void
check
Mode
Async
check
Mode
Async
(
path
:
string
, mode
:
string
, options
:
IOptions
)
:
any
Parameters
path:
string
mode:
string
options:
IOptions
Returns
any
defaults
defaults
(
passedCriteria
:
IOptions
|
null
)
:
IOptions
Parameters
passedCriteria:
IOptions
|
null
Returns
IOptions
is
File
is
File
(
path
:
string
)
:
Stats
Parameters
path:
string
Returns
Stats
is
File
Async
is
File
Async
(
path
:
string
)
:
Promise
<
Stats
>
Parameters
path:
string
Returns
Promise
<
Stats
>
sync
sync
(
path
:
string
, options
:
IOptions
)
:
void
Parameters
path:
string
options:
IOptions
Returns
void
touch
touch
(
path
:
string
, options
:
IOptions
)
:
void
Parameters
path:
string
options:
IOptions
Returns
void
touch
Async
touch
Async
(
path
:
string
, options
:
IOptions
)
:
Promise
<
null
>
Parameters
path:
string
options:
IOptions
Returns
Promise
<
null
>
validate
Input
validate
Input
(
methodName
:
string
, path
:
string
, options
?:
IOptions
)
:
void
Parameters
methodName:
string
path:
string
Optional
options:
IOptions
Returns
void
write
Async
write
Async
(
path
:
string
, stat
:
Stats
, options
:
IOptions
)
:
Promise
<
boolean
>
Parameters
path:
string
stat:
Stats
options:
IOptions
Returns
Promise
<
boolean
>
Globals
"file"
IOptions
Q
promised
Chmod
promised
Stat
accept
async
check
Content
check
Content
Async
check
Mode
check
Mode
Async
defaults
is
File
is
File
Async
sync
touch
touch
Async
validate
Input
write
Async
Generated using
TypeDoc