Search
Preparing search index...
The search index is not available
@xblox/fs
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"read"
External module "read"
Index
Variables
Q
promised
Read
File
supported
Return
As
Functions
Err
Json
async
json
Date
Parser
sync
validate
Input
Variables
Q
Q
:
any
= require('q')
promised
Read
File
promised
Read
File
:
any
= Q.denodeify(readFile)
supported
Return
As
supported
Return
As
:
Array
<
string
>
= ['utf8', 'buffer', 'json', 'jsonWithDates']
Functions
Err
Json
Err
Json
(
path
:
string
, err
:
Error
)
:
Error
Parameters
path:
string
err:
Error
Returns
Error
async
async
(
path
:
string
, returnAs
?:
string
)
:
Promise
<
ReadWriteDataType
>
Parameters
path:
string
Optional
returnAs:
string
Returns
Promise
<
ReadWriteDataType
>
json
Date
Parser
json
Date
Parser
(
key
:
string
, value
:
string
|
Date
)
:
Date
Parameters
key:
string
value:
string
|
Date
Returns
Date
sync
sync
(
path
:
string
, returnAs
?:
string
)
:
ReadWriteDataType
Parameters
path:
string
Optional
returnAs:
string
Returns
ReadWriteDataType
validate
Input
validate
Input
(
methodName
:
string
, path
:
string
, returnAs
:
string
)
:
void
Parameters
methodName:
string
path:
string
returnAs:
string
Returns
void
Globals
"read"
Q
promised
Read
File
supported
Return
As
Err
Json
async
json
Date
Parser
sync
validate
Input
Generated using
TypeDoc