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

@odg/config

v1.1.2

Published

Config interface abstraction

Downloads

266

Readme

codecov Stargazers Made by ODGodinho Forks Repository size GitHub last commit License StyleCI

Table of Contents


🎇 Benefits

  • 🚀 Speed start new project or package using typescript
  • 🚨 Over 800 rules for pattern, possible errors and errors in Linter
  • 🎇 Code quality guaranteed
  • 📢 AutoReview when opening a pull-request/merge AutoReview Comment example
  • 🧪 Automatic Test when opening pull-request/merge
  • 📈 Automatic Code Coverage when opening pull-request/merge Code Coverage example
  • 📦 Automatic Package and release generate on merge
  • 🪝 Run Lint/Test command pre-commit execute
  • ⚙️ IOT/IOC (Inversion of Control) for easy use of libraries

📁 Dependencies

⏩ Get Started


🔘 Example Usage

Create new instance config class

// Example transform config with zod
const zBoolean = zod.union([
    zod.string().transform((value): boolean => value === "true" || value === "1"),
    zod.boolean(),
]);

const myValidator = zod.object({
    USE_HTTPS: zBoolean,
    OPTIONAL: zod.string().optional(),
});

// Container Instance Configuration

const config = new JsonConfig<zod.infer<typeof myValidator>>({ ...process.env }, validator);
await config.init();

🧲 Get Configs

const config: ConfigInterface;

// Get Configs
const useHttps = await config.get("USE_HTTPS");
const optional = await config.get("OPTIONAL", () => "default value");

// Has Config
if (await config.has("OPTIONAL")) {
    // Config key exists
}

// set Config
await config
    .set("OPTIONAL", "filled")
    .set("USE_HTTPS", false);

// All Configs
const all = config.all(); // Return Json with configs

// Prepare class to use
const all = config.init();

💌 Send Configs to class

For packages and SDK, always prefer to send an object instead of the entire config class

new PackageClass({
    timeout: await config.get("DEFAULT_TIMEOUT", () => 1000),
    attempt: await config.get("ATTEMPT"),
})

💻 Prepare To Develop

Copy .env.example to .env and add the values according to your needs.

📍 Start Project

First install dependencies with the following command

yarn install
# or
npm install

📨 Build and Run

To build the project, you can use the following command

if you change files, you need to run yarn build and yarn start again

yarn build && yarn test

🧪 Test Code

To Test execute this command

yarn test
# or
yarn test:watch