@octokit/types
Advanced tools
@@ -9,3 +9,3 @@ import type { RequestHeaders } from "./RequestHeaders.js"; | ||
| */ | ||
| export type EndpointDefaults = RequestParameters & { | ||
| export interface EndpointDefaults extends RequestParameters { | ||
| baseUrl: Url; | ||
@@ -22,2 +22,2 @@ method: RequestMethod; | ||
| }; | ||
| }; | ||
| } |
@@ -5,3 +5,3 @@ import type { EndpointDefaults } from "./EndpointDefaults.js"; | ||
| import type { Route } from "./Route.js"; | ||
| import type { Endpoints } from "./generated/Endpoints.js"; | ||
| import type { EndpointKeys, Endpoints } from "./generated/Endpoints.js"; | ||
| export interface EndpointInterface<D extends object = object> { | ||
@@ -26,3 +26,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>; | ||
| <R extends Route, P extends RequestParameters = R extends EndpointKeys ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: EndpointKeys | R, parameters?: P): (R extends EndpointKeys ? Endpoints[R]["request"] : RequestOptions) & Pick<P, keyof RequestOptions>; | ||
| /** | ||
@@ -45,3 +45,3 @@ * Object with current default route and parameters | ||
| */ | ||
| <R extends Route, P extends RequestParameters = R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; | ||
| <R extends Route, P extends RequestParameters = R extends EndpointKeys ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters>(route: EndpointKeys | R, parameters?: P): D & (R extends EndpointKeys ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; | ||
| /** | ||
@@ -48,0 +48,0 @@ * Merges current endpoint defaults with passed route and parameters, |
| import type { RequestMethod } from "./RequestMethod.js"; | ||
| import type { Url } from "./Url.js"; | ||
| import type { RequestParameters } from "./RequestParameters.js"; | ||
| export type EndpointOptions = RequestParameters & { | ||
| export interface EndpointOptions extends RequestParameters { | ||
| method: RequestMethod; | ||
| url: Url; | ||
| }; | ||
| } |
@@ -5,3 +5,3 @@ import type { EndpointInterface } from "./EndpointInterface.js"; | ||
| import type { Route } from "./Route.js"; | ||
| import type { Endpoints } from "./generated/Endpoints.js"; | ||
| import type { EndpointKeys, Endpoints } from "./generated/Endpoints.js"; | ||
| export interface RequestInterface<D extends object = object> { | ||
@@ -26,3 +26,3 @@ /** | ||
| */ | ||
| <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>>; | ||
| <R extends Route>(route: EndpointKeys | R, options?: R extends EndpointKeys ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends EndpointKeys ? Promise<Endpoints[R]["response"]> : Promise<OctokitResponse<any>>; | ||
| /** | ||
@@ -29,0 +29,0 @@ * Returns a new `request` with updated route and parameters |
@@ -1,1 +0,1 @@ | ||
| export declare const VERSION = "14.0.0"; | ||
| export declare const VERSION = "14.1.0"; |
+6
-6
| { | ||
| "name": "@octokit/types", | ||
| "version": "14.0.0", | ||
| "version": "14.1.0", | ||
| "publishConfig": { | ||
@@ -10,3 +10,3 @@ "access": "public", | ||
| "dependencies": { | ||
| "@octokit/openapi-types": "^25.0.0" | ||
| "@octokit/openapi-types": "^25.1.0" | ||
| }, | ||
@@ -25,5 +25,5 @@ "repository": "github:octokit/types.ts", | ||
| "@octokit/tsconfig": "^4.0.0", | ||
| "github-openapi-graphql-query": "^4.5.0", | ||
| "github-openapi-graphql-query": "^5.0.0", | ||
| "handlebars": "^4.7.6", | ||
| "npm-run-all2": "^7.0.0", | ||
| "npm-run-all2": "^8.0.0", | ||
| "prettier": "^3.0.0", | ||
@@ -33,7 +33,7 @@ "semantic-release": "^24.0.0", | ||
| "sort-keys": "^5.0.0", | ||
| "typedoc": "^0.26.0", | ||
| "typedoc": "^0.28.0", | ||
| "typescript": "^5.0.0" | ||
| }, | ||
| "octokit": { | ||
| "openapi-version": "19.0.0" | ||
| "openapi-version": "19.1.0" | ||
| }, | ||
@@ -40,0 +40,0 @@ "files": [ |
Sorry, the diff of this file is too big to display
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
264734
0.18%4554
0.18%