@octokit/types - npm Package Compare versions

Comparing version 8.0.0 to 8.1.0

dist-node/index.js

@@ -5,5 +5,5 @@ 'use strict';
 
-const VERSION = "8.0.0";
+const VERSION = "8.1.0";
 
 exports.VERSION = VERSION;
 //# sourceMappingURL=index.js.map

dist-src/VERSION.js

@@ -1,1 +0,1 @@
-export const VERSION = "8.0.0";
+export const VERSION = "8.1.0";

dist-types/AuthInterface.d.ts

@@ -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|previews}`, `request`, or `baseUrl`.
+         * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `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|previews}`, `request`, or `baseUrl`.
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
          */
@@ -31,0 +31,0 @@ <T = any>(request: RequestInterface, route: Route, parameters?: RequestParameters): Promise<OctokitResponse<T>>;

dist-types/EndpointDefaults.d.ts

@@ -19,4 +19,3 @@ import { RequestHeaders } from "./RequestHeaders";
         format: string;
-        previews: string[];
     };
 };

dist-types/EndpointInterface.d.ts

@@ -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|previews}`, `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`, `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|previews}`, `request`, or `baseUrl`.
+     * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `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|previews}`, `request`, or `baseUrl`.
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `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|previews}`, `request`, or `baseUrl`.
+         * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `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|previews}`, `request`, or `baseUrl`.
+     * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
      */
     parse: <O extends EndpointDefaults = EndpointDefaults>(options: O) => RequestOptions & Pick<O, keyof RequestOptions>;
 }

dist-types/RequestHeaders.d.ts

 export declare type RequestHeaders = {
     /**
-     * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead.
+     * Avoid setting `headers.accept`, use `mediaType.format` option instead.
      */
@@ -5,0 +5,0 @@ accept?: string;

dist-types/RequestInterface.d.ts

@@ -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|previews}`, `request`, or `baseUrl`.
+     * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `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|previews}`, `request`, or `baseUrl`.
+     * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `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>>;

dist-types/RequestParameters.d.ts

@@ -26,8 +26,2 @@ 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[];
     };
@@ -34,0 +28,0 @@ /**

dist-types/VERSION.d.ts

@@ -1,1 +0,1 @@
-export declare const VERSION = "8.0.0";
+export declare const VERSION = "8.1.0";

dist-web/index.js

@@ -1,4 +0,4 @@
-const VERSION = "8.0.0";
+const VERSION = "8.1.0";
 
 export { VERSION };
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@octokit/types",
   "description": "Shared TypeScript definitions for Octokit projects",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "license": "MIT",
@@ -46,3 +46,3 @@ "files": [
     "semantic-release-plugin-update-version-in-files": "^1.0.0",
-    "sort-keys": "^4.2.0",
+    "sort-keys": "^5.0.0",
     "string-to-jsdoc-comment": "^1.0.0",
@@ -49,0 +49,0 @@ "typedoc": "^0.23.0",

No alert changes

Worsened metrics

Total package byte prevSize

221072

decreased by-0.29%

Lines of code

3899

decreased by-0.31%

No dependency changes