Search
Preparing search index...
The search index is not available
@atomist/automation-client
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"project/local/NodeFsLocalFile"
NodeFsLocalFile
Class NodeFsLocalFile
Implementation of File interface on node file system
Hierarchy
AbstractFile
NodeFsLocalFile
Implements
ScriptedFlushable
<
File
>
File
LocalFile
Index
Constructors
constructor
Properties
base
Dir
cache
path
Accessors
dirty
extension
name
real
Path
Methods
flush
get
Content
get
Content
Buffer
get
Content
Sync
invalidate
Cache
is
Binary
is
Executable
is
Readable
record
Action
rename
replace
replace
All
set
Content
set
Content
Sync
set
Path
Constructors
constructor
new
Node
FsLocal
File
(
baseDir
:
string
, path
:
string
)
:
NodeFsLocalFile
Parameters
baseDir:
string
path:
string
Returns
NodeFsLocalFile
Properties
Readonly
base
Dir
base
Dir
:
string
Readonly
cache
cache
:
Record
<
string
,
object
>
path
path
:
string
Accessors
dirty
get
dirty
(
)
:
boolean
Returns
boolean
extension
get
extension
(
)
:
string
Returns
string
name
get
name
(
)
:
string
Returns
string
real
Path
get
realPath
(
)
:
string
Returns
string
Methods
flush
flush
(
)
:
Promise
<
this
>
Returns
Promise
<
this
>
get
Content
get
Content
(
encoding
?:
string
)
:
Promise
<
string
>
Parameters
Default value
encoding:
string
= "utf8"
Returns
Promise
<
string
>
get
Content
Buffer
get
Content
Buffer
(
)
:
Promise
<
Buffer
>
Returns
Promise
<
Buffer
>
get
Content
Sync
get
Content
Sync
(
encoding
?:
string
)
:
string
Parameters
Default value
encoding:
string
= "utf8"
Returns
string
Protected
invalidate
Cache
invalidate
Cache
(
)
:
this
Returns
this
is
Binary
is
Binary
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
is
Executable
is
Executable
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
is
Readable
is
Readable
(
)
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
record
Action
record
Action
(
action
:
ScriptAction
<
File
,
any
>
)
:
this
Parameters
action:
ScriptAction
<
File
,
any
>
Returns
this
rename
rename
(
name
:
string
)
:
Promise
<
this
>
Parameters
name:
string
Returns
Promise
<
this
>
replace
replace
(
re
:
RegExp
, replacement
:
string
)
:
Promise
<
this
>
Parameters
re:
RegExp
replacement:
string
Returns
Promise
<
this
>
replace
All
replace
All
(
oldLiteral
:
string
, newLiteral
:
string
)
:
Promise
<
this
>
Parameters
oldLiteral:
string
newLiteral:
string
Returns
Promise
<
this
>
set
Content
set
Content
(
content
:
string
)
:
Promise
<
this
>
Parameters
content:
string
Returns
Promise
<
this
>
set
Content
Sync
set
Content
Sync
(
content
:
string
)
:
this
Parameters
content:
string
Returns
this
set
Path
set
Path
(
path
:
string
)
:
Promise
<
this
>
Parameters
path:
string
Returns
Promise
<
this
>
Globals
"project/local/
Node
FsLocal
File"
Node
FsLocal
File
constructor
base
Dir
cache
path
dirty
extension
name
real
Path
flush
get
Content
get
Content
Buffer
get
Content
Sync
invalidate
Cache
is
Binary
is
Executable
is
Readable
record
Action
rename
replace
replace
All
set
Content
set
Content
Sync
set
Path
real
Path
Generated using
TypeDoc
Implementation of File interface on node file system