Skip to content
Merged
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion lib/node_modules/@stdlib/_tools/github/get/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ function onResponse( error, data, info ) {

To [authenticate][github-oauth2] with an endpoint, set the [`token`][github-token] option.

<!-- eslint-disable @cspell/spellchecker -->

```javascript
var opts = {
'token': 'tkjorjk34ek3nj4!'
Expand Down Expand Up @@ -223,6 +225,8 @@ function onResponse( error, data, info ) {

Returns a `function` which can be repeatedly invoked to retrieve resources from a [GitHub API][github-api] endpoint.

<!-- eslint-disable @cspell/spellchecker -->

```javascript
function onResponse( error, data, info ) {
// Check for rate limit info...
Expand Down Expand Up @@ -289,6 +293,8 @@ The method accepts the same `options` as [`get()`](#get) above.

## Examples

<!-- eslint-disable @cspell/spellchecker -->

<!-- eslint no-undef: "error" -->

```javascript
Expand Down Expand Up @@ -357,7 +363,7 @@ Options:
--page page Resource page. Default: 1.
--last_page page Last resource page to resolve. Default: 1.
--per_page size Page size. Default: 100.
--qs, --query qs Params portion of a query string.
--qs, --query qs Params portion of a query string.
```

</section>
Expand Down