jsdoc-inline-lex v1.0.1

lex

Lex tokens out of a string input that represents some JSDoc-embedded 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.