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

@meersagor/js-composable

Package Overview
Dependencies
Maintainers
0
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@meersagor/js-composable

JS-Composable is a lightweight utility library designed to provide practical helper methods that simplify real-world use cases.

  • 0.0.1
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
4
increased by33.33%
Maintainers
0
Weekly downloads
 
Created
Source

js-composable

JS-Composable is a lightweight utility library designed to provide practical helper methods that simplify real-world use cases. Tailored for Node.js projects, it includes a versatile set of functions to streamline repetitive tasks and support common development needs.

Key Features

  • Utility-Focused: A collection of helper methods built to tackle everyday coding challenges.
  • Modular and Flexible: Use only what you need without bloating your project.
  • Node.js Ready: Compatible with any Node.js environment, enhancing productivity and efficiency in server-side applications.
  • Real-World Applications: Inspired by actual project needs, providing practical solutions for real scenarios.

With JS-Composable, your Node.js projects get a boost in maintainability and clarity, allowing you to focus on core functionality while the library handles common yet essential utility tasks.

Installation

To install the package, run the following command:

npm i @meersagor/js-composable

Usage

To use the package, import the required methods:
import {generateFormData, logGenerateFormData} from '@meersagor/js-composable';

Example 1: Simple Object

import {generateFormData} from '@meersagor/js-composable';
const obj = {
    name: 'Meer Sagor',
    age: 24,
    skills: ['javaScript', 'typeScript', 'vuejs', 'nuxtjs', 'reactjs', 'nextjs']
};
const result = generateFormData({objectData: obj});
//  If  you  want  to  log  the  generated  FormData,  use  the  logGenerateFormData  method
logGenerateFormData(result);

Example 2: Object with File and Custom File Key

Here is an example of how to use the package with an object that includes a file and a custom file key:

import {logGenerateFormData} from '@meersagor/js-composable';
const obj2 = {
    name: 'Meer Sagor',
    age: 24,
    skills: ['javaScript', 'typeScript', 'vuejs', 'nuxtjs', 'reactjs', 'nextjs'],
    file: new File(["content"], "filename.txt") //  Example  file  object
};
const result = generateFormData({objectData: obj2, fileKey: 'attachment'});
//  Log  the  generated  FormData
logGenerateFormData(result);

A TypeScript utility for dynamically adding, updating, and ensuring the loading of custom fonts in a web application. This utility helps you define font-face rules for custom fonts, allowing you to update their sources and ensure the fonts are fully loaded in the browser.

Example: To use this loadCustomFontFace utility

import {loadCustomFontFace} from '@meersagor/js-composable';

await loadCustomFontFace({
    fontFamily: 'CustomFont',
    srcUrl: 'https://example.com/fonts/CustomFont.woff',
    fontStyle: 'normal',
    fontWeight: '400',
    format: 'woff2',
    fontDisplay: 'swap',
});
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>

    <style>
        .custom-font{
            font-family: 'CustomFont',sans-serif;
        }
    </style>
</head>
<body>
    <h1 class="custom-font">Hello world</h1>
</body>
</html>

Example: To use this generateImageUrlToBase64 utility

To use the generateImageUrlToBase64 function, pass it an object containing the url of the image to convert and an optional parseType to specify the desired output format.

import {generateImageUrlToBase64} from '@meersagor/js-composable';

generateImageUrlToBase64({url: 'https://example.com/image.png'})
    .then((base64) => console.log('Base64:', base64))
    .catch((error) => console.error('Error:', error));

Methods

generateFormData This method generates FormData from the provided object.

ParametersTypeDescriptionDefault
objectDataobjectThe object to be converted into FormData
fileKeystring (optional)The key to use for the file if the object contains a file and want to set custom key.
Returns
  • FormData: The generated FormData object.
  • logGenerateFormData This method logs the generated FormData to the console.

loadCustomFontFace

ParametersTypeDescriptionDefault
fontFamilystringThe name of the font family.
srcUrlstringThe URL of the font file.
formatstringThe format of the font (e.g., 'woff', 'woff2').'woff'
fontWeightstringThe weight of the font (e.g., 'normal', 'bold').'normal'
fontStylestringThe style of the font (e.g., 'normal', 'italic').'normal'
fontDisplaystringDefines how a font face is displayed.'swap'

generateImageUrlToBase64

ParametersTypeDescriptionDefault
urlstringThe URL of the image to convert.
parseTypestringOutput format: 'base64' or 'svg'.'base64'

License

This package is open-source and available under the MIT License.

Contributing

Contributions are welcome! Please feel free to submit a pull request.

Issues

If you encounter any issues, please create a new issue.

Keywords

FAQs

Package last updated on 09 Nov 2024

Did you know?

Socket

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.

Install

Related posts

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