Reference
Type Aliases
AttributeOperatorName
type AttributeOperatorName = typeof attributeOperatorNames[number];Defined in: grammar.ts:91
CombinatorName
type CombinatorName = typeof combinatorNames[number];Defined in: grammar.ts:78
ParsedSelectorToken
type ParsedSelectorToken = PostcssNode & object;Defined in: types.ts:47
Type declaration
| Name | Type |
|---|---|
token | string |
ParseOptions
type ParseOptions = object;Defined in: index.ts:140
Type declaration
| Name | Type | Description |
|---|---|---|
loose? | boolean | skip DSS grammar checks, malformed syntax still throws |
PostCSSLeaf
type PostCSSLeaf =
| ReturnType<typeof tag>
| ReturnType<typeof id>
| ReturnType<typeof attribute>
| ReturnType<typeof combinator>
| ReturnType<typeof pseudo>
| ReturnType<typeof string>;Defined in: types.ts:37
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:45
PseudoClassName
type PseudoClassName = typeof pseudoClassNames[number];Defined in: grammar.ts:72
Variables
attributeOperatorNames
const attributeOperatorNames: readonly ["=", "^=", "$=", "~=", "*=", "|="];Defined in: grammar.ts:83
Attribute selector operators supported by DSS.
combinatorNames
const combinatorNames: readonly [">", "~", " "];Defined in: grammar.ts:77
Combinators supported by DSS.
pseudoClassNames
const pseudoClassNames: readonly ["abandoned", "attr", "built", "confused", "cve", "cwe", "debug", "deprecated", "dev", "diff", "dist", "dynamic", "empty", "entropic", "env", "eval", "fs", "has", "host", "hostname", "is", "license", "link", "malware", "minified", "missing", "native", "network", "not", "obfuscated", "optional", "outdated", "overridden", "path", "peer", "prerelease", "private", "prod", "project", "published", "registry", "root", "scanned", "scope", "score", "scripts", "semver", "sev", "severity", "shell", "shrinkwrap", "spec", "squat", "suspicious", "tracker", "trivial", "type", "undesirable", "unknown", "unmaintained", "unpopular", "unstable", "v", "vuln", "vulnerable", "workspace"];Defined in: grammar.ts:4
Pseudo-class names supported by DSS, without the leading :.
Functions
asAttributeNode()
function asAttributeNode(node?): AttributeDefined in: types.ts:77
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Attribute
asCombinatorNode()
function asCombinatorNode(node?): CombinatorDefined in: types.ts:94
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Combinator
asCommentNode()
function asCommentNode(node?): CommentDefined in: types.ts:198
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Comment
asIdentifierNode()
function asIdentifierNode(node?): IdentifierDefined in: types.ts:111
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Identifier
asPostcssNodeWithChildren()
function asPostcssNodeWithChildren(node?): PostcssNodeWithChildrenDefined in: types.ts:56
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
asPseudoNode()
function asPseudoNode(node?): PseudoDefined in: types.ts:145
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Pseudo
asSelectorNode()
function asSelectorNode(node?): SelectorDefined in: types.ts:128
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Selector
asStringNode()
function asStringNode(node?): StringDefined in: types.ts:180
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
String
asTagNode()
function asTagNode(node?): TagDefined in: types.ts:162
Parameters
| Parameter | Type |
|---|---|
node? | PostcssNode |
Returns
Tag
escapeDots()
function escapeDots(query): stringDefined in: index.ts:33
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
string
escapeScopedNamesSlashes()
function escapeScopedNamesSlashes(query): stringDefined in: index.ts:27
Escapes forward slashes in specific patterns matching @scoped/name paths This will allow usage of unescaped forward slashes necessary for scoped package names in the id selector.
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
string
isAttributeNode()
function isAttributeNode(node): node is AttributeDefined in: types.ts:74
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is Attribute
isCombinatorNode()
function isCombinatorNode(node): node is CombinatorDefined in: types.ts:91
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is Combinator
isCommentNode()
function isCommentNode(node): node is CommentDefined in: types.ts:195
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is Comment
isIdentifierNode()
function isIdentifierNode(node): node is IdentifierDefined in: types.ts:108
Parameters
| Parameter | Type |
|---|---|
node | any |
Returns
node is Identifier
isPostcssNodeWithChildren()
function isPostcssNodeWithChildren(node): node is PostcssNodeWithChildrenDefined in: types.ts:51
Parameters
| Parameter | Type |
|---|---|
node | any |
Returns
node is PostcssNodeWithChildren
isPseudoNode()
function isPseudoNode(node): node is PseudoDefined in: types.ts:142
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is Pseudo
isSelectorNode()
function isSelectorNode(node): node is SelectorDefined in: types.ts:125
Parameters
| Parameter | Type |
|---|---|
node | any |
Returns
node is Selector
isStringNode()
function isStringNode(node): node is StringDefined in: types.ts:177
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is String
isTagNode()
function isTagNode(node): node is TagDefined in: types.ts:159
Parameters
| Parameter | Type |
|---|---|
node | unknown |
Returns
node is Tag
parse()
function parse(query, __namedParameters): RootDefined in: index.ts:150
Parses a DSS query string into an AST
Handles escaping of forward slashes in specific patterns
Throws an EQUERY SyntaxError on invalid DSS
Parameters
| Parameter | Type |
|---|---|
query | string |
__namedParameters | ParseOptions |
Returns
Root
unescapeDots()
function unescapeDots(query): stringDefined in: index.ts:36
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
string