npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

render

v0.1.4

Published

pretty print javascript objects or generate JSON, with comma first and comma trailing

Downloads

3,261

Readme

#Render#

4 styles

  • comma first: .cf
  • comma trailing : .ct
  • comma fist bracket newline: .cfbn
  • comma trailing bracket newline: .ctbn

3 handy modes

  • return string render.[cf|ct|cfbn|ctbn]
  • log to console render.log.[cf|ct|cfbn|ctbn]
  • return json render.json.[cf|ct|cfbn|ctbn]

#Layout Styles#

this object:

var renderme = 
    { key1: value
    , key2: value
    , child: 
      { key1: value
      , key2: value } }

import render:

var render = require('render')

##indented, comma-first, object-newline

render.ct(renderme)

// render(renderme,{joiner:"\n, ", indent: '  ', padMulti: ['\n','']})

{ key1: 1
, key2: 2
, child: 
  { key1: 3
  , key2: 4 } }

##indented, comma-first, bracket-newline, cl-bracket-newline

render.cfbn(renderme)

// render(renderme,{joiner:"\n, ", indent: '  ', padJoin: ['\n  ','\n']}

{
  key1: 1
, key2: 2
, child: {
    key1: 3
  , key2: 4
  }
}

##indented, comma-trailing, object-newline

render.ct(renderme)

// render(renderme,{joiner:",\n  ", indent: '  ', padJoin: ['\n  ','\n']}

{ key1: value,
  key2: value,
  child: 
  { key1: value,
    key2: value } }

##indented, comma-trailing, bracket-ownline, cl-bracket-newline

render.ctbn(renderme)

// render(renderme,{joiner:",\n  ", indent: '  ', padJoin: ['\n  ','\n']}

{
  key1: 1,
  key2: 2,
  child: {
    key1: 3,
    key2: 4
  }
}

#Heavy Duty Object -> ASCII

render(object,options)

options is a {} of functions which define how a particular type is stringified.

(see render.js and test/*.js for examples)

these functions are:

value // display a primitive value
key // display a key (on an object, but not an array)
join // join a list object key->value strings into one string (default joins with ','s
surround // puts the brackets on {} or [] 
referenced // when a object is repeated later (default: varX={...})
reference // when a object is a repeat (varX

string // stringify string (useful if you want to handle multi line strings a special way

#Renderer function args#

function(value, traverserProperties, default)

value is the item to be renderer, traverserProperties if information about current place in the tree/graph (see https://github.com/dominictarr/traverser) default is the default rendering function for this item.

#Layout Control#

also, padding around certain items can be changed by setting the following values of options:

indent: '' //indentation applied to each line after the first when something renders to a string with multiple lines.
, joiner: ', ' // string to join arrays and objects
, pad: '' 
, padKey: ' ' //padding after the ':'
, padSingle: ['', ''] //padding around a single value
, padJoin: [' ', ' '] //padding around a join (but inside the brackets)
, padMulti: ['', ''] //padding around an object or Array when it goes over multiple lines
, padRoot: ['', ''] //padding around the root object (only applied if it's multi lined)

examples, by adjusting these settings you can display an object in many different styles:

License

MIT