jsdoc-inline-lex

1.0.1 • Public • Published

lex

Lex tokens out of a string input that represents some JSDoc-embedded text.

name description
text input text.

Examples

var result = lex('See {@link MyClass}.');
// returns
result = [
  {
    "type": "text",
    "capture": [
      " See "
    ]
  },
  {
    "type": "link",
    "capture": [
      "{@link MyClass}",
      "MyClass"
    ]
  },
  {
    "type": "text",
    "capture": [
      ".\n"
    ]
  }
];

Returns array of lexed tokens.

/jsdoc-inline-lex/

    Package Sidebar

    Install

    npm i jsdoc-inline-lex

    Weekly Downloads

    298

    Version

    1.0.1

    License

    ISC

    Last publish

    Collaborators

    • tmcw