Thanks for your answer.

I should have elaborated a bit more. I'm talking about literal, in-place or anonymous enums without any reference to existing type. I don't know the name for this 🤣. But I know that some other tools support it. It's really convenient for simple one place enums.

This currently crashes:

/**
 * @param {('pre'|'post')} [order='pre'] Traversal mode
 * or
 * @param {'pre'|'post'} [order='pre'] Traversal mode
 */

Output

> documentation build lib/*.js --format md --output docs/api.md

/Users/ngryman/Projects/arbre/node_modules/documentation/lib/commands/build.js:67
      throw err;
      ^

Error: Unknown type StringLiteralType
    at formatType (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/util/format_type.js:174:11)
    at commaList (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/util/format_type.js:60:22)
    at formatType (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/util/format_type.js:125:12)
    at formatType (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/util/format_type.js:166:30)
    at /Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/markdown_ast.js:48:41
    at Array.map (native)
    at paramList (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/markdown_ast.js:43:51)
    at paramSection (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/markdown_ast.js:66:9)
    at generate (/Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/markdown_ast.js:175:13)
    at /Users/ngryman/Projects/arbre/node_modules/documentation/lib/output/markdown_ast.js:194:26

This works by misinterpreting pre and post as types:

/**
 * @param {pre|post} [order='pre'] Traversal mode
 */

EDIT: I edited the title to try to be more precise.

Support literal enum of strings #662

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions