Search
Preparing search index...
The search index is not available
@xblox/fs
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"remove"
External module "remove"
Index
Interfaces
IVisitor
Args
Variables
trash
Functions
async
collect
is
Done
next
on
Conflict
parse
Options
resolve
Conflict
rmASync
rm
Trash
sync
validate
Input
visitor
Variables
trash
trash
:
any
= require('trash')
Functions
async
async
(
path
:
string
, options
?:
IDeleteOptions
)
:
Promise
<
TDeleteResult
>
Parameters
path:
string
Optional
options:
IDeleteOptions
Returns
Promise
<
TDeleteResult
>
collect
collect
(
path
:
string
, options
?:
IDeleteOptions
)
:
Promise
<
IProcessingNode
[]
>
Parameters
path:
string
Optional
options:
IDeleteOptions
Returns
Promise
<
IProcessingNode
[]
>
is
Done
is
Done
(
nodes
:
IProcessingNode
[]
)
:
boolean
Parameters
nodes:
IProcessingNode
[]
Returns
boolean
next
next
(
nodes
:
IProcessingNode
[]
)
:
IProcessingNode
Parameters
nodes:
IProcessingNode
[]
Returns
IProcessingNode
on
Conflict
on
Conflict
(
from
:
string
, options
:
IDeleteOptions
, settings
:
IConflictSettings
)
:
EResolveMode
|
undefined
Parameters
from:
string
options:
IDeleteOptions
settings:
IConflictSettings
Returns
EResolveMode
|
undefined
parse
Options
parse
Options
(
options
:
any
|
null
, path
:
string
)
:
IDeleteOptions
Parameters
options:
any
|
null
path:
string
Returns
IDeleteOptions
resolve
Conflict
resolve
Conflict
(
path
:
string
, resolveMode
:
EResolveMode
)
:
boolean
Parameters
path:
string
resolveMode:
EResolveMode
Returns
boolean
rmASync
rmASync
(
path
:
string
, options
:
IDeleteOptions
)
:
any
Parameters
path:
string
options:
IDeleteOptions
Returns
any
rm
Trash
rm
Trash
(
path
:
string
)
:
any
Parameters
path:
string
Returns
any
sync
sync
(
path
:
string
, options
?:
IDeleteOptions
)
:
void
Parameters
path:
string
Optional
options:
IDeleteOptions
Returns
void
validate
Input
validate
Input
(
methodName
:
string
, path
:
string
)
:
void
Parameters
methodName:
string
path:
string
Returns
void
visitor
visitor
(
path
:
string
, vars
:
IVisitorArgs
, item
:
IProcessingNode
)
:
Promise
<
void
>
Parameters
path:
string
vars:
IVisitorArgs
item:
IProcessingNode
Returns
Promise
<
void
>
Globals
"remove"
IVisitor
Args
trash
async
collect
is
Done
next
on
Conflict
parse
Options
resolve
Conflict
rmASync
rm
Trash
sync
validate
Input
visitor
Generated using
TypeDoc