vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • Reference
  • Type Aliases
  • ParsedSelectorToken
  • PostCSSLeaf
  • PostcssNode
  • PostcssNodeWithChildren
  • Functions
  • asAttributeNode()
  • asCombinatorNode()
  • asCommentNode()
  • asIdentifierNode()
  • asPostcssNodeWithChildren()
  • asPseudoNode()
  • asSelectorNode()
  • asStringNode()
  • asTagNode()
  • escapeDots()
  • escapeScopedNamesSlashes()
  • isAttributeNode()
  • isCombinatorNode()
  • isCommentNode()
  • isIdentifierNode()
  • isPostcssNodeWithChildren()
  • isPseudoNode()
  • isSelectorNode()
  • isStringNode()
  • isTagNode()
  • parse()
  • unescapeDots()
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/dss-parser
  6. /
  7. Reference

Reference

Type Aliases

ParsedSelectorToken

TypeScript
type ParsedSelectorToken = PostcssNode & object;

Defined in: types.ts:47

Type declaration

NameType
tokenstring

PostCSSLeaf

TypeScript
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

TypeScript
type PostcssNode = 
  | Tag
  | String
  | Selector
  | Root
  | Pseudo
  | Nesting
  | Identifier
  | Comment
  | Combinator
  | ClassName
  | Attribute
  | Universal;

Defined in: types.ts:23


PostcssNodeWithChildren

TypeScript
type PostcssNodeWithChildren = Selector | Root | Pseudo;

Defined in: types.ts:45

Functions

asAttributeNode()

TypeScript
function asAttributeNode(node?): Attribute

Defined in: types.ts:77

Parameters

ParameterType
node?PostcssNode

Returns

Attribute


asCombinatorNode()

TypeScript
function asCombinatorNode(node?): Combinator

Defined in: types.ts:94

Parameters

ParameterType
node?PostcssNode

Returns

Combinator


asCommentNode()

TypeScript
function asCommentNode(node?): Comment

Defined in: types.ts:198

Parameters

ParameterType
node?PostcssNode

Returns

Comment


asIdentifierNode()

TypeScript
function asIdentifierNode(node?): Identifier

Defined in: types.ts:111

Parameters

ParameterType
node?PostcssNode

Returns

Identifier


asPostcssNodeWithChildren()

TypeScript
function asPostcssNodeWithChildren(node?): PostcssNodeWithChildren

Defined in: types.ts:56

Parameters

ParameterType
node?PostcssNode

Returns

PostcssNodeWithChildren


asPseudoNode()

TypeScript
function asPseudoNode(node?): Pseudo

Defined in: types.ts:145

Parameters

ParameterType
node?PostcssNode

Returns

Pseudo


asSelectorNode()

TypeScript
function asSelectorNode(node?): Selector

Defined in: types.ts:128

Parameters

ParameterType
node?PostcssNode

Returns

Selector


asStringNode()

TypeScript
function asStringNode(node?): String

Defined in: types.ts:180

Parameters

ParameterType
node?PostcssNode

Returns

String


asTagNode()

TypeScript
function asTagNode(node?): Tag

Defined in: types.ts:162

Parameters

ParameterType
node?PostcssNode

Returns

Tag


escapeDots()

TypeScript
function escapeDots(query): string

Defined in: index.ts:24

Parameters

ParameterType
querystring

Returns

string


escapeScopedNamesSlashes()

TypeScript
function escapeScopedNamesSlashes(query): string

Defined in: index.ts:18

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

ParameterType
querystring

Returns

string


isAttributeNode()

TypeScript
function isAttributeNode(node): node is Attribute

Defined in: types.ts:74

Parameters

ParameterType
nodeunknown

Returns

node is Attribute


isCombinatorNode()

TypeScript
function isCombinatorNode(node): node is Combinator

Defined in: types.ts:91

Parameters

ParameterType
nodeunknown

Returns

node is Combinator


isCommentNode()

TypeScript
function isCommentNode(node): node is Comment

Defined in: types.ts:195

Parameters

ParameterType
nodeunknown

Returns

node is Comment


isIdentifierNode()

TypeScript
function isIdentifierNode(node): node is Identifier

Defined in: types.ts:108

Parameters

ParameterType
nodeany

Returns

node is Identifier


isPostcssNodeWithChildren()

TypeScript
function isPostcssNodeWithChildren(node): node is PostcssNodeWithChildren

Defined in: types.ts:51

Parameters

ParameterType
nodeany

Returns

node is PostcssNodeWithChildren


isPseudoNode()

TypeScript
function isPseudoNode(node): node is Pseudo

Defined in: types.ts:142

Parameters

ParameterType
nodeunknown

Returns

node is Pseudo


isSelectorNode()

TypeScript
function isSelectorNode(node): node is Selector

Defined in: types.ts:125

Parameters

ParameterType
nodeany

Returns

node is Selector


isStringNode()

TypeScript
function isStringNode(node): node is String

Defined in: types.ts:177

Parameters

ParameterType
nodeunknown

Returns

node is String


isTagNode()

TypeScript
function isTagNode(node): node is Tag

Defined in: types.ts:159

Parameters

ParameterType
nodeunknown

Returns

node is Tag


parse()

TypeScript
function parse(query): Root

Defined in: index.ts:49

Parses a CSS selector string into an AST Handles escaping of forward slashes in specific patterns

Parameters

ParameterType
querystring

Returns

Root


unescapeDots()

TypeScript
function unescapeDots(query): string

Defined in: index.ts:27

Parameters

ParameterType
querystring

Returns

string


Previous@vltpkg/dss-parserNext@vltpkg/error-cause

On this page

  • Type Aliases
  • ParsedSelectorToken
  • PostCSSLeaf
  • PostcssNode
  • PostcssNodeWithChildren
  • Functions
  • asAttributeNode()
  • asCombinatorNode()
  • asCommentNode()
  • asIdentifierNode()
  • asPostcssNodeWithChildren()
  • asPseudoNode()
  • asSelectorNode()
  • asStringNode()
  • asTagNode()
  • escapeDots()
  • escapeScopedNamesSlashes()
  • isAttributeNode()
  • isCombinatorNode()
  • isCommentNode()
  • isIdentifierNode()
  • isPostcssNodeWithChildren()
  • isPseudoNode()
  • isSelectorNode()
  • isStringNode()
  • isTagNode()
  • parse()
  • unescapeDots()

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now