larvitimages
TypeScript icon, indicating that this package has built-in type declarations

0.13.66 • Public • Published

Build Status

larvitimages

Image resizing, admin page and database for images meta data.

Fetch image from browser

The given examples suggests you have an image with the slug "test.jpg" in the database.

To fetch the raw image: http://something.com/uploaded/images/test.jpg

The following will keep aspect ratio: To rescale to width 200px: http://something.com/uploaded/images/test.jpg?width=200 To rescale to height 200px: http://something.com/uploaded/images/test.jpg?height=200

To rescale regardless of aspect ratio: http://something.com/uploaded/images/test.jpg?width=200&height=200

Configuration

LarvitBase

To be able to load the images in the browser, add this to larvitbase config:

serverConf.customRoutes = [{
	'regex':	'^/uploaded/images/',
	'controllerName':	'serveDbImages'
}];

Paths

const	winston	= require('winston'),
	ImgLib	= require('larvitimages'),
	log	= winston.createLogger({'transports': [new winston.transports.Console()]}),
	Db	= require('larvitdb'),
	img = new ImgLib({
		'db':	db,

		// Optional configuration
		'storagePath':	process.cwd() + '/larvitimages',	// This is the default
		'cachePath':	require('os').tmpdir() + '/larvitimages_cache',	// This is the default
		'log':	log,	// Will use a basic console.log/error log if not set
	});

const db = new Db({
	'connectionLimit':	10,
	'sockehosttPath':	'127.0.0.1',
	'user':	'foo',
	'password':	'bar',
	'charset':	'utf8mb4_general_ci',
	'supportBigNumbers':	true,
	'database':	'dbname'
});

// OPTIONAL!
// You can set the paths after init, like this:
//img.storagePath	= process.cwd() + '/larvitimages';
//img.cachePath	= require('os').tmpdir() + '/larvitimages_cache';

Usage

Save image

const image = {
				'slug' : 'Some string',
				'file': {
					'bin': imageBuffer
				}
				'metadata': [
					{
						'name': 'deer',
						'data': 'tasty'
					},
					{
						'name': 'frog',
						'data': 'disgusting'
					}
				]
			};

const savedImage = await img.saveImage(saveObj); // Throws on error

Get image by uuid

const options = {
	'uuids':	['f997a1a8-272c-4817-885c-981ad78b9700'],
	'includeBinaryData':	true // If false or undefined only image data will be fetched.
};

const { images, totalElements } = await img.getImages(options); // Throws on error

Get image by slug

const options = {
	'slugs':	['Some slug'],
	'includeBinaryData':	true // If false or undefined only image data will be fetched.
};

const { images, totalElements } = await img.getImages(options); // Throws on error

Readme

Keywords

Package Sidebar

Install

npm i larvitimages

Weekly Downloads

340

Version

0.13.66

License

MIT

Unpacked Size

74.2 kB

Total Files

15

Last publish

Collaborators

  • vktr
  • lilleman
  • gagge
  • klabbekluck
  • jaggu-snorr
  • jaggu-larvit-npm-publish