Classes
Query
Defined in: index.ts:178
Constructors
new Query()
new Query(__namedParameters): Query
Defined in: index.ts:199
Parameters
__namedParameters
Returns
Methods
search()
search(query, signal?): Promise<QueryResponse>
Defined in: index.ts:392
Search the graph for nodes and edges that match the given query.
Parameters
query
string
signal?
AbortSignal
Returns
Promise
<QueryResponse
>
getQueryTokens()
static getQueryTokens(query): ParsedSelectorToken[]
Defined in: index.ts:445
Parses a query string in order to retrieve an array of tokens.
Parameters
query
string
Returns
hasSecuritySelectors()
static hasSecuritySelectors(query): boolean
Defined in: index.ts:190
Helper method to determine if a given query string is using any of the known security selectors. This is useful so that operations can skip hydrating the security archive if it’s not needed.
Parameters
query
string
Returns
boolean
Type Aliases
GraphSelectionState
type GraphSelectionState = object
Defined in: types.ts:39
Type declaration
edges
edges: Set<EdgeLike>
nodes
nodes: Set<NodeLike>
Insights
type Insights = object
Defined in: types.ts:95
Type declaration
abandoned?
optional abandoned: boolean;
confused?
optional confused: boolean;
cve?
optional cve: `CVE-${string}`[];
cwe?
optional cwe: `CWE-${string}`[];
debug?
optional debug: boolean;
deprecated?
optional deprecated: boolean;
dynamic?
optional dynamic: boolean;
entropic?
optional entropic: boolean;
env?
optional env: boolean;
eval?
optional eval: boolean;
fs?
optional fs: boolean;
license?
optional license: LicenseInsights;
malware?
optional malware: MalwareInsights;
minified?
optional minified: boolean;
native?
optional native: boolean;
network?
optional network: boolean;
obfuscated?
optional obfuscated: boolean;
scanned
scanned: boolean
score?
optional score: PackageScore;
scripts?
optional scripts: boolean;
severity?
optional severity: SeverityInsights;
shell?
optional shell: boolean;
shrinkwrap?
optional shrinkwrap: boolean;
squat?
optional squat: SquatInsights;
suspicious?
optional suspicious: boolean;
tracker?
optional tracker: boolean;
trivial?
optional trivial: boolean;
undesirable?
optional undesirable: boolean;
unknown?
optional unknown: boolean;
unmaintained?
optional unmaintained: boolean;
unpopular?
optional unpopular: boolean;
unstable?
optional unstable: boolean;
LeveledInsights
type LeveledInsights = object
Defined in: types.ts:141
Type declaration
critical
critical: boolean
high
high: boolean
low
low: boolean
medium
medium: boolean
LicenseInsights
type LicenseInsights = object
Defined in: types.ts:130
Type declaration
ambiguous
ambiguous: boolean
copyleft
copyleft: boolean
exception
exception: boolean
misc
misc: boolean
none
none: boolean
restricted
restricted: boolean
unknown
unknown: boolean
unlicensed
unlicensed: boolean
MalwareInsights
type MalwareInsights = LeveledInsights
Defined in: types.ts:148
ParsedSelectorToken
type ParsedSelectorToken = PostcssNode & object
Defined in: types.ts:158
Type declaration
token
token: string
ParserFn()
type ParserFn = (opt) => Promise<ParserState>
Defined in: types.ts:156
Parameters
opt
Returns
Promise
<ParserState
>
ParserState
type ParserState = object
Defined in: types.ts:44
Type declaration
cancellable()
cancellable: () => Promise<void>
Returns
Promise
<void
>
collect
collect: GraphSelectionState
current
current: PostcssNode
initial
initial: GraphSelectionState
loose?
optional loose: boolean;
next?
optional next: PostcssNode;
partial
partial: GraphSelectionState
prev?
optional prev: PostcssNode;
result?
optional result: NodeLike[];
retries
retries: number
securityArchive
securityArchive: | SecurityArchiveLike | undefined;
signal?
optional signal: AbortSignal;
specOptions
specOptions: SpecOptions
walk
walk: ParserFn
PostcssNode
type PostcssNode = | Tag | String | Selector | Root | Pseudo | Nesting | Identifier | Comment | Combinator | ClassName | Attribute | Universal
Defined in: types.ts:23
PostcssNodeWithChildren
type PostcssNodeWithChildren = Selector | Root | Pseudo
Defined in: types.ts:37
QueryOptions
type QueryOptions = object
Defined in: index.ts:124
Type declaration
graph
graph: GraphLike
retries?
optional retries: number;
securityArchive
securityArchive: | SecurityArchiveLike | undefined;
specOptions
specOptions: SpecOptions
QueryResponse
type QueryResponse = object
Defined in: types.ts:61
Type declaration
edges
edges: QueryResponseEdge[];
nodes
nodes: QueryResponseNode[];
QueryResponseEdge
type QueryResponseEdge = Omit<EdgeLike, 'from' | 'to'> & object
Defined in: types.ts:66
Type declaration
from
from: QueryResponseNode
to?
optional to: QueryResponseNode;
QueryResponseNode
type QueryResponseNode = Omit<NodeLike, 'edgesIn' | 'edgesOut'> & object
Defined in: types.ts:71
Type declaration
edgesIn
edgesIn: Set<QueryResponseEdge>
edgesOut
edgesOut: Map<string, QueryResponseEdge>
insights
insights: Insights
toJSON()
toJSON: () => Pick< QueryResponseNode, | 'id' | 'name' | 'version' | 'location' | 'importer' | 'manifest' | 'projectRoot' | 'integrity' | 'resolved' | 'dev' | 'optional' | 'insights' >
Returns
Pick
<QueryResponseNode
, | "id"
|
"name"
| "version"
| "location"
| "importer"
|
"manifest"
| "projectRoot"
| "integrity"
| "resolved"
|
"dev"
| "optional"
| "insights"
>
SeverityInsights
type SeverityInsights = LeveledInsights
Defined in: types.ts:149
SquatInsights
type SquatInsights = object
Defined in: types.ts:151
Type declaration
critical
critical: boolean
medium
medium: boolean
Functions
asAttributeNode()
function asAttributeNode(node?): Attribute
Defined in: types.ts:188
Parameters
node?
Returns
Attribute
asCombinatorNode()
function asCombinatorNode(node?): Combinator
Defined in: types.ts:205
Parameters
node?
Returns
Combinator
asIdentifierNode()
function asIdentifierNode(node?): Identifier
Defined in: types.ts:222
Parameters
node?
Returns
Identifier
asPostcssNodeWithChildren()
function asPostcssNodeWithChildren(node?): PostcssNodeWithChildren
Defined in: types.ts:167
Parameters
node?
Returns
asPseudoNode()
function asPseudoNode(node?): Pseudo
Defined in: types.ts:256
Parameters
node?
Returns
Pseudo
asSelectorNode()
function asSelectorNode(node?): Selector
Defined in: types.ts:239
Parameters
node?
Returns
Selector
asStringNode()
function asStringNode(node?): String
Defined in: types.ts:291
Parameters
node?
Returns
String
asTagNode()
function asTagNode(node?): Tag
Defined in: types.ts:273
Parameters
node?
Returns
Tag
isAttributeNode()
function isAttributeNode(node): node is Attribute
Defined in: types.ts:185
Parameters
node
unknown
Returns
node is Attribute
isCombinatorNode()
function isCombinatorNode(node): node is Combinator
Defined in: types.ts:202
Parameters
node
unknown
Returns
node is Combinator
isIdentifierNode()
function isIdentifierNode(node): node is Identifier
Defined in: types.ts:219
Parameters
node
any
Returns
node is Identifier
isPostcssNodeWithChildren()
function isPostcssNodeWithChildren( node,): node is PostcssNodeWithChildren
Defined in: types.ts:162
Parameters
node
any
Returns
node is PostcssNodeWithChildren
isPseudoNode()
function isPseudoNode(node): node is Pseudo
Defined in: types.ts:253
Parameters
node
unknown
Returns
node is Pseudo
isSelectorNode()
function isSelectorNode(node): node is Selector
Defined in: types.ts:236
Parameters
node
any
Returns
node is Selector
isStringNode()
function isStringNode(node): node is String
Defined in: types.ts:288
Parameters
node
unknown
Returns
node is String
isTagNode()
function isTagNode(node): node is Tag
Defined in: types.ts:270
Parameters
node
unknown
Returns
node is Tag
walk()
function walk(state): Promise<ParserState>
Defined in: index.ts:66
Parameters
state
Returns
Promise
<ParserState
>