Helper tool for resizing the things.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
lib
test
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

compute-size

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

Helper tool for resizing the things.

☁️ Installation

# Using npm
npm install --save compute-size

# Using yarn
yarn add compute-size

📋 Example

const computeSize = require("compute-size");

console.log(computeSize({
    // Wanted size
    width: 10
    // 40% of the screen height
  , height: "40%"
}, {
    // Object width (e.g. an image)
    width: 10
    // ..and the height
  , height: 50
}, {
    screen_size: {
        width: 100
      , height: 200
    },
    preserve_aspect_ratio: false
}));
// { width: 10, height: 80 }

console.log(computeSize({
    // Wanted size
    width: 10
    // 40% of the screen height
  , height: "40%"
}, {
    // Object width (e.g. an image)
    width: 10
    // ..and the height
  , height: 50
}, {
    screen_size: {
        width: 100
      , height: 200
    }
}));
// { width: 10, height: 50 }

console.log(computeSize({
    // Wanted size
   height: "100%"
}, {
    width: 10
  , height: 50
}, {
    screen_size: {
        width: 100
      , height: 400
    }
}));
// { width: 80, height: 400 }

Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. 🐛

  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

computeSize(wantedSize, realSize, options)

Computes a wanted size based on the object, pixel and screen sizes.

Params

  • Object wantedSize: An object containing the following fields:
  • width (Number): The wanted width.
  • height (Number): The wanted height.
  • Object realSize: An object containing the following fields:
  • width (Number): The existing object width (e.g. an image).
  • height (Number): The existing object height (e.g. an image).
  • Object options: An object containing the following fields:
  • screen_size (Object): The screen size (defaults to terminal width and height):
  • width (Number): The screen width.
  • height (Number): The screen height.
  • px_size (Object): The pixel size.
  • width (default: 1)
  • height (default: 1)
  • preserve_aspect_ratio (Boolean): If false, the aspect ratio will not be preserved (default: true).
  • fit_screen (Boolean): If false, the result size will not fit to screen (default: true).

Return

  • Object The result size:
  • width (Number): The computed width.
  • height (Number): The computed height.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list.

  • image-to-ascii—A Node.JS module that converts images to ASCII art.

📜 License

MIT © Ionică Bizău