npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@loxjs/utils

v1.0.0

Published

A collection of utility functions

Downloads

3

Readme

@loxjs/utils

The @loxjs/utils module is a collection of utility functions designed to assist with common tasks such as obfuscating sensitive information and integrating Google OAuth2 authentication in your Node.js applications.

Features

  • Obfuscate email addresses to protect them from being used for spam or other malicious activities.
  • Obfuscate hashes to maintain privacy while still allowing identification.
  • Obfuscate wallet addresses to enhance security and privacy in transactions.
  • Integrate Google OAuth2 authentication easily with the bundled GoogleAuth class.

Installation

To install the @loxjs/utils module, run the following command in your project directory:

npm install @loxjs/utils

Usage

After installation, you can import and use the various utility functions and the GoogleAuth class in your application.

Obfuscating Email Addresses

obfuscateEmail(email)

  • email (Required): The email address to obfuscate.

Example

const { obfuscateEmail } = require('@loxjs/utils');

const email = '[email protected]';
const obfuscatedEmail = obfuscateEmail(email);
console.log(obfuscatedEmail); // Output: e***[email protected]

Obfuscating Hashes

obfuscateHash(hash)

  • hash (Required): The hash string to obfuscate.

Example

const { obfuscateHash } = require('@loxjs/utils');

const hash = '123456abcdef1234567890abcdef1234567890';
const obfuscatedHash = obfuscateHash(hash);
console.log(obfuscatedHash); // Output: 123456...7890

Obfuscating Wallet Addresses

obfuscateWallet(wallet)

  • wallet (Required): The wallet address to obfuscate.

Example

const { obfuscateWallet } = require('@loxjs/utils');

const wallet = '0x123456abcdef1234567890abcdef1234567890';
const obfuscatedWallet = obfuscateWallet(wallet);
console.log(obfuscatedWallet); // Output: 0x1234...7890

Google OAuth2 Authentication

The GoogleAuth class from the @loxjs/google-auth module is also re-exported in this utility package for convenience.

To learn more about the GoogleAuth class and its usage, please refer to the documentation for @loxjs/google-auth on npmjs.

Example

const { GoogleAuth } = require('@loxjs/utils');

const googleAuth = new GoogleAuth({
    secret: {
        client_id: 'YOUR_CLIENT_ID',
        client_secret: 'YOUR_CLIENT_SECRET',
        grant_type: 'authorization_code'
    }
    // Additional configurations such as timeout and proxy can be added here
});

// Use the googleAuth instance to authenticate and obtain user information

Replace 'YOUR_CLIENT_ID' and 'YOUR_CLIENT_SECRET' with your actual Google client ID and client secret.

Error Handling

The obfuscateEmail function will return the original input if it is not a valid email address. The obfuscateHash and obfuscateWallet functions will return an empty string if the input is falsy. Make sure to handle these cases as needed in your application.


This README provides a basic overview of the @loxjs/utils module. For further details and advanced usage, please refer to the source code and the official documentation for the @loxjs/google-auth module.

Contributing

Contributions to @loxjs/utils are welcome! Please ensure that your contributions adhere to the following guidelines:

  • Write clear, readable, and maintainable code.
  • Follow existing coding styles and practices.
  • Write meaningful commit messages.
  • Update the documentation accordingly.

For more detailed information, please read the contributing guide.

Enjoy using @loxjs/utils!