Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
@json2csv/formatters
Advanced tools
json2csv built-in formatters. A formatter is a function that receives the raw js value of a given type and formats it as a valid CSV cell.
A formatter is function a used by json2csv
(in any of its flavours) to convert javascript values into plain text before adding it into the CSV as a cell.
Supported formatters are given by the types returned by typeof
:
undefined
boolean
number
bigint
string
symbol
function
object
And a special type that only applies to headers:
headers
Pay special attention to the string
formatter since other formatters like the headers
or object
formatters, rely on the string
formatter for the stringification of their value..
There are multiple flavours of json2csv where you can use formatters:
Parser
API and a new StreamParser
API which doesn't the conversion in a streaming fashion in pure js.Node Transform
and Node Async Parser
APIs for Node users.WHATWG Transform Stream
and WHATWG Async Parser
APIs for users of WHATWG streams (browser, Node or Deno).CLI
interface.There is a number of built-in formatters provided by this package.
import {
default as defaultFormatter,
number as numberFormatter,
string as stringFormatter,
stringQuoteOnlyIfNecessary as stringQuoteOnlyIfNecessaryFormatter,
stringExcel as stringExcelFormatter,
symbol as symbolFormatter,
object as objectFormatter,
} from '@json2csv/formatters';
This formatter just relies on standard JavaScript stringification.
This is the default formatter for undefined
, boolean
, number
and bigint
elements.
It's not a factory but the formatter itself.
{
undefined: defaultFormatter,
boolean: defaultFormatter,
number: defaultFormatter,
bigint: defaultFormatter,
}
Format numbers with a fixed amount of decimals
The formatter needs to be instantiated and takes an options object as arguments containing:
separator
- String, separator to use between integer and decimal digits. Defaults to .
. It's crucial that the decimal separator is not the same character as the CSV delimiter or the result CSV will be incorrect.decimals
- Number, amount of decimals to keep. Defaults to all the available decimals.{
// 2 decimals
number: numberFormatter(),
// 3 decimals
number: numberFormatter(3)
}
Format strings quoting them and escaping illegal characters if needed.
The formatter needs to be instantiated and takes an options object as arguments containing:
quote
- String, quote around cell values and column names. Defaults to "
.escapedQuote
- String, the value to replace escaped quotes in strings. Defaults to double-quotes (for example ""
).This is the default for string
elements.
{
// Uses '"' as quote and '""' as escaped quote
string: stringFormatter(),
// Use single quotes `'` as quotes and `''` as escaped quote
string: stringFormatter({ quote: '\'' }),
// Never use quotes
string: stringFormatter({ quote: '' }),
// Use '\"' as escaped quotes
string: stringFormatter({ escapedQuote: '\"' }),
}
The default string formatter quote all strings. This is consistent but it is not mandatory according to the CSV standard. This formatter only quote strings if they don't contain quotes (by default "
), the CSV separator character (by default ,
) or the end-of-line (by default \n
or \r\n
depending on you operating system).
The formatter needs to be instantiated and takes an options object as arguments containing:
quote
- String, quote around cell values and column names. Defaults to "
.escapedQuote
- String, the value to replace escaped quotes in strings. Defaults to 2xquotes
(for example ""
).eol
- String, overrides the default OS line ending (i.e. \n
on Unix and \r\n
on Windows). Ensure that you use the same eol
here as in the json2csv options.{
// Uses '"' as quote, '""' as escaped quote and your OS eol
string: stringQuoteOnlyIfNecessaryFormatter(),
// Use single quotes `'` as quotes, `''` as escaped quote and your OS eol
string: stringQuoteOnlyIfNecessaryFormatter({ quote: '\'' }),
// Never use quotes
string: stringQuoteOnlyIfNecessaryFormatter({ quote: '' }),
// Use '\"' as escaped quotes
string: stringQuoteOnlyIfNecessaryFormatter({ escapedQuote: '\"' }),
// Use linux EOL regardless of your OS
string: stringQuoteOnlyIfNecessaryFormatter({ eol: '\n' }),
}
Converts string data into normalized Excel style data after formatting it using the given string formatter.
The formatter needs to be instantiated and takes no arguments.
{
string: stringExcelFormatter,
}
Format the symbol as its string value and then use the given string formatter i.e. Symbol('My Symbol')
is formatted as "My Symbol"
.
The formatter needs to be instantiated and takes an options object as arguments containing:
stringFormatter
- String formatter to use to stringify the symbol name. Defaults to the built-in stringFormatter
.This is the default for symbol
elements.
{
// Uses the default string formatter
symbol: symbolFormatter(),
// Uses custom string formatter
// You rarely need to this since the symbol formatter will use the string formatter that you set.
symbol: symbolFormatter(myStringFormatter()),
}
Format the object using JSON.stringify
and then the given string formatter.
Some object types likes Date
or Mongo's ObjectId
are automatically quoted by JSON.stringify
. This formatter, remove those quotes and uses the given string formatter for correct quoting and escaping.
The formatter needs to be instantiated and takes an options object as arguments containing:
stringFormatter
- tring formatter to use to stringify the symbol name. Defaults to our built-in stringFormatter
.This is the default for function
and object
elements. function
's are formatted as empty ``.
{
// Uses the default string formatter
object: objectFormatter(),
// Uses custom string formatter
// You rarely need to this since the object formatter will use the string formatter that you set.
object: objectFormatter(myStringFormatter()),
}
Users can create their own formatters as simple functions.
function formatType(itemOfType) {
// format type
return formattedItem;
}
or using ES6
const formatType = (itemOfType) => {
// format type
return itemOfType;
};
For example, let's format functions as their name or 'unknown'.
const functionNameFormatter = (item) => item.name || 'unknown';
Then you can add { function: functionNameFormatter }
to the formatters
object.
A less trivial example would be to ensure that string cells never take more than 20 characters.
const fixedLengthStringFormatter = (stringLength, ellipsis = '...') =>
(item) =>
item.length <= stringLength
? item
: `${item.slice(0, stringLength - ellipsis.length)}${ellipsis}`;
Then you can add { string: fixedLengthStringFormatter(20) }
to the formatters
object.
Or fixedLengthStringFormatter(20, '')
to not use the ellipsis and just clip the text.
As with the sample transform in the previous section, the reason to wrap the actual formatter in a factory function is so it can be parameterized easily.
Keep in mind that the above example doesn't quote or escape the string which is problematic. A more realistic example could use our built-in string formatted to do the quoting and escaping like:
import { string as defaultStringFormatter } from 'json2csv/formatters';
const fixedLengthStringFormatter = (stringLength, ellipsis = '...', stringFormatter = defaultStringFormatter()) =>
(item) =>
item.length <= stringLength
? item
: stringFormatter(`${item.slice(0, stringLength - ellipsis.length)}${ellipsis})`;
Formatters are configured in the formatters
option when creating a parser.
import { Parser } from '@json2csv/plainjs';
import { number as numberFormatter } from '@json2csv/formatters';
import { fixedLengthStringFormatter } from './custom-formatters';
try {
const opts = {
formatters: {
number: numberFormatter({ decimals: 3, separator: ',' }),
string: fixedLengthStringFormatter(20)
}
};
const parser = new Parser(opts);
const csv = parser.parse(myData);
console.log(csv);
} catch (err) {
console.error(err);
}
At the moment, only some options of the string
built-in formatters are supported by the CLI interface.
$ json2csv -i input.json --quote '"' --escaped-quote '\"'
or if you want to use the String Excel
instead:
$ json2csv -i input.json --excel-strings
See https://juanjodiaz.github.io/json2csv/#/advanced-options/formatters.
See LICENSE.md.
FAQs
json2csv built-in formatters. A formatter is a function that receives the raw js value of a given type and formats it as a valid CSV cell.
We found that @json2csv/formatters demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.