JSPM

obj-to-property-string

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q41479F
  • License MIT

Convert a JavaScript object's key:value pairs into a [customizable] delimited property string

Package Exports

  • obj-to-property-string

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (obj-to-property-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

obj-to-property-string

Convert a JavaScript object's key:value pairs into a [customizable] delimited property string

Build Status

Print out the key:values of any javascript object into a customizable property string. The default behavior is to print the objects key:value pairs into a string that can be used on any HTML object, but you can customize any of the property string's delimiters to get any custom string output you need. See the examples below to explore the numerous options and output formats. Pull requests welcome.

Install

$ npm install --save obj-to-property-string

Usage

const objToPropertyString = require('obj-to-property-string');

objToPropertyString({class: 'customClass', style: 'display:none;', id: '1'});
//=> 'class="customClass" style="display:none;" id="1"'

API

objToPropertyString(object, [options])

object

Type: object

The object with key:values you want to convert to a property string.

options

spacer

Type: String
Default: ' '

The character you want to use in between printed values. Defaults to a single space.

objToPropertyString({alpha: '1', beta: '2'}, {spacer: '::'});
//=> 'alpha="1"::beta="2"'

Note: The spacer value will not print after the final key:value pair

assignment

Type: String
Default: '='

The assignment operator or character you want to use to separate the key from the value. Defaults to the assignment operator = (the equals sign).

objToPropertyString({alpha: '1', beta: '2'}, {assignment: ':'});
//=> 'alpha:"1" beta:"2"'
quoteValues

Type: Boolean
Default: true

Set this value to false if you don't want the quoteString value to wrap the value. For example, if you would prefer your string to print like foo=bar instead of foo="bar".

objToPropertyString({alpha: '1', beta: '2'}, {quoteValues: false});
//=> 'alpha=1 beta=2'

objToPropertyString({alpha: '1', beta: '2'}, {quoteValues: false, assignment: ':'});
//=> 'alpha:1 beta:2'
quoteString

Type: String
Default: '"' (double quote)

The character(s) you want to use to wrap the value in. Defaults to the double-quote character ". 

objToPropertyString({alpha: '1', beta: '2'}, {quoteString: '|'});
//=> 'alpha=|1| beta=|2|'
endLineChar

Type: String
Default: ''

Use this if you want to force a character to the end of your property string. For example, you could add a newline character to help add some formatting to your property string. Defaults to no value (empty string).

objToPropertyString({alpha: '1', beta: '2', gamma: '3'}, {endLineChar: '\n'});
//=> 'alpha="1" \nbeta="2" \ngamma: "3"'

Note: The endLineChar value will not print after the final key:value pair

quoteKeys

Type: Boolean
Default: false

Set this value to true if you want to wrap the key (in key:value) with the quoteString character(s).

objToPropertyString({alpha: '1', beta: '2'}, {quoteKeys: true});
//=> '"alpha"="1" "beta"="2"'

License

MIT © Michael Wuergler