JavaScript CSS HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
conf
demo
src
.gitignore
.npmignore
README.md
package.json

README.md

Shrugapillar.js

A library for generating shrugapillars.

What?

A shrugapillar is a creature that is meant to be used in a scenario in which one believes a matter will eventually escalate to a problem but that the issue will still not be their problem. Though one has not shrugged off the potential of the issue yet, it is known that the matter will cocoon and be reborn as a full blow problem that they will still not care about.

Kait Marcinek, Meme Artist

A fine respite from the usual mass-produced fare we address [in the meme community], the shrugapillar is an interesting play on two themes. One one hand, we have our cynic, the shrug man emoji, whose very expression is one of an existential ennui. A meme which encapsulates the modern condition, one in which we have abundance of things, but not of purpose. On the other hand, we have the cuteness of the matter, the unicode character antenna, and the round, jolly body. This reminds the viewer of more lighthearted fare such as the lenny face and cutesy unicode cats. This is an interesting finish, as if to say "life is suffering, but there is so much goodness in the world to suffer for".

Kevin Cox, Senior Meme Analyst

Installation

$ npm install shrugapillar

Usage

var Shrugapillar = require('shrugapillar');

Static Functions

Shrugapillar.getAll() → Array.<Shrugapillar>

Shrugapillar.get('name') → Shrugapillar

  • Returns a single Shrugapillar instance whose commonName or species matches the provide name.

Shrugapillar.register(options, ...) → void

  • Adds a Shrugapillar to the list of registered shrugapillars.
  • See src/index.js for examples of options objects.

Constants

Shrugapillar.TYPES → Object<string, string>

  • A list of available output types that can be used when rendering a shrugapillar.
    • PLAIN - Optimized for Arial.
    • TWITTER - Optimized for Helvetica Neue. Also adds a tiny character at the start of the string to prevent whitespace trimming.
    • SLACK - Optimized for Slack-Lato (their desktop font). Also adds a tiny character at the start of the string to prevent whitespace trimming.
    • MONO - Optimized for Courier.

Shrugapillar Instances

Shrugapillar instance should not be instantiated manually. Instead use the static methods Shrugapillar.getAll() and Shrugapillar.get().

Public methods:

shrugapillar.getDefinition() → Object

  • Returns a copy of the definition used to create the shrugapillar. Includes any properties that were provided when the shrugapillar was registered.

shrugapillar.render(options) → string

  • Renders the shrugapillar to a string.
  • options include:
    • type:string Optional. Defaults to Shrugapillar.TYPES.PLAIN.
    • length:number Optional. The number of body sections to render. Defaults to 1.
    • maxNumCharacters:number Optional. Caps the number of body sections so that the total length (in characters) of the shrugapillar is less than maxNumberCharacters.

Example:

var result = Shrugapillar.get('marcinekae').render({
    type: Shrugapillar.TYPES.MONO,
    length: 42
});
// Will return a string with:
//    ᕙ ᕗ
// ¯\_(ツ)_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(  )_/¯
// ¯\_(__)_/¯