refactor(image-source): throw if source is not a correct native instance (NativeScript#5273)

Vasil Chimev · web-flow · commit 58d61caf59ab · 2018-01-23T16:57:29.000+02:00
* refactor(image-source): throw if source is not a correct native instance

* refactor(image-source): fromNativeSource and setNativeSource methods

* refactor: update image-source.d.ts file

BREAKING CHANGE:

Change the return type of `setNativeSource` method from `boolean` to `void`.
diff --git a/tns-core-modules/image-source/image-source.android.ts b/tns-core-modules/image-source/image-source.android.ts
@@ -139,9 +139,11 @@ export class ImageSource implements ImageSourceDefinition {
         });
     }
 
-    public setNativeSource(source: any): boolean {
+    public setNativeSource(source: any): void {
+        if (source && !(source instanceof android.graphics.Bitmap)) {
+            throw new Error("The method setNativeSource() expects android.graphics.Bitmap instance.");
+        }
         this.android = source;
-        return source != null;
     }
 
     public saveToFile(path: string, format: "png" | "jpeg" | "jpg", quality = 100): boolean {
@@ -239,8 +241,9 @@ export function fromBase64(source: string): ImageSource {
 }
 
 export function fromNativeSource(source: any): ImageSource {
-    const image = new ImageSource();
-    return image.setNativeSource(source) ? image : null;
+    const imageSource = new ImageSource();
+    imageSource.setNativeSource(source);
+    return imageSource;
 }
 
 export function fromUrl(url: string): Promise<ImageSourceDefinition> {
diff --git a/tns-core-modules/image-source/image-source.d.ts b/tns-core-modules/image-source/image-source.d.ts
@@ -88,11 +88,11 @@ export class ImageSource {
     fromBase64(source: string): Promise<boolean>;        
 
    /**
-    * Sets the provided native source object (typically a Bitmap).
+    * Sets the provided native source object (typically a Bitmap or a UIImage).
     * This will update either the android or ios properties, depending on the target os.
     * @param source The native image object. Will be either a Bitmap for Android or a UIImage for iOS.
     */
-    setNativeSource(source: any): boolean;
+    setNativeSource(source: any): void;
 
    /**
     * Saves this instance to the specified file, using the provided image format and quality.
diff --git a/tns-core-modules/image-source/image-source.ios.ts b/tns-core-modules/image-source/image-source.ios.ts
@@ -118,11 +118,11 @@ export class ImageSource implements ImageSourceDefinition {
         });
     }
 
-    public setNativeSource(source: any): boolean {
-        if (source instanceof UIImage) {
-            this.ios = source;
+    public setNativeSource(source: any): void {
+        if (source && !(source instanceof UIImage)) {
+            throw new Error("The method setNativeSource() expects UIImage instance.");
         }
-        return source != null;
+        this.ios = source;
     }
 
     public saveToFile(path: string, format: "png" | "jpeg" | "jpg", quality?: number): boolean {
@@ -221,8 +221,9 @@ export function fromBase64(source: string): ImageSource {
 }
 
 export function fromNativeSource(source: any): ImageSource {
-    const image = new ImageSource();
-    return image.setNativeSource(source) ? image : null;
+    const imageSource = new ImageSource();
+    imageSource.setNativeSource(source);
+    return imageSource;
 }
 
 export function fromUrl(url: string): Promise<ImageSource> {

Original file line number	Diff line number	Diff line change
`@@ -139,9 +139,11 @@ export class ImageSource implements ImageSourceDefinition {`
`139`	`139`	`});`
`140`	`140`	`}`
`141`	`141`
`142`		`- public setNativeSource(source: any): boolean {`
	`142`	`+ public setNativeSource(source: any): void {`
	`143`	`+ if (source && !(source instanceof android.graphics.Bitmap)) {`
	`144`	`+ throw new Error("The method setNativeSource() expects android.graphics.Bitmap instance.");`
	`145`	`+ }`
`143`	`146`	`this.android = source;`
`144`		`- return source != null;`
`145`	`147`	`}`
`146`	`148`
`147`	`149`	`public saveToFile(path: string, format: "png" \| "jpeg" \| "jpg", quality = 100): boolean {`
`@@ -239,8 +241,9 @@ export function fromBase64(source: string): ImageSource {`
`239`	`241`	`}`
`240`	`242`
`241`	`243`	`export function fromNativeSource(source: any): ImageSource {`
`242`		`- const image = new ImageSource();`
`243`		`- return image.setNativeSource(source) ? image : null;`
	`244`	`+ const imageSource = new ImageSource();`
	`245`	`+ imageSource.setNativeSource(source);`
	`246`	`+ return imageSource;`
`244`	`247`	`}`
`245`	`248`
`246`	`249`	`export function fromUrl(url: string): Promise<ImageSourceDefinition> {`
Original file line number	Diff line number	Diff line change
`@@ -118,11 +118,11 @@ export class ImageSource implements ImageSourceDefinition {`
`118`	`118`	`});`
`119`	`119`	`}`
`120`	`120`
`121`		`- public setNativeSource(source: any): boolean {`
`122`		`- if (source instanceof UIImage) {`
`123`		`- this.ios = source;`
	`121`	`+ public setNativeSource(source: any): void {`
	`122`	`+ if (source && !(source instanceof UIImage)) {`
	`123`	`+ throw new Error("The method setNativeSource() expects UIImage instance.");`
`124`	`124`	`}`
`125`		`- return source != null;`
	`125`	`+ this.ios = source;`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`public saveToFile(path: string, format: "png" \| "jpeg" \| "jpg", quality?: number): boolean {`
`@@ -221,8 +221,9 @@ export function fromBase64(source: string): ImageSource {`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`export function fromNativeSource(source: any): ImageSource {`
`224`		`- const image = new ImageSource();`
`225`		`- return image.setNativeSource(source) ? image : null;`
	`224`	`+ const imageSource = new ImageSource();`
	`225`	`+ imageSource.setNativeSource(source);`
	`226`	`+ return imageSource;`
`226`	`227`	`}`
`227`	`228`
`228`	`229`	`export function fromUrl(url: string): Promise<ImageSource> {`