# render

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

Latest version **0.1.4** (published 2014-02-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install render
pnpm add render
yarn add render
bun add render
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2014-02-16 |
| First published | 2011-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/render
- Repository: https://github.com/dominictarr/render
- Issues: https://github.com/dominictarr/render/issues
- npm.io page: https://npm.io/package/render

## Dependencies (1)

- [traverser](https://npm.io/package/traverser.md) 0.0.x

## Recent versions

- 0.1.4 (latest) — 2014-02-16
- 0.1.3 — 2012-11-18
- 0.1.2 — 2012-06-26
- 0.1.1 — 2011-10-15
- 0.1.0 — 2011-09-17
- 0.0.5 — 2011-06-20
- 0.0.4 — 2011-06-20
- 0.0.3 — 2011-06-06
- 0.0.2 — 2011-02-08

## 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

---
_Source: https://npm.io/package/render · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._