KnowledgeOS API Reference
Preparing search index...
sdk/typescript/src
GraphTraversalQuery
Interface GraphTraversalQuery
interface
GraphTraversalQuery
{
direction
(
dir
:
"outgoing"
|
"incoming"
|
"both"
)
:
GraphTraversalQuery
;
edgeLabels
(
labels
:
string
[]
)
:
GraphTraversalQuery
;
execute
()
:
Promise
<
SDKResponse
<
TraversalResultDTO
>
>
;
executeRaw
()
:
Promise
<
ApiResponse
<
TraversalResultDTO
>
>
;
maxDepth
(
depth
:
number
)
:
GraphTraversalQuery
;
maxResults
(
n
:
number
)
:
GraphTraversalQuery
;
nodeLabels
(
labels
:
string
[]
)
:
GraphTraversalQuery
;
}
Hierarchy (
View Summary
)
QueryBuilder
<
TraversalResultDTO
>
GraphTraversalQuery
Index
Methods
direction
edge
Labels
execute
execute
Raw
max
Depth
max
Results
node
Labels
Methods
direction
direction
(
dir
:
"outgoing"
|
"incoming"
|
"both"
)
:
GraphTraversalQuery
Parameters
dir
:
"outgoing"
|
"incoming"
|
"both"
Returns
GraphTraversalQuery
edge
Labels
edgeLabels
(
labels
:
string
[]
)
:
GraphTraversalQuery
Parameters
labels
:
string
[]
Returns
GraphTraversalQuery
execute
execute
()
:
Promise
<
SDKResponse
<
TraversalResultDTO
>
>
Returns
Promise
<
SDKResponse
<
TraversalResultDTO
>
>
execute
Raw
executeRaw
()
:
Promise
<
ApiResponse
<
TraversalResultDTO
>
>
Returns
Promise
<
ApiResponse
<
TraversalResultDTO
>
>
max
Depth
maxDepth
(
depth
:
number
)
:
GraphTraversalQuery
Parameters
depth
:
number
Returns
GraphTraversalQuery
max
Results
maxResults
(
n
:
number
)
:
GraphTraversalQuery
Parameters
n
:
number
Returns
GraphTraversalQuery
node
Labels
nodeLabels
(
labels
:
string
[]
)
:
GraphTraversalQuery
Parameters
labels
:
string
[]
Returns
GraphTraversalQuery
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
direction
edge
Labels
execute
execute
Raw
max
Depth
max
Results
node
Labels
KnowledgeOS API Reference
Loading...