Preparing search index...
The search index is not available
extra-build
extra-build
readDocument
Function readDocument
read
Document
(
pth
)
:
Document
Read document.
Parameters
pth
:
string
file path
Returns
Document
document {path, data}
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
extra-
build
Bundle
Options
Docs
Details
Document
Exec
Options
Git
Commit
Push
Options
Git
Setup
Branch
Options
Github
Repo
Details
Github
Url
Details
Jsdoc
Token
Markdown
Options
Webify
Options
On
Docs
Details
On
Jsdoc
Token
add
Banner
bundle
Script
docs
Child
Count
docs
Description
docs
Details
docs
Flags
docs
Kind
docs
Location
docs
Name
docs
Parameter
Count
docs
Refer
docs
Refer
Details
docs
Returns
docs
Signature
Count
docs
Type
error
exec
exec
Str
generate
Docs
git
Commit
Push
git
Setup
Branch
info
jsdocify
Script
keywordname
latest
Version
load
Docs
log
next
Unpublished
Version
parse
Github
Url
publish
publish
Docs
publish
Github
read
Document
read
File
Text
read
Json
read
Metadata
registry
set
Registry
symbolname
update
Github
Repo
Details
warn
webify
Script
wiki
Code
Example
wiki
Code
Reference
wiki
Markdown
wiki
Update
Code
Reference
wiki
Update
Description
wiki
Update
Index
wiki
Update
Link
References
write
Document
write
File
Text
write
Json
write
Metadata
Generated using
TypeDoc
Read document.