| \nBrowsers\n | \nLoad @octokit-next/endpoint directly from cdn.skypack.dev\n \n```html\n\n```\n\n |
|---|---|
| \nNode\n | \n\nInstall with npm install @octokit-next/endpoint\n\n```js\nimport { endpoint } from \"@octokit-next/endpoint\";\n```\n\n |
| \nDeno\n | \n\nLoad @octokit-next/endpoint directly from cdn.skypack.dev, including types.\n\n```js\nimport { endpoint } from \"https://cdn.skypack.dev/@octokit-next/endpoint?dts\";\n```\n\n |
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n route\n | \n \n String\n | \n\n If set, it has to be a string consisting of URL and the request method, e.g., GET /orgs/{org}. If it’s set to a URL, only the method defaults to GET.\n | \n
\n options.method\n | \n \n String\n | \n\n Required unless route is set. Any supported http verb. Defaults to GET.\n | \n
\n options.url\n | \n \n String\n | \n\n Required unless route is set. A path or full URL which may contain :variable or {variable} placeholders,\n e.g., /orgs/{org}/repos.\n | \n
\n options.baseUrl\n | \n \n String\n | \n\n Defaults to https://api.github.com.\n | \n
\n options.headers\n | \n \n Object\n | \n\n Custom headers. Passed headers are merged with defaults: \n headers['user-agent'] defaults to octokit-endpoint.js/1.2.3 (where 1.2.3 is the released version).\n headers['accept'] defaults to application/vnd.github.v3+json.\n | \n
\n options.mediaType.format\n | \n \n String\n | \n\n Media type param, such as raw, diff, or text+json. See Media Types. Setting options.mediaType.format will amend the headers.accept value.\n | \n
\n options.mediaType.previews\n | \n \n Array of Strings\n | \n\n Name of previews, such as mercy, symmetra, or scarlet-witch. See API Previews. If options.mediaType.previews was set as default, the new previews will be merged into the default ones. Setting options.mediaType.previews will amend the headers.accept value. options.mediaType.previews will be merged with an existing array set using .withDefaults().\n | \n
\n options.data\n | \n \n Any\n | \n\n Set request body directly instead of setting it to JSON based on additional parameters. See \"The data parameter\" below.\n | \n
\n options.request\n | \n \n Object\n | \n\n Pass custom meta information for the request. The request object will be returned as is.\n | \n
| \n key\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
method | \n String | \nThe http method. Always lowercase. | \n
url | \n String | \nThe url with placeholders replaced with passed parameters. | \n
headers | \n Object | \nAll header names are lowercased. | \n
body | \n Any | \nThe request body if one is present. Only for PATCH, POST, PUT, DELETE requests. | \n
request | \n Object | \nRequest meta option, it will be returned as it was passed into endpoint() | \n