From 56e5aa3f75f83a47640fce732ac1d5ca8e131d36 Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Sun, 3 Nov 2019 18:04:02 -0300 Subject: [PATCH] feat(TypeScript): harmonize definitions by using @octokit/types (#17) --- package-lock.json | 15 +++++++++++++++ package.json | 1 + src/index.ts | 3 ++- src/types.ts | 41 +---------------------------------------- 4 files changed, 19 insertions(+), 41 deletions(-) diff --git a/package-lock.json b/package-lock.json index a722c6e..f45923e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1275,6 +1275,21 @@ "url-template": "^2.0.8" } }, + "@octokit/types": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.0.0.tgz", + "integrity": "sha512-467rp1g6YuxuNbu1m3A5BuGWxtzyVE8sAyN9+k3kb2LdnpmLPTiPsywbYmcckgfGZ+/AGpAaNrVx7131iSUXbQ==", + "requires": { + "@types/node": "^12.11.1" + }, + "dependencies": { + "@types/node": { + "version": "12.12.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.5.tgz", + "integrity": "sha512-KEjODidV4XYUlJBF3XdjSH5FWoMCtO0utnhtdLf1AgeuZLOrRbvmU/gaRCVg7ZaQDjVf3l84egiY0mRNe5xE4A==" + } + } + }, "@pika/babel-plugin-esm-import-rewrite": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/@pika/babel-plugin-esm-import-rewrite/-/babel-plugin-esm-import-rewrite-0.6.1.tgz", diff --git a/package.json b/package.json index 5f00fa4..19a8726 100644 --- a/package.json +++ b/package.json @@ -29,6 +29,7 @@ }, "homepage": "https://github.com/octokit/request-error.js#readme", "dependencies": { + "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" }, diff --git a/src/index.ts b/src/index.ts index a60c15a..2d6a315 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,7 +2,8 @@ import { Deprecation } from "deprecation"; import once from "once"; const logOnce = once((deprecation: any) => console.warn(deprecation)); -import { RequestOptions, ResponseHeaders, RequestErrorOptions } from "./types"; +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +import { RequestErrorOptions } from "./types"; /** * Error with extra properties to help with debugging diff --git a/src/types.ts b/src/types.ts index 0848498..709e8ff 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1,43 +1,4 @@ -/** - * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` - */ -export type Url = string; - -/** - * Request method - */ -export type Method = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"; - -export type RequestHeaders = { - /** - * Used for API previews and custom formats - */ - accept?: string; - /** - * Redacted authorization header - */ - authorization?: string; - - "user-agent"?: string; - - [header: string]: string | number | undefined; -}; - -export type ResponseHeaders = { - [header: string]: string; -}; - -export type EndpointRequestOptions = { - [option: string]: any; -}; - -export type RequestOptions = { - method: Method; - url: Url; - headers: RequestHeaders; - body?: any; - request?: EndpointRequestOptions; -}; +import { RequestOptions, ResponseHeaders } from "@octokit/types"; export type RequestErrorOptions = { headers: ResponseHeaders;