Skip to content

Typescript #10

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
cojmeister wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Typescript #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f951b3c
Wrote Function Types
cojmeister Nov 23, 2022
5632383
Added documentation
cojmeister Nov 23, 2022
596ffcf
Added jsdoc
cojmeister Nov 23, 2022
ae28508
Merge pull request #1 from cojmeister/feature/documentation
cojmeister Nov 23, 2022
2f4b44a
Merge pull request #2 from cojmeister/feature/typescript
cojmeister Nov 26, 2022
252e735
1.3.0
cojmeister Nov 26, 2022
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
package-lock.json
.DS_Store
jsdoc/
520 changes: 318 additions & 202 deletions index.js
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions jsdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"plugins": ["plugins/markdown"],
"recurseDepth": 10,
"source": {
"include": ["./"],
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"templates": {
"cleverLinks": true,
"monospaceLinks": true
},
"opts": {
"destination": "./jsdoc",
"recurse": true,
"readme": "./readme.md"
}
}
18 changes: 15 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"name": "node-zstandard",
"version": "1.2.4",
"version": "1.3.0",
"description": "Node.js interface to Zstandard (zstd)",
"main": "index.js",
"types": "./types/index.d.ts",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1",
"jsdoc": "jsdoc -c jsdoc.json"
},
"repository": {
"type": "git",
Expand All @@ -19,5 +21,15 @@
"bugs": {
"url": "https://github.com/albertdb/node-zstandard/issues"
},
"homepage": "https://github.com/albertdb/node-zstandard#readme"
"homepage": "https://github.com/albertdb/node-zstandard#readme",
"devDependencies": {
"@types/node": "^18.11.9",
"jsdoc": "^4.0.0",
"typescript": "^4.9.3"
},
"files": [
"./index.js",
"./types/*",
"./bin/*"
]
}
Loading