export new error helpers and types

Author: justjake

src/errors.ts

@@ -27,7 +27,7 @@ export enum ClientErrorCode {
 }
 
 /**
- * Error codes on errors thrown by the [[Client]].
+ * Error codes on errors thrown by the `Client`.
  */
 export type NotionErrorCode = APIErrorCode | ClientErrorCode
 
@@ -82,6 +82,9 @@ export function isNotionClientErrorWithCode<Code extends NotionErrorCode>(
   return isNotionClientError(error) && error.code in codes
 }
 
+/**
+ * Error thrown by the client if a request times out.
+ */
 export class RequestTimeoutError extends NotionClientErrorBase<ClientErrorCode.RequestTimeout> {
   readonly code = ClientErrorCode.RequestTimeout
   readonly name = "RequestTimeoutError"
@@ -150,6 +153,7 @@ export function isHTTPResponseError(
     UnknownHTTPResponseError | APIResponseError,
     typeof error
   >
+
   return true
 }
 

src/index.ts

@@ -1,8 +1,16 @@
 export { default as Client } from "./Client"
 export { LogLevel, Logger } from "./logging"
 export {
+  // Error codes
+  NotionErrorCode,
   APIErrorCode,
+  ClientErrorCode,
+  // Error types
+  NotionClientError,
   APIResponseError,
-  HTTPResponseError,
+  UnknownHTTPResponseError,
   RequestTimeoutError,
+  // Error helpers
+  isNotionClientError,
+  isNotionClientErrorWithCode,
 } from "./errors"

tsconfig.json

@@ -29,7 +29,7 @@
     "resolveJsonModule": true,
 
     // Linter style rules
-    "noUnusedLocals": true,
+    "noUnusedLocals": false, // Disabled because we use eslint for this.
     "noUnusedParameters": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,