Add includeUnverified option to breachedAccount function

API.md

@@ -160,6 +160,7 @@ an Error
 | account | <code>string</code> | a username or email address |
 | [options] | <code>object</code> | a configuration object |
 | [options.domain] | <code>string</code> | a domain by which to filter the results (default: all domains) |
+| [options.includeUnverified] | <code>boolean</code> | include "unverified" breaches in the results (by default, only verified breaches are included) |
 | [options.truncate] | <code>boolean</code> | truncate the results to only include the name of each breach (default: false) |
 
 **Example**  
@@ -178,7 +179,7 @@ breachedAccount('foo')
 ```
 **Example**  
 ```js
-breachedAccount('bar', { truncate: true })
+breachedAccount('bar', { includeUnverified: true })
   .then(data => {
     if (data) {
       // ...

src/breachedAccount.test.ts

@@ -36,6 +36,13 @@ describe('breachedAccount', () => {
         ).resolves.toEqual(data));
     });
 
+    describe('with includeUnverified', () => {
+      it('resolves with data from the remote API', () =>
+        expect(
+          breachedAccount('breached', { includeUnverified: true }),
+        ).resolves.toEqual(data));
+    });
+
     describe('with domain and truncateResults', () => {
       it('resolves with data from the remote API', () =>
         expect(
@@ -68,6 +75,13 @@ describe('breachedAccount', () => {
         ).resolves.toBeNull());
     });
 
+    describe('with includeUnverified', () => {
+      it('resolves with null', () =>
+        expect(
+          breachedAccount('clean', { includeUnverified: true }),
+        ).resolves.toBeNull());
+    });
+
     describe('with domain and truncateResults', () => {
       it('resolves with null', () =>
         expect(

src/breachedAccount.ts

@@ -8,6 +8,8 @@ import { Breach } from './types/remote-api.d';
  * @param {object} [options] a configuration object
  * @param {string} [options.domain] a domain by which to filter the results
  * (default: all domains)
+ * @param {boolean} [options.includeUnverified] include "unverified" breaches in
+ * the results (by default, only verified breaches are included)
  * @param {boolean} [options.truncate] truncate the results to only include
  * the name of each breach (default: false)
  * @returns {(Promise<Breach[]> | Promise<null>)} a Promise which resolves to an
@@ -26,7 +28,7 @@ import { Breach } from './types/remote-api.d';
  *     // ...
  *   });
  * @example
- * breachedAccount('bar', { truncate: true })
+ * breachedAccount('bar', { includeUnverified: true })
  *   .then(data => {
  *     if (data) {
  *       // ...
@@ -55,6 +57,7 @@ const breachedAccount = (
   account: string,
   options: {
     domain?: string;
+    includeUnverified?: boolean;
     truncate?: boolean;
   } = {},
 ): Promise<Breach[] | null> => {
@@ -63,6 +66,9 @@ const breachedAccount = (
   if (options.domain) {
     params.push(`domain=${encodeURIComponent(options.domain)}`);
   }
+  if (options.includeUnverified) {
+    params.push('includeUnverified=true');
+  }
   if (options.truncate) {
     params.push('truncateResponse=true');
   }

types/hibp.d.ts

@@ -71,6 +71,8 @@ export declare const breach: (breachName: string) => Promise<Breach | null>;
  * @param {object} [options] a configuration object
  * @param {string} [options.domain] a domain by which to filter the results
  * (default: all domains)
+ * @param {boolean} [options.includeUnverified] include "unverified" breaches in
+ * the results (by default, only verified breaches are included)
  * @param {boolean} [options.truncate] truncate the results to only include
  * the name of each breach (default: false)
  * @returns {(Promise<Breach[]> | Promise<null>)} a Promise which resolves to an
@@ -89,7 +91,7 @@ export declare const breach: (breachName: string) => Promise<Breach | null>;
  *     // ...
  *   });
  * @example
- * breachedAccount('bar', { truncate: true })
+ * breachedAccount('bar', { includeUnverified: true })
  *   .then(data => {
  *     if (data) {
  *       // ...
@@ -118,6 +120,7 @@ export declare const breachedAccount: (
   account: string,
   options?: {
     domain?: string | undefined;
+    includeUnverified?: boolean | undefined;
     truncate?: boolean | undefined;
   },
 ) => Promise<Breach[] | null>;