jasmine-auto-spies - npm Package Compare versions

Comparing version 4.0.0 to 4.1.0

package.json

 {
   "name": "jasmine-auto-spies",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "repository": {
@@ -5,0 +5,0 @@ "type": "git",

README.md

@@ -40,3 +40,3 @@ # jasmine-auto-spies
 
-✅ **Automatic return type detection** by using a simple decorator
+✅ **Automatic return type detection** by using a conditional types
 
@@ -49,5 +49,31 @@ ## Installation
 
+### `my-component.js`
+
 ```js
-// my-spec.js
+export class MyComponent {
+  constructor(myService) {
+    this.myService = myService;
+  }
+  init() {
+    this.compData = this.myService.getData();
+  }
+}
+```
 
+### `my-service.js`
+
+```js
+export class MyService{
+
+  getData{
+    return [
+      { ...someRealData... }
+    ]
+  }
+}
+```
+
+### `my-spec.js`
+
+```js
 import { createSpyFromClass } from 'jasmine-auto-spies';
@@ -57,14 +83,15 @@ import { MyService } from './my-service';
 
-describe('MyComponent', ()=>{
-
+describe('MyComponent', () => {
   let myServiceSpy;
   let componentUnderTest;
 
-  beforeEach(()=>{
-    myServiceSpy = createSpyFromClass(MyService);
+  beforeEach(() => {
+    myServiceSpy = createSpyFromClass(MyService); // <- THIS IS THE IMPORTANT LINE
+
     componentUnderTest = new MyComponent(myServiceSpy);
   });
 
-  it('should get data on init', ()=>{
-    const fakeData = [{fake: 'data'}];
+  it('should fetch data on init', () => {
+    const fakeData = [{ fake: 'data' }];
+
     myServiceSpy.getData.and.returnWith(fakeData);
@@ -77,28 +104,3 @@
   });
-
 });
-
-
-// my-component.js
-
-export class MyComponent{
-
-  constructor(myService){
-    this.myService = myService;
-  }
-  init(){
-    this.compData = this.myService.getData();
-  }
-}
-
-// my-service.js
-
-export class MyService{
-
-  getData{
-    return [
-      { ...someRealData... }
-    ]
-  }
-}
 ```
@@ -108,15 +110,2 @@
 
-### TypeScript Setup
-
-Set these 2 properties in your `tsconfig.json` -
-
-```json
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}
-```
-
 ### 1. Spying on regular sync methods
@@ -130,3 +119,3 @@
 
-let myServiceSpy: Spy<MyService>;
+let myServiceSpy: Spy<MyService>; // <- THIS IS THE IMPORTANT LINE
 
@@ -137,3 +126,3 @@ beforeEach( ()=> {
 
-it('should Do something' ()=> {
+it('should do something' ()=> {
   myServiceSpy.getName.and.returnValue('Fake Name');
@@ -174,3 +163,3 @@
 
-### 3. Spy on a `Observable` returning method
+### 3. Spy on an `Observable` returning method
 
@@ -177,0 +166,0 @@ Use the `nextWith` or `throwWith` and other methods -

src/create-spy-from-class.types.d.ts

@@ -12,8 +12,8 @@ export interface SpyFunctionReturnValueContainer {
     returnValue?: (value: any) => MockTransformer;
-    resolveWith?: (value: any) => MockTransformer;
-    rejectWith?: (value: any) => MockTransformer;
-    nextWith?(value: any): MockTransformer;
-    nextOneTimeWith?(value: any): MockTransformer;
+    resolveWith?: (value?: any) => MockTransformer;
+    rejectWith?: (value?: any) => MockTransformer;
+    nextWith?(value?: any): MockTransformer;
+    nextOneTimeWith?(value?: any): MockTransformer;
     throwWith?(value: any): MockTransformer;
     complete?(): MockTransformer;
 }

src/spy.types.d.ts

@@ -9,8 +9,8 @@ /// <reference types="jasmine" />
 export interface PromiseSpyMethod<T> {
-    resolveWith(value: T): MockTransformer;
-    rejectWith(value: any): MockTransformer;
+    resolveWith(value?: T): MockTransformer;
+    rejectWith(value?: any): MockTransformer;
 }
 export interface ObservableSpyMethod<T> {
-    nextWith(value: T): MockTransformer;
-    nextOneTimeWith(value: T): MockTransformer;
+    nextWith(value?: T): MockTransformer;
+    nextOneTimeWith(value?: T): MockTransformer;
     throwWith(value: any): MockTransformer;
@@ -17,0 +17,0 @@ complete(): MockTransformer;

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

311170

decreased by-0.02%

Number of lines in readme file

241

decreased by-4.37%

No dependency changes