index.d.ts not up to date for .load (missing isDocument)

[MeStrak]

Hello there,

I'm using Typescript with v1.0rc-10, and I was trying to use .load with the isDocument parameter documented here: https://cheerio.js.org/interfaces/CheerioAPI.html. I found something weird with index.d.ts.

This is my code:

private cheerioBody = cheerio.load(myHtml, null, false);

I get the following type error Expected 1-2 arguments, but got 3. I noticed the same problem reported here but the issue was closed: #1697.

I checked index.d.ts from the installed npm package and it looks like the isDocument parameter is missing:

interface CheerioAPI extends Root {
        version: string;
        load(html: string | Buffer, options?: CheerioParserOptions): Root;
        load(element: Element | Element[], options?: CheerioParserOptions): Root;
    }

I assume that it should contain isDocument as an optional (even thought it is not currently defined as optional in the code) like below:

interface CheerioAPI extends Root {
        version: string;
        load(html: string | Buffer, options?: CheerioParserOptions, isDocument?: boolean): Root;
        load(element: Element | Element[], options?: CheerioParserOptions, isDocument?: boolean): Root;
    }

The source load,ts does contain this parameter (although not as optional), so I'm not sure why it does not appear in index.d.ts:

cheerio/src/load.ts

Line 95 in 6f664b6

isDocument = true

.

[fb55]

Is this the index.d.ts from @types/cheerio? If that's the case: That module isn't required anymore, as Cheerio ships with TypeScript types itself now.

[MeStrak]

You're right 😃

I hadn't noticed that @types was still left in devDependencies from an upgrade a while back.

Thanks for the tip!