Update error messages

Author: blakeembrey

src/format.spec.ts

@@ -5,7 +5,10 @@ describe('format(credentials)', function () {
   describe('arguments', function () {
     describe('credentials', function () {
       it('should be required', function () {
-        assert.throws(() => (format as any)(), /credentials is required/);
+        assert.throws(
+          () => (format as any)(),
+          /"credentials" must be an object/,
+        );
       });
 
       it('should accept credentials', function () {
@@ -16,43 +19,49 @@ describe('format(credentials)', function () {
       it('should reject null', function () {
         assert.throws(
           format.bind(null, null as any),
-          /credentials is required/,
+          /"credentials" must be an object/,
         );
       });
 
       it('should reject a number', function () {
-        assert.throws(format.bind(null, 42 as any), /credentials is required/);
+        assert.throws(
+          format.bind(null, 42 as any),
+          /"credentials" must be an object/,
+        );
       });
 
       it('should reject a string', function () {
-        assert.throws(format.bind(null, '' as any), /credentials is required/);
+        assert.throws(
+          format.bind(null, '' as any),
+          /"credentials" must be an object/,
+        );
       });
 
       it('should reject an object without name', function () {
         assert.throws(
           format.bind(null, { pass: 'bar' } as any),
-          /credentials is required to have name and pass properties/,
+          /"credentials" must have string properties "name" and "pass"/,
         );
       });
 
       it('should reject an object without pass', function () {
         assert.throws(
           format.bind(null, { name: 'foo' } as any),
-          /credentials is required to have name and pass properties/,
+          /"credentials" must have string properties "name" and "pass"/,
         );
       });
 
       it('should reject an object with non-string name', function () {
         assert.throws(
           format.bind(null, { name: 42, pass: 'bar' } as any),
-          /credentials is required to have name and pass properties/,
+          /"credentials" must have string properties "name" and "pass"/,
         );
       });
 
       it('should reject an object with non-string pass', function () {
         assert.throws(
           format.bind(null, { name: 'foo', pass: 42 } as any),
-          /credentials is required to have name and pass properties/,
+          /"credentials" must have string properties "name" and "pass"/,
         );
       });
 
@@ -87,21 +96,21 @@ describe('format(credentials)', function () {
   });
 
   describe('with empty password', function () {
-    it('should throw', function () {
+    it('should return header', function () {
       const header = format({ name: 'foo', pass: '' });
       assert.strictEqual(header, 'Basic Zm9vOg==');
     });
   });
 
   describe('with empty userid', function () {
-    it('should throw', function () {
+    it('should return header', function () {
       const header = format({ name: '', pass: 'pass' });
       assert.strictEqual(header, 'Basic OnBhc3M=');
     });
   });
 
   describe('with empty userid and pass', function () {
-    it('should throw', function () {
+    it('should return header', function () {
       const header = format({ name: '', pass: '' });
       assert.strictEqual(header, 'Basic Og==');
     });

src/index.ts

@@ -53,28 +53,28 @@ export function parse(string: string): Credentials | undefined {
  */
 export function format(credentials: Credentials): string {
   if (typeof credentials !== 'object' || credentials === null) {
-    throw new TypeError('credentials is required to be an object');
+    throw new TypeError('"credentials" must be an object');
   }
 
   if (
     typeof credentials.name !== 'string' ||
     typeof credentials.pass !== 'string'
   ) {
     throw new TypeError(
-      'credentials is required to have name and pass properties',
+      '"credentials" must have string properties "name" and "pass"',
     );
   }
 
   // RFC 7617 disallows colon in username
   if (credentials.name.includes(':')) {
-    throw new TypeError('name must not contain a colon');
+    throw new TypeError('"name" must not contain a colon');
   }
 
   const str = credentials.name + ':' + credentials.pass;
 
   if (CONTROL_CHARS_REGEXP.test(str)) {
     throw new TypeError(
-      'argument credentials must not contain control characters',
+      '"name" and "pass" must not contain control characters',
     );
   }