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

i4n

v0.5.1

Published

Lightweight, Zero dependencies, Typesafe and Simple to use translations for TypeScript.

Downloads

22

Readme

NPM Version NPM Downloads NPM License npm bundle size NPM Type Definitions

i4n

🌐🪶 Lightweight, Zero dependencies, Typesafe and Simple to use translations for TypeScript.

Installation

To use this package, install with npm:

npm install i4n

Usage

To get started with translating, import the I4n class:

import { I4n } from "i4n";

Then create a set of translations:

const translations = {
  en: {
    hi: "Hello",
  },
  es: {
    hi: "Ola",
  },
} as const;

To improve this, implement your own types:

type TranslationData = {
  earth: string;
};
type Language = "en" | "es" | "fr";
type TranslationSet = Record<Language, TranslationData>;

const translations: TranslationSet = {
  en: {
    earth: "world",
  },
  es: {
    aerth: "Mundo",
    // ^ Typescript error
  },
};

Init

Then initialize the class with your translations and default language:

const i4n = new I4n({ translations, language: "en", fallbackLanguage: "fr" });

You will then have access to the methods, can detach the functions and start translating.

API

I4n Constructor

new I4n(config: {
  translations?: Record<string, any>;
  loader?: () => Promise<Record<string, any>> | Record<string, any>;
  language: string;
  fallbackLanguage?: string;
});
  • translations: An object containing the translation data, organized by language codes.
  • language: The default language to use.
  • fallbackLanguage: (Optional) The language to fall back to if a translation is missing.
  • loader: A loader to, for example, load json data from a .json file.

The types are configured to have the translations or loader present in the arguments, leaving both out or putting both in will result in an I4nException.

Methods

t(key: string | string[], ...args: any[])

Retrieves a translation value based on the provided key. Supports dot.notation for nested keys and fallback keys.

  • key: The translation key or array of keys for fallback.
  • args: Additional arguments for template functions.

This method will use the fallbackLanguage, if present, when the keys cannot be found in the current language.

Usage Example:

i4n.t("hi"); // Returns "Hello"
i4n.t([`errors.${code}`, "errors.unspecified"]); // Fallback example

switch(language: string)

Switches the current language at runtime.

  • language: The language code to switch to.

Usage Example:

i4n.switch("es");
i4n.t("hi"); // Returns "Ola"

lazy({data?: Record<string, any>, loader?: () => Promise<Record<string, any>> | Record<string, any>})

Enables the user to load in translations after initialization of the I4n class.

const i4n = new I4n({...}); // {en, es}
i4n.ready; // true

i4n.t("french-key"); // undefined

i4n.lazy({ loader: myCustomLoader }); // {fr}
i4n.ready; // false

await i4n.loaded({lang: "fr"})
i4n.ready; //true

i4n.t("french-key"); // "mon-key".

Error Handling

  • I4nException: Thrown if invalid types are used or if a language not present in the translations is selected.

Docs

For more and more in depth documentation, go to: github.com/m10rten/i4n.