Skip to content

Commit fd9271c

Browse files
authored
feat(typescript): import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods" (#65)
2 parents 53e3403 + 6c86dfa commit fd9271c

File tree

12 files changed

+12988
-36412
lines changed

12 files changed

+12988
-36412
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,19 @@ octokit.users.getAuthenticated();
5151

5252
There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). All endpoint methods are documented in the [docs/](docs/) folder, e.g. [docs/users/getAuthenticated.md](docs/users/getAuthenticated.md)
5353

54+
## TypeScript
55+
56+
Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
57+
58+
Example
59+
60+
```ts
61+
import { RestEndpointMethodTypes } from "@octokit/rest-endpoint-methods";
62+
63+
type UpdateLabelParameters = RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"];
64+
type UpdateLabelResponse = RestEndpointMethodTypes["issues"]["updateLabel"]["response"];
65+
```
66+
5467
## Contributing
5568

5669
See [CONTRIBUTING.md](CONTRIBUTING.md)

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"author": "Gregor Martynus (https://twitter.com/gr2m)",
2525
"license": "MIT",
2626
"dependencies": {
27-
"@octokit/types": "^2.0.1",
27+
"@octokit/types": "^2.11.1",
2828
"deprecation": "^2.3.1"
2929
},
3030
"devDependencies": {

0 commit comments

Comments
 (0)