APIs

Show:

Constructor

NodeCrawler

(
  • session
)

Parameters:

  • session Object

Methods

_defer_browse_node

(
  • cacheNode
  • referenceTypeId
  • actionOnBrowse
)
private

perform a deferred browse instead of calling session.browse directly, this function add the request to a list so that request can be grouped and send in one single browse command to the server.

Parameters:

  • cacheNode CacheNode
  • referenceTypeId String | ReferenceType
  • actionOnBrowse Function
    • err Error | Null
    • object CacheNode

_defer_readNode

(
  • nodeId
  • attributeId
  • callback
)
private

request a read operation for a Node+Attribute in the future, provides a callback

Parameters:

  • nodeId NodeId
  • attributeId AttributeId
  • callback Function
    • err Error | Null
    • dataValue String

_emit_on_crawled

(
  • cacheNode
  • userData
)
private

Parameters:

  • cacheNode Object
  • userData Object
    • [onBrowsed=null] Function optional

_process_single_browseResult

(
  • _objectToBrowse
  • browseResult
)
private

Parameters:

_push_task add a task at the bottom of the queue (low priority)

(
  • name
  • task
)
private

Parameters:

  • name String
  • task Object

_resolve_deferred_readNode

(
  • callback
)
private

perform pending read Node operation

Parameters:

  • callback Function

_unshift_task add a task on top of the queue (high priority)

(
  • name
  • task
)
private

Parameters:

  • name String
  • task Object

crawl

(
  • nodeId
  • userData
  • end_callback
)

Parameters:

  • nodeId NodeId
  • userData Object
    • onBrowse Function
  • end_callback Function

withSessionAsync

(
  • endpointUrl
  • func
)
Promise<>

Parameters:

  • endpointUrl Object
  • func Function

    Async function

Returns:

Promise<>:

Note: only present on node >= 8