Skip to content

Iterator methods crash the document generation #73

@ralf-o

Description

@ralf-o

esdoc version: 0.2.5

Classes with iterator methods (=> Symbol.iterator/@@iterator) crash the documentation generation process:

class MyIterable {
Symbol.iterator { ... }
}

will cause the following error:

TypeError: Cannot call method 'charAt' of undefined
at Object. (./node_modules/esdoc/out/src/Publisher/Builder/DocResolver.js:121:40)
at ./node_modules/esdoc/node_modules/taffydb/taffy.js:743:17
at each (./node_modules/esdoc/node_modules/taffydb/taffy.js:126:17)
at Object.API.extend.that (./node_modules/esdoc/node_modules/taffydb/taffy.js:740:7)
at Object.API.(anonymous function) as update
at DocResolver._resolveAccess (./node_modules/esdoc/out/src/Publisher/Builder/DocResolver.js:119:20)
at DocResolver.resolve (./node_modules/esdoc/out/src/Publisher/Builder/DocResolver.js:51:12)
at CoverageBuilder.DocBuilder (./node_modules/esdoc/out/src/Publisher/Builder/DocBuilder.js:57:42)
at new CoverageBuilder (./node_modules/esdoc/out/src/Publisher/Builder/CoverageBuilder.js:33:81)
at publish (./node_modules/esdoc/out/src/Publisher/publish.js:156:35)

Using "@ignore" as a workaround does not work.
Using flag "autoPrivate=false" works, but in the API documentation the '@@iterator' method is called 'undefined'.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions