Skip to content

Commit

Permalink
feat: Add Typescript definitions (#184)
Browse files Browse the repository at this point in the history
* feat: add Typescript definitions

Co-authored-by: Filip Skokan <panva.ip@gmail.com>
  • Loading branch information
theogravity and panva committed Sep 9, 2019
1 parent 9e69145 commit c37130b
Show file tree
Hide file tree
Showing 7 changed files with 950 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ jobs:
node-version: 12
- run: npm install
- run: npm run lint
- run: npx dtslint --onlyTestTsNext types

test:
name: Node Tests + Coverage
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,8 @@ standard Node.js OpenSSL.

#### Semver?

**Yes.** Everything that's [documented][documentation] is subject to
**Yes.** Everything that's either exported in the TypeScript definitions file or
[documented][documentation] is subject to
[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html). The rest is to be considered
private API and is subject to change between any versions.

Expand All @@ -268,6 +269,7 @@ results.
- Added support for any additional token exchange parameters to support specifications such as
Resource Indicators
- Typed [errors][documentation-errors]
- TypeScript definitions

#### How to make the client send client_id and client_secret in the body?

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@
"license": "MIT",
"author": "Filip Skokan <panva.ip@gmail.com>",
"files": [
"lib"
"lib",
"types/index.d.ts"
],
"main": "lib/index.js",
"types": "types/index.d.ts",
"scripts": {
"coverage": "nyc mocha",
"lint": "eslint lib test",
Expand All @@ -50,6 +52,7 @@
"devDependencies": {
"@commitlint/cli": "^8.1.0",
"@commitlint/config-conventional": "^8.1.0",
"@types/got": "^9.6.7",
"chai": "^4.2.0",
"eslint": "^6.2.2",
"eslint-config-airbnb-base": "^14.0.0",
Expand Down
Loading

0 comments on commit c37130b

Please sign in to comment.