feat!: simplified and made more consistent stub api

BREAKING CHANGE: changed setExpectedArgs() and setReturnValue() to expects() and returns() respectively

Author: mhweiner

README.md

@@ -103,8 +103,8 @@ The returned stub function can be called like a normal function and includes add
 
 - `getCalls(): any[]` — Returns an array of all calls made to the stub (each call is an array of arguments).
 - `clear(): Stub` — Clears recorded calls and resets internal expectations.
-- `setExpectedArgs(...args: any[]): Stub` — Defines the exact arguments the stub expects to receive. If the stub is called with different arguments, it throws an error.
-- `setReturnValue(value: any): Stub` — Sets the value that the stub should return when called.
+- `expects(...args: any[]): Stub` — Defines the exact arguments the stub expects to receive. If the stub is called with different arguments, it throws an error.
+- `returns(value: any): Stub` — Sets the value that the stub should return when called.
 - `throws(error: Error): Stub` — Configures the stub to throw the specified error when called.
 
 #### Stub Type Definition
@@ -113,8 +113,8 @@ The returned stub function can be called like a normal function and includes add
 export type Stub = ((...args: any[]) => any) & {
   getCalls: () => any[];
   clear: () => Stub;
-  setExpectedArgs: (...expected: any[]) => Stub;
-  setReturnValue: (value: any) => Stub;
+  expects: (...expected: any[]) => Stub;
+  returns: (value: any) => Stub;
   throws: (error: Error) => Stub;
 };
 ```
@@ -123,8 +123,8 @@ export type Stub = ((...args: any[]) => any) & {
 
 ```ts
 const myStub = stub()
-  .setExpectedArgs('hello', 123)
-  .setReturnValue('world');
+  .expects('hello', 123)
+  .returns('world');
 
 console.log(myStub('hello', 123)); // 'world'
 console.log(myStub.getCalls());    // [['hello', 123]]
@@ -140,8 +140,8 @@ You can give your stub name for easier debugging and error messages:
 
 ```ts
 const myStub = stub("my-stub")
-  .setExpectedArgs('hello', 123)
-  .setReturnValue('world');
+  .expects('hello', 123)
+  .returns('world');
 
 console.log(myStub('hello', 123)); // 'world'
 console.log(myStub.getCalls());    // [['hello', 123]]

src/stub.spec.ts

@@ -20,8 +20,8 @@ test('stub.clear() returns the stub and empties call history and resets config',
 
     const fn = stub();
 
-    fn.setExpectedArgs('x');
-    fn.setReturnValue(123);
+    fn.expects('x');
+    fn.returns(123);
     fn('x');
 
     assert.equal(fn.getCalls().length, 1);
@@ -38,9 +38,9 @@ test('stub.clear() returns the stub and empties call history and resets config',
 
 });
 
-test('stub.setReturnValue() returns the stub, and sets the return value of the stub', (assert) => {
+test('stub.returns() returns the stub, and sets the return value of the stub', (assert) => {
 
-    const fn = stub().setReturnValue('ok');
+    const fn = stub().returns('ok');
 
     const result = fn();
 
@@ -50,7 +50,7 @@ test('stub.setReturnValue() returns the stub, and sets the return value of the s
 
 test('stub throws on unexpected arguments', (assert) => {
 
-    const fn = stub().setExpectedArgs('expected', 42);
+    const fn = stub().expects('expected', 42);
 
     assert.throws(() => fn('wrong', 42), /Stub called with unexpected arguments/);
     assert.throws(() => fn(), /Stub called with unexpected arguments/);
@@ -60,7 +60,7 @@ test('stub throws on unexpected arguments', (assert) => {
 
 test('stub does recursive, strict, compare-by-value equality check for expected args', (assert) => {
 
-    const fn = stub().setExpectedArgs({a: 1});
+    const fn = stub().expects({a: 1});
 
     assert.throws(() => fn({a: 1, b: 2}), /Stub called with unexpected arguments/);
     fn({a: 1}); // Should not throw
@@ -69,15 +69,15 @@ test('stub does recursive, strict, compare-by-value equality check for expected
 
     fn(obj); // Should not throw
 
-    fn.setExpectedArgs(2);
+    fn.expects(2);
     assert.throws(() => fn(3), /Stub called with unexpected arguments/);
     fn(2); // Should not throw
 
 });
 
 test('unexpected arg error contains name if supplied in constructor', (assert) => {
 
-    const fn = stub('my-awesome-stub').setExpectedArgs('expected', 42);
+    const fn = stub('my-awesome-stub').expects('expected', 42);
 
     assert.throws(() => fn('wrong', 42), /Stub "my-awesome-stub" called with unexpected arguments/);
     assert.throws(() => fn(), /Stub "my-awesome-stub" called with unexpected arguments/);

src/stub.ts

@@ -10,8 +10,8 @@ function format(value: any): string {
 export type Stub = ((...args: any[]) => any) & {
     getCalls: () => any[]
     clear: () => Stub
-    setExpectedArgs: (...expected: any[]) => Stub
-    setReturnValue: (value: any) => Stub
+    expects: (...expected: any[]) => Stub
+    returns: (value: any) => Stub
     throws: (error: Error) => Stub
 };
 
@@ -55,13 +55,13 @@ export function stub(name?: string): Stub {
         return fn;
 
     };
-    fn.setExpectedArgs = (...args: any[]): Stub => {
+    fn.expects = (...expected: any[]): Stub => {
 
-        expectedArgs = args;
+        expectedArgs = expected;
         return fn;
 
     };
-    fn.setReturnValue = (value: any): Stub => {
+    fn.returns = (value: any): Stub => {
 
         returnValue = value;
         return fn;