Skip to content

Commit 5c4a263

Browse files
committedFeb 17, 2020
Require Node.js 10
1 parent e17687a commit 5c4a263

File tree

4 files changed

+13
-20
lines changed

4 files changed

+13
-20
lines changed
 

‎.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
language: node_js
22
node_js:
3+
- '12'
34
- '10'
4-
- '8'

‎license

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
3+
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

‎package.json

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
{
22
"name": "gh-got",
33
"version": "8.1.0",
4-
"description": "Convenience wrapper for `got` to interact with the GitHub API",
4+
"description": "Convenience wrapper for Got to interact with the GitHub API",
55
"license": "MIT",
66
"repository": "sindresorhus/gh-got",
7+
"funding": "https://github.com/sindresorhus/got?sponsor=1",
78
"author": {
89
"name": "Sindre Sorhus",
910
"email": "sindresorhus@gmail.com",
1011
"url": "https://sindresorhus.com"
1112
},
1213
"engines": {
13-
"node": ">=8"
14+
"node": ">=10"
1415
},
1516
"scripts": {
1617
"test": "xo && ava"
@@ -28,8 +29,6 @@
2829
"https",
2930
"get",
3031
"url",
31-
"uri",
32-
"util",
3332
"utility"
3433
],
3534
"dependencies": {
@@ -38,7 +37,7 @@
3837
"devDependencies": {
3938
"ava": "^3.0.2",
4039
"get-stream": "^5.1.0",
41-
"nock": "^11.7.2",
42-
"xo": "^0.25.3"
40+
"nock": "^12.0.0",
41+
"xo": "^0.26.1"
4342
}
4443
}

‎readme.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# gh-got [![Build Status](https://travis-ci.org/sindresorhus/gh-got.svg?branch=master)](https://travis-ci.org/sindresorhus/gh-got)
22

3-
> Convenience wrapper for [`got`](https://github.com/sindresorhus/got) to interact with the [GitHub API](https://developer.github.com/v3/)
4-
3+
> Convenience wrapper for [Got](https://github.com/sindresorhus/got) to interact with the [GitHub API](https://developer.github.com/v3/)
54
65
## Install
76

87
```
98
$ npm install gh-got
109
```
1110

12-
1311
## Usage
1412

1513
Instead of:
@@ -58,10 +56,9 @@ const ghGot = require('gh-got');
5856
})();
5957
```
6058

61-
6259
## API
6360

64-
Same API as [`got`](https://github.com/sindresorhus/got), including the stream API and aliases, but with some additional options below.
61+
Same API as [`got`](https://github.com/sindresorhus/got), including options, the stream API, aliases, pagination, etc, but with some additional options below.
6562

6663
Errors are improved by using the custom GitHub error messages. Doesn't apply to the stream API.
6764

@@ -77,7 +74,7 @@ Can be set globally with the `GITHUB_TOKEN` environment variable.
7774

7875
#### prefixUrl
7976

80-
Type: `string`<br>
77+
Type: `string`\
8178
Default: `https://api.github.com/`
8279

8380
To support [GitHub Enterprise](https://enterprise.github.com).
@@ -86,11 +83,10 @@ Can be set globally with the `GITHUB_ENDPOINT` environment variable.
8683

8784
#### body
8885

89-
Type: `Object`
86+
Type: `object`
9087

9188
Can be specified as a plain object and will be serialized as JSON with the appropriate headers set.
9289

93-
9490
## Rate limit
9591

9692
Responses and errors have a `.rateLimit` property with info about the current [rate limit](https://developer.github.com/v3/#rate-limiting). *(This is not yet implemented for the stream API)*
@@ -106,7 +102,6 @@ const ghGot = require('gh-got');
106102
})();
107103
```
108104

109-
110105
## Authorization
111106

112107
Authorization for GitHub uses the following logic:
@@ -133,7 +128,6 @@ const ghGot = require(`gh-got`);
133128
})();
134129
```
135130

131+
## Pagination
136132

137-
## License
138-
139-
MIT © [Sindre Sorhus](https://sindresorhus.com)
133+
See the [Got docs](https://github.com/sindresorhus/got#pagination).

0 commit comments

Comments
 (0)
Please sign in to comment.