Skip to content

Add typescript definitions #9

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.

Sign up for GitHub

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

Open
orgads wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add typescript definitions #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Schema } from "mongoose";
declare namespace wrapCallback {
Copy link
Copy Markdown
Member

@vkarpov15 vkarpov15 May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this declare namespace call about? Shouldn't we just have interface WrapCallbackOptions {} and just use that? And export default function wrapCallback()?

Copy link
Copy Markdown
Contributor Author

@orgads orgads May 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why, but without the namespace I get the following error.

test.ts:1:31 - error TS2497: This module can only be referenced with ECMAScript imports/exports by turning on the 'esModuleInterop' flag and referencing its default export.

1 import * as wrapCallback from '.';

test.ts is:

import * as wrapCallback from '.';

wrapCallback({} as any);

interface Options {
mode?: 'scope' | 'emit';
}
}
declare function wrapCallback(schema: Schema, options?: wrapCallback.Options): void;

export = wrapCallback;
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"version": "0.0.4",
"description": "Mongoose plugin providing experimental support for Node.js `async_hooks`",
"main": "index.js",
"types": "index.d.ts",
"scripts": {
"docs": "acquit-markdown -r acquit-ignore -p './test/example.test.js' -h './HEADER.md' > README.md",
"test": "mocha test/*.js"
Expand Down