Skip to content

Commit ce7a399

Browse files
committed
improve docs
tune typedoc so that the types are fully exported
1 parent 853b073 commit ce7a399

File tree

3 files changed

+31
-30
lines changed

3 files changed

+31
-30
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
# `functions-js`
22

33
JS Client library to interact with Supabase Functions.
4+
5+
## Docs
6+
https://supabase.github.io/functions-js/index.html

package-lock.json

Lines changed: 25 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
"build": "run-s clean format build:*",
1313
"build:main": "tsc -p tsconfig.json",
1414
"build:module": "tsc -p tsconfig.module.json",
15-
"docs": "typedoc src/index.ts",
16-
"docs:json": "typedoc --json docs/spec.json --excludeExternals src/index.ts",
15+
"docs": "typedoc src/index.ts src/types.ts --excludePrivate --excludeProtected",
16+
"docs:json": "typedoc --json docs/spec.json --excludeExternals src/index.ts src/types.ts",
1717
"test": "echo \"Error: no test specified\" && exit 1"
1818
},
1919
"repository": {
@@ -43,7 +43,7 @@
4343
"rimraf": "^3.0.2",
4444
"semantic-release": "^19.0.2",
4545
"semantic-release-plugin-update-version-in-files": "^1.1.0",
46-
"typedoc": "^0.22.13",
46+
"typedoc": "^0.23.10",
4747
"typescript": "^4.6.2"
4848
},
4949
"publishConfig": {

0 commit comments

Comments
 (0)