PagedDocument
Experimental UTF-8 read-only source. Positions count raw decoded UTF-16, including a BOM.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PagedDocument(
source,options?):PagedDocument
Parameters
Section titled “Parameters”source
Section titled “source”options?
Section titled “options?”Returns
Section titled “Returns”PagedDocument
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get stats():
object
Returns
Section titled “Returns”object
bytesRead
Section titled “bytesRead”bytesRead:
number
cachedBytes
Section titled “cachedBytes”cachedBytes:
number
checkpoints
Section titled “checkpoints”checkpoints:
number
checkpointStride
Section titled “checkpointStride”checkpointStride:
number
inFlight
Section titled “inFlight”inFlight:
number
lines:
number
peakCachedBytes
Section titled “peakCachedBytes”peakCachedBytes:
number
peakInFlight
Section titled “peakInFlight”peakInFlight:
number
state:
"disposed"|"failed"|"indexing"|"ready"|"stale"
utf16Length
Section titled “utf16Length”utf16Length:
number
views:
number
Methods
Section titled “Methods”createView()
Section titled “createView()”createView():
PagedDocumentView
Returns
Section titled “Returns”dispose()
Section titled “dispose()”dispose():
void
Returns
Section titled “Returns”void
initialize()
Section titled “initialize()”initialize():
Promise<void>
Returns
Section titled “Returns”Promise<void>