2.2.10 • Public • Published



    Support me on Patreon Buy me a book PayPal Ask me anything Travis Version Downloads Get help on Codementor

    Buy Me A Coffee

    Overlap two strings that contain new lines. Useful for ASCII drawings.


    ☁️ Installation

    # Using npm 
    npm install --save overlap
    # Using yarn 
    yarn add overlap

    📋 Example

    // Dependencies
    var Overlap = require("overlap")
      , Couleurs = require("couleurs")
      , Box = require("cli-box")
    // Create two boxes
    var box1 = Box("20x10", Couleurs("Hello World", [142, 68, 173]))
      , box2 = Box("30x5", Couleurs("Hello Mars!", "#c0392b"))
    // Combine them
        who: box1
      , with: box2
      , where: {
            x: 17
          , y: 2

    ❓ 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


    Overlaps two strings.


    • Object options: An object containing the following fields:
    • who (String): The first string.
    • with (String): The second string.
    • where (Object): The second string position:
      • x (Number): The position on x axis.
      • y (Number): The position on y axis.


    • String The result string.

    😋 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 to 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. ✨

    • le-table
    • text-animation
    • cli-snow
    • happy-birthday-gabriel
    • tmuxos
    • ascii-github
    • apigee-edge-cli
    • cli-github

    📜 License

    MIT © Ionică Bizău


    npm i overlap

    DownloadsWeekly Downloads






    Unpacked Size

    8.76 kB

    Total Files


    Last publish


    • ionicabizau