Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Utility package to convert json objects to excel sheets easily (based on exceljs)
json2sheet is a utility package to convert json objects to simple excel sheets in an easier and faster way. And, it is built on top of exceljs and you can check it if you want to create more complex excel sheets.
You can install the package via npm or yarn.
npm install json2sheet
or
yarn add json2sheet
There are two main functions you can use:
Create Excel file buffer
from json object:
import { jsonToBuffer, Column } from "json2sheet";
async function createExcelBuffer() {
const data: any[] = [
{
name: "John Doe",
age: 24,
user: {
name: "johndoe",
},
},
{
name: "Doe John",
age: 42,
user: {
name: "doejohn",
},
},
];
const columns: Column[] = [
{
label: "User's name", // column name
/*
* value is a property name or a function which takes single object as parameter and returns desired value
*/
value: "name",
width: 40, // column width
style: {
// column style
font: {
italic: true,
},
alignment: {
vertical: "middle",
horizontal: "center",
},
},
},
{
label: "User's age",
value: "age",
width: 10,
},
{
label: "Username",
value: "user.name", // supports inner objects
width: 20,
},
{
label: "Profile link",
value: (person) => `https://example.com/${person.user.name}`,
width: 20,
},
];
// jsonToBuffer is an async function and returns Promise<Buffer>
return await jsonToBuffer("sheetname", columns, data);
}
jsonToBuffer
is useful when you need to send Excel file to the user via API endpoint in Express or NestJS.
You can do so like this:
const buffer = await createExcelBuffer();
const filename = "cool-file";
res.set({
"Content-Type":
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"Content-Disposition": `attachment; filename=${filename}.xlsx`,
});
res.send(buffer);
Create Excel file
itself:
import { jsonToFile, Column } from "json2sheet";
async function createExcelBuffer() {
const columns: Column[] = [
{
label: "User's name", // column name
value: "name", // property name
width: 40, // column width
style: {
// creates italic text
font: {
italic: true,
},
// positions text in the middle of the cell
alignment: {
vertical: "middle",
horizontal: "center",
},
},
},
{
label: "User's age",
value: "age",
width: 10,
},
{
label: "Username",
value: "user.name", // supports inner objects
width: 20,
},
];
const data: any[] = [
{
name: "John Doe",
age: 24,
user: {
name: "johndoe",
},
},
{
name: "Doe John",
age: 42,
user: {
name: "doejohn",
},
},
];
// jsonToFile is an async void function and it creates xlsx file.
return await jsonToFile("filename.xlsx", "sheetname", columns, data);
}
jsonToFile
is useful when you want to create Excel files in your local disk or on your your server.
Sometimes we need to modify the value from JSON a little bit as in the above example:
{
label: "Profile link",
value: (person) => `https://example.com/${person.user.name}`,
width: 20,
}
Most of the time, it is a common need so package supports function values. With functions you can transform value according to your need without modifying JSON file or object.
However, function must take only one parameter which represents single object from your data array. If you have existing function you can also use that:
function generateLink(person) {
return `https://example.com/${person.user.name}`
}
...
{
label: "Profile link",
value: generateLink,
width: 20,
}
If you want to give more style to your columns check these files!
Currently package only supports font
and alignment
in column style!
Contributions are welcome! Please create your PRs and send them for review!
FAQs
Utility package to convert json objects to excel sheets easily (based on exceljs)
The npm package json2sheet receives a total of 12 weekly downloads. As such, json2sheet popularity was classified as not popular.
We found that json2sheet demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.