Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript for "out" definition incompatible with documentation #8

Open
raijinsetsu opened this issue Sep 19, 2020 · 0 comments
Open

Comments

@raijinsetsu
Copy link

The documentation shows invoking the parse functions with the out parameter like this:

parse(str, {out: Buffer.allocUnsafe});

However, this is incompatible with the typescript definition:

export interface ParseOptions {
    loose?: boolean;
    out?: new (size: number) => {
        [index: number]: number;
    };
}

In my testing, new Buffer.alloc(16) does not throw an exception, so it seems the solution is to update the signature of the type to allow (size: number) => {[index: number]:number;}; as a valid argument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant