Use termImg.string as the default function (#13)

example.js

@@ -1,7 +1,7 @@
 'use strict';
 const termImg = require('.');
 
-termImg('fixture.jpg', {
+console.log(termImg('fixture.jpg', {
 	width: 50,
-	fallback: () => console.log('Not supported here, sorry...')
-});
+	fallback: () => 'Not supported here, sorry...'
+}));

index.d.ts

@@ -22,7 +22,7 @@ declare namespace termImg {
 
 declare const termImg: {
 	/**
-	Log the image to the terminal directly.
+	Get the image as a `string` that you can log manually.
 
 	@param image - Filepath to an image or an image as a buffer.
 
@@ -37,14 +37,7 @@ declare const termImg: {
 	termImg('unicorn.jpg', {fallback});
 	```
 	*/
-	(image: string | Buffer, options?: termImg.Options): void;
-
-	/**
-	Get the image as a `string` that you can log manually.
-
-	@param image - Filepath to an image or an image as a buffer.
-	*/
-	string<FallbackType>(
+	<FallbackType>(
 		image: string | Buffer,
 		options?: termImg.Options<FallbackType>
 	): string | FallbackType;

index.js

@@ -14,51 +14,28 @@ function unsupported() {
 	throw new UnsupportedTerminalError();
 }
 
-function main(image, options = {}) {
+module.exports = (image, options = {}) => {
 	const fallback = typeof options.fallback === 'function' ? options.fallback : unsupported;
 
 	if (!(image && image.length > 0)) {
 		throw new TypeError('Image required');
 	}
 
 	if (process.env.TERM_PROGRAM !== 'iTerm.app') {
-		return fallback;
+		return fallback();
 	}
 
 	const version = iterm2Version();
 
 	if (Number(version[0]) < 3) {
-		return fallback;
+		return fallback();
 	}
 
 	if (typeof image === 'string') {
 		image = fs.readFileSync(image);
 	}
 
 	return ansiEscapes.image(image, options);
-}
-
-const termImg = (image, options) => {
-	const ret = main(image, options);
-
-	if (typeof ret === 'function') {
-		ret();
-		return;
-	}
-
-	console.log(ret);
-};
-
-module.exports = termImg;
-
-module.exports.string = (image, options) => {
-	const ret = main(image, options);
-
-	if (typeof ret === 'function') {
-		return ret();
-	}
-
-	return ret;
 };
 
 module.exports.UnsupportedTerminalError = UnsupportedTerminalError;

index.test-d.ts

@@ -2,16 +2,11 @@ import {expectType} from 'tsd';
 import termImg = require('.');
 import {UnsupportedTerminalError} from '.';
 
-expectType<void>(termImg('/foo/bar.jpg'));
-expectType<void>(termImg(Buffer.from(1)));
-expectType<void>(termImg('/foo/bar.jpg', {width: 1}));
-expectType<void>(termImg('/foo/bar.jpg', {fallback: () => false}));
-
-expectType<string>(termImg.string('/foo/bar.jpg'));
-expectType<string>(termImg.string(Buffer.from(1)));
-expectType<string>(termImg.string('/foo/bar.jpg', {width: 1}));
+expectType<string>(termImg('/foo/bar.jpg'));
+expectType<string>(termImg(Buffer.alloc(1)));
+expectType<string>(termImg('/foo/bar.jpg', {width: 1}));
 expectType<string | boolean>(
-	termImg.string('/foo/bar.jpg', {fallback: () => false})
+	termImg('/foo/bar.jpg', {fallback: () => false})
 );
 
 const unsupportedTerminalError = new UnsupportedTerminalError();

readme.md

@@ -2,6 +2,8 @@
 
 > Display images in iTerm
 
+You probably want the higher-level [`terminal-image`](https://github.com/sindresorhus/terminal-image) package for displaying your images.
+
 ![](screenshot.jpg)
 
 Even [animated gifs](https://github.com/vdemedes/gifi)!
@@ -22,21 +24,17 @@ $ npm install term-img
 const termImg = require('term-img');
 
 function fallback() {
-	// Do something else when not supported
+	// Return something else when not supported
 }
 
-termImg('unicorn.jpg', {fallback});
+console.log(termImg('unicorn.jpg', {fallback}));
 ```
 
 
 ## API
 
 ### termImg(image, [options])
 
-Log the image to the terminal directly.
-
-### termImg.string(image, [options])
-
 Get the image as a `string` that you can log manually.
 
 #### image

test.js

@@ -2,6 +2,7 @@ import test from 'ava';
 import termImg from '.';
 
 test('main', t => {
-	// TODO: Write some real tests
-	t.is(typeof termImg, 'function');
+	process.env.TERM_PROGRAM = 'iTerm.app';
+	process.env.TERM_PROGRAM_VERSION = '3.3.7';
+	t.snapshot(termImg('fixture.jpg'));
 });