search

no2chem / bigint-buffer

💪🔢 bigint-buffer: Buffer Utilities for TC39 BigInt Proposal
Apache License 2.0
54 stars 11 forks source link

Disable typedoc generation for now #4

Closed no2chem closed 6 years ago

no2chem commented 6 years ago

It appears that typedoc generation is currently broken when the bigint type is used:

> bigint-buffer@1.1.0 typedoc /Users/mwei/devel/bigint-buffer
> typedoc --out docs $(pwd)/src $(pwd)/helper --target es6 --mode file --tsconfig ./tsconfig.json --excludePrivate --excludeProtected --excludeNotExported --exclude '**/*+(spec|bench).ts'

Using TypeScript 3.0.3 from /Users/mwei/devel/bigint-buffer/node_modules/typedoc/node_modules/typescript/lib
Error: /Users/mwei/devel/bigint-buffer/src/index.ts(2)
 Cannot find name 'bigint'.
Error: /Users/mwei/devel/bigint-buffer/src/index.ts(24)
 Cannot find name 'bigint'.
Error: /Users/mwei/devel/bigint-buffer/src/index.ts(42)
 Cannot find name 'bigint'.
Error: /Users/mwei/devel/bigint-buffer/src/index.ts(59)
 Cannot find name 'bigint'.
Error: /Users/mwei/devel/bigint-buffer/src/index.ts(77)
 Cannot find name 'bigint'.

For now, disable the use of typedoc.