favicons.js

var fs = require ('fs'),
  favicons = require('favicons'),
	source = 'image.jpg',                      // Source 1024 square PNG image(s). `string`, `buffer` or array of `string`
	configuration = {
		path: "/",                                // Path for overriding default icons path. `string`
		appName: null,                            // Your application's name. `string`
		appShortName: null,                       // Your application's short_name. `string`. Optional. If not set, appName will be used
		appDescription: null,                     // Your application's description. `string`
		developerName: null,                      // Your (or your developer's) name. `string`
		developerURL: null,                       // Your (or your developer's) URL. `string`
		dir: "auto",                              // Primary text direction for name, short_name, and description
		lang: "en-US",                            // Primary language for name and short_name
		background: "#fff",                       // Background colour for flattened icons. `string`
		theme_color: "#fff",                      // Theme color user for example in Android's task switcher. `string`
		appleStatusBarStyle: "black-translucent", // Style for Apple status bar: "black-translucent", "default", "black". `string`
		display: "standalone",                    // Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". `string`
		orientation: "any",                       // Default orientation: "any", "natural", "portrait" or "landscape". `string`
		scope: "/",                               // set of URLs that the browser considers within your app
		start_url: "/?homescreen=1",              // Start URL when launching the application from a device. `string`
		version: "1.0",                           // Your application's version string. `string`
		logging: false,                           // Print logs to console? `boolean`
		pixel_art: false,                         // Keeps pixels "sharp" when scaling up, for pixel art.  Only supported in offline mode.
		loadManifestWithCredentials: false,       // Browsers don't send cookies when fetching a manifest, enable this to fix that. `boolean`
		icons: {
			// Platform Options:
			// - offset - offset in percentage
			// - background:
			//   * false - use default
			//   * true - force use default, e.g. set background for Android icons
			//   * color - set background for the specified icons
			//   * mask - apply mask in order to create circle icon (applied by default for firefox). `boolean`
			//   * overlayGlow - apply glow effect after mask has been applied (applied by default for firefox). `boolean`
			//   * overlayShadow - apply drop shadow after mask has been applied .`boolean`
			//
			android: true,              // Create Android homescreen icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			appleIcon: true,            // Create Apple touch icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			appleStartup: false,        // Create Apple startup images. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			coast: false,               // Create Opera Coast icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			favicons: true,             // Create regular favicons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			firefox: false,              // Create Firefox OS icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			windows: true,              // Create Windows 8 tile icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
			yandex: false               // Create Yandex browser icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }`
		}
	},
	callback = function (error, response) {
		if (error) {
			console.log(error.message); // Error description e.g. "An unknown error has occurred"
			return;
		}

		// Create images
		response.images.map (image => {
			fs.writeFileSync (`./public/${image.name}`, image.contents)
		})

		// Create meta files about images
		response.files.map (file => {
			fs.writeFileSync (`./public/${file.name}`, file.contents)
		})

		// Create favicon partial
		const writeStream = fs.createWriteStream('./templates/_partials/favicons.twig');
		const pathName = writeStream.path;

		// write each value of the array on the file breaking line
		response.html.forEach(value => writeStream.write(`${value}\n`));

		// the finish event is emitted when all data has been flushed from the stream
		writeStream.on('finish', () => {});

		// handle the errors on the write process
		writeStream.on('error', (err) => {
				console.error(`There is an error writing the file ${pathName} => ${err}`)
		});

		// close the stream
		writeStream.end();

		// console.log(response.images);   // Array of { name: string, contents: <buffer> }
		// console.log(response.files);    // Array of { name: string, contents: <string> }
		// console.log(response.html);     // Array of strings (html elements)
		console.log('Favicon’s have been saved successfully');
	};

favicons(source, configuration, callback);