Expose TimeoutError (#32)

index.d.ts

@@ -1,6 +1,13 @@
 /// <reference lib="esnext"/>
 
+declare class TimeoutErrorClass extends Error {
+	readonly name: 'TimeoutError';
+	constructor(message?: string);
+}
+
 declare namespace pEvent {
+	type TimeoutError = TimeoutErrorClass;
+
 	type AddRemoveListener<EventName extends string | symbol, Arguments extends unknown[]> = (
 		event: EventName,
 		listener: (...arguments: Arguments) => void
@@ -251,6 +258,8 @@ declare const pEvent: {
 
 	// TODO: Remove this for the next major release
 	default: typeof pEvent;
+
+	TimeoutError: typeof TimeoutErrorClass;
 };
 
 export = pEvent;

index.js

@@ -287,3 +287,5 @@ module.exports.iterator = (emitter, event, options) => {
 		}
 	};
 };
+
+module.exports.TimeoutError = pTimeout.TimeoutError;

readme.md

@@ -226,6 +226,24 @@ Default: `[]`
 
 Events that will end the iterator.
 
+### pEvent.TimeoutError
+
+Exposed for instance checking and sub-classing.
+
+Example:
+
+```js
+const pEvent = require('p-event');
+
+try {
+	await pEvent(emitter, 'finish');
+} catch (error) {
+	if (error instanceof pEvent.TimeoutError) {
+		// Do something specific for timeout errors
+	}
+}
+```
+
 ## Before and after
 
 ```js