Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@base2/pretty-print-object

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@base2/pretty-print-object - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

41

dist/index.d.ts

@@ -1,2 +0,39 @@

/** @format */
export * from './stringify-object';
interface StringifyObjectOptions {
/**
* Preferred indentation.
*
* @default '\t'
*/
indent?: string;
/**
* Set to false to get double-quoted strings.
*
* @default true
*/
singleQuotes?: boolean;
/**
* Whether to include the property prop of the object obj in the output.
*
* @param obj
* @param prop
*/
filter?: (obj: any, prop: string | symbol | number) => boolean;
/**
* Expected to return a string that transforms the string that resulted from stringifying obj[prop].
* This can be used to detect special types of objects that need to be stringified in a particular way.
* The transform function might return an alternate string in this case, otherwise returning the originalResult.
*
* @param obj
* @param prop
* @param originalResult
*/
transform?: (obj: any, prop: string | symbol | number, originalResult: string) => string;
/**
* When set, will inline values up to inlineCharacterLimit length for the sake of more terse output.
*/
inlineCharacterLimit?: number;
}
export declare function stringifyObject(input: any): string;
export declare function stringifyObject(input: any, options: StringifyObjectOptions): string;
export declare function stringifyObject(input: any, options: StringifyObjectOptions, pad: string): string;
export {};
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __spreadArrays = (this && this.__spreadArrays) || function () {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
Object.defineProperty(exports, "__esModule", { value: true });
var seen = [];
/**
* Check if a value is an object or a function. Keep in mind that array, function, regexp, etc, are objects in JavaScript.
*
* @param value the value to check
* @return true if the value is an object or a function
*/
function isObj(value) {
var type = typeof value;
return value !== null && (type === 'object' || type === 'function');
}
Object.defineProperty(exports, "__esModule", { value: true });
/** @format */
__export(require("./stringify-object"));
/**
* Check if a value is a regular expression.
*
* @param value the value to check
* @return true if the value is a regular expression
*/
function isRegexp(value) {
return Object.prototype.toString.call(value) === '[object RegExp]';
}
/**
* Get an array of all of the enumerable symbols for an object.
*
* @param object the object to get the enumerable symbols for
*/
function getOwnEnumPropSymbols(object) {
return Object.getOwnPropertySymbols(object).filter(function (keySymbol) { return Object.prototype.propertyIsEnumerable.call(object, keySymbol); });
}
/**
* Stringify an object
*
* @param input the object to stringify
* @param options
* @param pad the padding string
*/
function stringifyObject(input, options, pad) {
if (pad === void 0) { pad = ''; }
// sensible option defaults
var defaultOptions = {
indent: '\t',
singleQuotes: true
};
var combinedOptions = __assign(__assign({}, defaultOptions), options);
var tokens;
if (combinedOptions.inlineCharacterLimit === undefined) {
tokens = {
newLine: '\n',
newLineOrSpace: '\n',
pad: pad,
indent: pad + combinedOptions.indent
};
}
else {
tokens = {
newLine: '@@__STRINGIFY_OBJECT_NEW_LINE__@@',
newLineOrSpace: '@@__STRINGIFY_OBJECT_NEW_LINE_OR_SPACE__@@',
pad: '@@__STRINGIFY_OBJECT_PAD__@@',
indent: '@@__STRINGIFY_OBJECT_INDENT__@@'
};
}
var expandWhiteSpace = function (string) {
if (combinedOptions.inlineCharacterLimit === undefined) {
return string;
}
var oneLined = string
.replace(new RegExp(tokens.newLine, 'g'), '')
.replace(new RegExp(tokens.newLineOrSpace, 'g'), ' ')
.replace(new RegExp(tokens.pad + '|' + tokens.indent, 'g'), '');
if (oneLined.length <= combinedOptions.inlineCharacterLimit) {
return oneLined;
}
return string
.replace(new RegExp(tokens.newLine + '|' + tokens.newLineOrSpace, 'g'), '\n')
.replace(new RegExp(tokens.pad, 'g'), pad)
.replace(new RegExp(tokens.indent, 'g'), pad + combinedOptions.indent);
};
if (seen.indexOf(input) !== -1) {
return '"[Circular]"';
}
if (input === null ||
input === undefined ||
typeof input === 'number' ||
typeof input === 'boolean' ||
typeof input === 'function' ||
typeof input === 'symbol' ||
isRegexp(input)) {
return String(input);
}
if (input instanceof Date) {
return "new Date('" + input.toISOString() + "')";
}
if (Array.isArray(input)) {
if (input.length === 0) {
return '[]';
}
seen.push(input);
var ret = '[' + tokens.newLine + input.map(function (el, i) {
var eol = input.length - 1 === i ? tokens.newLine : ',' + tokens.newLineOrSpace;
var value = stringifyObject(el, combinedOptions, pad + combinedOptions.indent);
if (combinedOptions.transform) {
value = combinedOptions.transform(input, i, value);
}
return tokens.indent + value + eol;
}).join('') + tokens.pad + ']';
seen.pop();
return expandWhiteSpace(ret);
}
if (isObj(input)) {
var objKeys_1 = __spreadArrays(Object.keys(input), (getOwnEnumPropSymbols(input)));
if (combinedOptions.filter) {
objKeys_1 = objKeys_1.filter(function (el) { return combinedOptions.filter && combinedOptions.filter(input, el); });
}
if (objKeys_1.length === 0) {
return '{}';
}
seen.push(input);
var ret = '{' + tokens.newLine + objKeys_1.map(function (el, i) {
var eol = objKeys_1.length - 1 === i ? tokens.newLine : ',' + tokens.newLineOrSpace;
var isSymbol = typeof el === 'symbol';
var isClassic = !isSymbol && /^[a-z$_][a-z$_0-9]*$/i.test(el.toString());
var key = isSymbol || isClassic ? el : stringifyObject(el, combinedOptions);
var value = stringifyObject(input[el], combinedOptions, pad + combinedOptions.indent);
if (combinedOptions.transform) {
value = combinedOptions.transform(input, el, value);
}
return tokens.indent + String(key) + ': ' + value + eol;
}).join('') + tokens.pad + '}';
seen.pop();
return expandWhiteSpace(ret);
}
input = String(input).replace(/[\r\n]/g, function (x) { return x === '\n' ? '\\n' : '\\r'; });
if (!combinedOptions.singleQuotes) {
input = input.replace(/"/g, '\\"');
return "\"" + input + "\"";
}
input = input.replace(/\\?'/g, '\\\'');
return "'" + input + "'";
}
exports.stringifyObject = stringifyObject;
//# sourceMappingURL=index.js.map

2

package.json
{
"name": "@base2/pretty-print-object",
"version": "0.0.3",
"version": "0.0.4",
"description": "Convert an object or array into a formatted string",

@@ -5,0 +5,0 @@ "repository": {

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc