@argdown/node
Preparing search index...
IncludePlugin
Class IncludePlugin
Implements
IAsyncArgdownPlugin
Index
Constructors
constructor
Properties
defaults
name
prepare
run
Async
Methods
get
Settings
replace
Includes
Async
Constructors
constructor
new
IncludePlugin
(
config
?:
IIncludeSettings
)
:
IncludePlugin
Parameters
Optional
config
:
IIncludeSettings
Returns
IncludePlugin
Properties
defaults
defaults
:
IIncludeSettings
name
name
:
string
= "IncludePlugin"
prepare
prepare
:
IRequestHandler
= ...
run
Async
runAsync
:
IAsyncRequestHandler
= ...
Methods
get
Settings
getSettings
(
request
:
IArgdownRequest
)
:
IIncludeSettings
Parameters
request
:
IArgdownRequest
Returns
IIncludeSettings
replace
Includes
Async
replaceIncludesAsync
(
currentFilePath
:
string
,
str
:
string
,
regEx
:
RegExp
,
filesAlreadyIncluded
:
string
[]
,
)
:
Promise
<
string
>
Parameters
currentFilePath
:
string
str
:
string
regEx
:
RegExp
filesAlreadyIncluded
:
string
[]
Returns
Promise
<
string
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
defaults
name
prepare
run
Async
Methods
get
Settings
replace
Includes
Async
@argdown/node
Loading...