@octokit/types
Advanced tools
Comparing version 8.1.0 to 8.1.1
@@ -5,5 +5,5 @@ 'use strict'; | ||
const VERSION = "8.1.0"; | ||
const VERSION = "8.1.1"; | ||
exports.VERSION = VERSION; | ||
//# sourceMappingURL=index.js.map |
@@ -1,1 +0,1 @@ | ||
export const VERSION = "8.1.0"; | ||
export const VERSION = "8.1.1"; |
@@ -20,3 +20,3 @@ import { EndpointOptions } from "./EndpointOptions"; | ||
* | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -28,3 +28,3 @@ <T = any>(request: RequestInterface, options: EndpointOptions): Promise<OctokitResponse<T>>; | ||
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -31,0 +31,0 @@ <T = any>(request: RequestInterface, route: Route, parameters?: RequestParameters): Promise<OctokitResponse<T>>; |
@@ -19,3 +19,4 @@ import { RequestHeaders } from "./RequestHeaders"; | ||
format: string; | ||
previews: string[]; | ||
}; | ||
}; |
@@ -10,3 +10,3 @@ import { EndpointDefaults } from "./EndpointDefaults"; | ||
* | ||
* @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -24,3 +24,3 @@ <O extends RequestParameters = RequestParameters>(options: O & { | ||
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -42,3 +42,3 @@ <R extends Route, P extends RequestParameters = R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick<P, keyof RequestOptions>; | ||
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
* | ||
@@ -51,3 +51,3 @@ */ | ||
* | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -66,5 +66,5 @@ <P extends RequestParameters = RequestParameters>(options: P): EndpointDefaults & D & P; | ||
* | ||
* @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
parse: <O extends EndpointDefaults = EndpointDefaults>(options: O) => RequestOptions & Pick<O, keyof RequestOptions>; | ||
} |
export declare type RequestHeaders = { | ||
/** | ||
* Avoid setting `headers.accept`, use `mediaType.format` option instead. | ||
* Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. | ||
*/ | ||
@@ -5,0 +5,0 @@ accept?: string; |
@@ -10,3 +10,3 @@ import { EndpointInterface } from "./EndpointInterface"; | ||
* | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -24,3 +24,3 @@ <T = any, O extends RequestParameters = RequestParameters>(options: O & { | ||
* @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`. | ||
* @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. | ||
*/ | ||
@@ -27,0 +27,0 @@ <R extends Route>(route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise<Endpoints[R]["response"]> : Promise<OctokitResponse<any>>; |
@@ -26,2 +26,8 @@ import { RequestRequestOptions } from "./RequestRequestOptions"; | ||
format?: string; | ||
/** | ||
* Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. | ||
* Example for single preview: `['squirrel-girl']`. | ||
* Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. | ||
*/ | ||
previews?: string[]; | ||
}; | ||
@@ -28,0 +34,0 @@ /** |
@@ -1,1 +0,1 @@ | ||
export declare const VERSION = "8.1.0"; | ||
export declare const VERSION = "8.1.1"; |
@@ -1,4 +0,4 @@ | ||
const VERSION = "8.1.0"; | ||
const VERSION = "8.1.1"; | ||
export { VERSION }; | ||
//# sourceMappingURL=index.js.map |
{ | ||
"name": "@octokit/types", | ||
"description": "Shared TypeScript definitions for Octokit projects", | ||
"version": "8.1.0", | ||
"version": "8.1.1", | ||
"license": "MIT", | ||
@@ -44,3 +44,3 @@ "files": [ | ||
"prettier": "^2.0.0", | ||
"semantic-release": "^19.0.3", | ||
"semantic-release": "^20.0.0", | ||
"semantic-release-plugin-update-version-in-files": "^1.0.0", | ||
@@ -47,0 +47,0 @@ "sort-keys": "^5.0.0", |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
221704
3911