Beignet API reference
Preparing search index...
@beignet/cli
ExplainAppResult
Type Alias ExplainAppResult
Version 1 deterministic explanation of one app-map target.
type
ExplainAppResult
=
{
app
:
AppMapResult
[
"app"
]
;
conventions
:
string
[]
;
evidence
:
ExplainEvidence
[]
;
findings
:
ExplainFinding
[]
;
query
:
{
kind
:
ExplainTargetKind
;
target
:
string
}
;
relationships
:
ExplainRelationship
[]
;
schemaVersion
:
1
;
scope
:
{
findings
:
number
;
nodes
:
number
;
relationships
:
number
;
returnedRelationships
:
number
;
truncated
:
boolean
;
}
;
suggestedActions
:
ExplainSuggestedAction
[]
;
suggestedFiles
:
ExplainSuggestedFile
[]
;
summary
:
string
;
target
:
ExplainTarget
;
targetDir
:
string
;
}
Index
Properties
app
conventions
evidence
findings
query
relationships
schema
Version
scope
suggested
Actions
suggested
Files
summary
target
target
Dir
Properties
app
app
:
AppMapResult
[
"app"
]
conventions
conventions
:
string
[]
evidence
evidence
:
ExplainEvidence
[]
findings
findings
:
ExplainFinding
[]
query
query
:
{
kind
:
ExplainTargetKind
;
target
:
string
}
relationships
relationships
:
ExplainRelationship
[]
schema
Version
schemaVersion
:
1
scope
scope
:
{
findings
:
number
;
nodes
:
number
;
relationships
:
number
;
returnedRelationships
:
number
;
truncated
:
boolean
;
}
suggested
Actions
suggestedActions
:
ExplainSuggestedAction
[]
suggested
Files
suggestedFiles
:
ExplainSuggestedFile
[]
summary
summary
:
string
target
target
:
ExplainTarget
target
Dir
targetDir
:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
app
conventions
evidence
findings
query
relationships
schema
Version
scope
suggested
Actions
suggested
Files
summary
target
target
Dir
Beignet API reference
Loading...
Version 1 deterministic explanation of one app-map target.