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

@ty-ras-extras/config-io-ts

v2.0.0

Published

Utility methods to acquire application configurations from strings which are serialized JSON, with runtime validation of `io-ts` library.

Downloads

56

Readme

Typesafe REST API Specification Extras - Configuration Utilities with FP-TS

Coverage

This folder contains library which exposes few utility functions which can be used by both backend and frontend applications to read configurations from strings (e.g. environment variables). The strings are parsed as necessary and then validated at runtime using io-ts library.

Using in Frontend

import { function as F } from "fp-ts";
import * as t from "io-ts";
import { configuration } from "@ty-ras-extras/frontend-io-ts";
// Or, if not using bundled libraries: import * as configuration from "@ty-ras-extras/config-io-ts/string";

// Define runtime validation of configuration
const validation = t.type({
  someStringProperty: t.string,
});
// Acquire configuration
export const config = F.pipe(
  import.meta.env["MY_FE_CONFIG"], // Or, if webpack: process.env["MY_FE_CONFIG"],
  configuration.validateFromStringifiedJSONOrThrow(validation),
);
// The compile-time type of 'config' is now:
// {
//   someStringProperty: string
// }

Using in Backend

For situations where environment variable is always serialized JSON:

import { function as F } from "fp-ts";
import * as t from "io-ts";
import { configuration } from "@ty-ras-extras/backend-io-ts";
// Or, if not using bundled libraries: import * as configuration from "@ty-ras-extras/config-io-ts/string";

// Define runtime validation of configuration
const validation = t.type({
  someStringProperty: t.string,
});
// Acquire configuration
export const config = F.pipe(
  process.env["MY_BE_CONFIG"],
  configuration.validateFromStringifiedJSONOrThrow(validation),
);
// The compile-time type of 'config' is now:
// {
//   someStringProperty: string
// }

For situations where environment variable is either serialized JSON or a path to file containing serialized JSON:

import { function as F } from "fp-ts";
import * as t from "io-ts";
import { configuration } from "@ty-ras-extras/backend-io-ts";
// Or, if not using bundled libraries: import * as configuration from "@ty-ras-extras/config-io-ts/maybe-file";

// Define runtime validation of configuration
const validation = t.type({
  someStringProperty: t.string,
});
// Acquire configuration
export const acquireConfiguration = async () => await F.pipe(
  process.env["MY_BE_CONFIG"],
  configuration.getJSONStringValueFromStringWhichIsJSONOrFilename(validation),
  configuration.validateFromStringifiedJSONOrThrow(validation)
);
// The compile-time type of 'acquireConfiguration' is now:
// () => Promise<{
//   someStringProperty: string
// }>