Skip to content

Commit

Permalink
docs(README): replace usage with link to generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gr2m committed Oct 24, 2019
1 parent bb08740 commit 4237f9d
Showing 1 changed file with 1 addition and 20 deletions.
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,7 @@

## Usage

```js
import { Endpoint, OctokitResponse, RequestParameters, Route } from "@octokit/types"

interface myRequestDecorater {
/**
* Sends a request based on endpoint options
*
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<T = any>(options: Endpoint): Promise<OctokitResponse<T>>;

/**
* Sends a request based on endpoint options
*
* @param {string} route Request method + URL. Example: `'GET /orgs/:org'`
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
*/
<T = any>(route: Route, parameters?: RequestParameters): Promise<OctokitResponse<T>>;
}
```
See https://octokit.github.io/types.ts for all exported types

## Contributing

Expand Down

0 comments on commit 4237f9d

Please sign in to comment.