Skip to content

Variable: CSSDOC_STRUCTURE_REF ​

ts
const CSSDOC_STRUCTURE_REF: Regex<"(?<ref>[A-Za-z_][\\w-]*(?:\\.[A-Za-z_][\\w-]*)*)(?::(?<type>[\\w-]+))?", {
  flags: "u";
  names: {
     ref: string;
     type?: string;
  };
}>;

Defined in: packages/regex/src/tiers/css-doc-grammar.ts:153

CssDoc Structure Reference from grammar. Reference to a structure record or member in doc comments. Can be qualified (dots for nesting) and optionally typed.

Example ​

ts
CSSDOC_STRUCTURE_REF.exec("button")?.groups?.ref // "button"
CSSDOC_STRUCTURE_REF.exec("menu.item:submenu")?.groups?.ref // "menu.item"
CSSDOC_STRUCTURE_REF.exec("menu.item:submenu")?.groups?.type // "submenu"

Released under the MIT License