Skip to content
packagesqueryreference

@vltpkg/query

Classes

Query

Defined in: index.ts:152

Constructors

new Query()
new Query(__namedParameters): Query

Defined in: index.ts:172

Parameters
__namedParameters

QueryOptions

Returns

Query

Methods

search(query, signal?): Promise<QueryResponse>

Defined in: index.ts:182

Search the graph for nodes and edges that match the given query.

Parameters
query

string

signal?

AbortSignal

Returns

Promise<QueryResponse>

hasSecuritySelectors()
static hasSecuritySelectors(query): boolean

Defined in: index.ts:163

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:36

Type declaration

edges
edges: Set<EdgeLike>
nodes
nodes: Set<NodeLike>

ParserFn()

type ParserFn = (opt) => Promise<ParserState>

Defined in: types.ts:62

Parameters

opt

ParserState

Returns

Promise<ParserState>

ParserState

type ParserState = object

Defined in: types.ts:41

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[];
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:20

PostcssNodeWithChildren

type PostcssNodeWithChildren = Selector | Root | Pseudo

Defined in: types.ts:34

QueryOptions

type QueryOptions = object

Defined in: index.ts:111

Type declaration

graph
graph: GraphLike
securityArchive
securityArchive:
  | SecurityArchiveLike
  | undefined;
specOptions
specOptions: SpecOptions

QueryResponse

type QueryResponse = object

Defined in: types.ts:57

Type declaration

edges
edges: EdgeLike[];
nodes
nodes: NodeLike[];

Functions

asAttributeNode()

function asAttributeNode(node?): Attribute

Defined in: types.ts:90

Parameters

node?

PostcssNode

Returns

Attribute

asClassNode()

function asClassNode(node?): ClassName

Defined in: types.ts:107

Parameters

node?

PostcssNode

Returns

ClassName

asCombinatorNode()

function asCombinatorNode(node?): Combinator

Defined in: types.ts:124

Parameters

node?

PostcssNode

Returns

Combinator

asIdentifierNode()

function asIdentifierNode(node?): Identifier

Defined in: types.ts:141

Parameters

node?

PostcssNode

Returns

Identifier

asPostcssNodeWithChildren()

function asPostcssNodeWithChildren(node?): PostcssNodeWithChildren

Defined in: types.ts:69

Parameters

node?

PostcssNode

Returns

PostcssNodeWithChildren

asPseudoNode()

function asPseudoNode(node?): Pseudo

Defined in: types.ts:161

Parameters

node?

PostcssNode

Returns

Pseudo

asStringNode()

function asStringNode(node?): String

Defined in: types.ts:196

Parameters

node?

PostcssNode

Returns

String

asTagNode()

function asTagNode(node?): Tag

Defined in: types.ts:178

Parameters

node?

PostcssNode

Returns

Tag

isAttributeNode()

function isAttributeNode(node): node is Attribute

Defined in: types.ts:87

Parameters

node

unknown

Returns

node is Attribute

isClassNode()

function isClassNode(node): node is ClassName

Defined in: types.ts:104

Parameters

node

unknown

Returns

node is ClassName

isCombinatorNode()

function isCombinatorNode(node): node is Combinator

Defined in: types.ts:121

Parameters

node

unknown

Returns

node is Combinator

isIdentifierNode()

function isIdentifierNode(node): node is Identifier

Defined in: types.ts:138

Parameters

node

any

Returns

node is Identifier

isPostcssNodeWithChildren()

function isPostcssNodeWithChildren(
  node,
): node is PostcssNodeWithChildren

Defined in: types.ts:64

Parameters

node

any

Returns

node is PostcssNodeWithChildren

isPseudoNode()

function isPseudoNode(node): node is Pseudo

Defined in: types.ts:158

Parameters

node

unknown

Returns

node is Pseudo

isSelectorNode()

function isSelectorNode(node): node is Selector

Defined in: types.ts:155

Parameters

node

any

Returns

node is Selector

isStringNode()

function isStringNode(node): node is String

Defined in: types.ts:193

Parameters

node

unknown

Returns

node is String

isTagNode()

function isTagNode(node): node is Tag

Defined in: types.ts:175

Parameters

node

unknown

Returns

node is Tag

walk()

function walk(state): Promise<ParserState>

Defined in: index.ts:56

Parameters

state

ParserState

Returns

Promise<ParserState>