Skip to content

Add TypeScript definitions with JSDoc #7335

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

Closed
wants to merge 5 commits into from
Closed

Add TypeScript definitions with JSDoc #7335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f64ae4
add typescript
mtrezza Apr 10, 2021
ae48ce0
refactored OAuth1Client to fix typescript error
mtrezza Apr 10, 2021
c0aa6ea
fix lint
mtrezza Apr 11, 2021
17e9866
add types
mtrezza Apr 11, 2021
7ee49b7
added types to gitignore
mtrezza Apr 11, 2021
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,6 @@ lib/

# Redis Dump
dump.rdb

# Ignore built TypeScript files
types/**/*
40 changes: 37 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,14 @@
"jsdoc-babel": "0.5.0",
"lint-staged": "10.2.3",
"madge": "4.0.2",
"mock-mail-adapter": "file:spec/dependencies/mock-mail-adapter",
"mock-files-adapter": "file:spec/dependencies/mock-files-adapter",
"mock-mail-adapter": "file:spec/dependencies/mock-mail-adapter",
"mongodb-runner": "4.8.1",
"mongodb-version-list": "1.0.0",
"node-fetch": "2.6.1",
"nyc": "15.1.0",
"prettier": "2.0.5",
"typescript": "4.2.4",
"yaml": "1.10.0"
},
"scripts": {
Expand All @@ -124,7 +125,9 @@
"prettier": "prettier --write '{src,spec}/{**/*,*}.js'",
"prepare": "npm run build",
"postinstall": "node -p 'require(\"./postinstall.js\")()'",
"madge:circular": "node_modules/.bin/madge ./src --circular"
"madge:circular": "node_modules/.bin/madge ./src --circular",
"pretypes": "npm run build",
"types": "npx typescript"
},
"engines": {
"node": ">= 8"
Expand Down Expand Up @@ -155,5 +158,6 @@
"eslint --fix --cache",
"git add"
]
}
},
"types": "./types/index.d.ts"
}
Loading